lassejlv / projectplannerai.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

projectplannerai.js

An API for interacting with the Project Planner AI API.

Installation

npm install projectplannerai # or bun, pnpm, yarn etc.

Usage

import { ProjectPlannerAI } from "projectplannerai";

const projectAIClient = ProjectPlannerAI({
  projectId: "<replace-with-your-project-id>",
});

Typings

projectId: string;

Create new feedback

const newFeedback = await projectAIClient.createFeedback({
  feedback: "Need more features", // required
  name: "John Doe", // optional
  email: "john@example.com", // optional
  label: "complaint", // optional
});

Typings

feedback: string;
name?: string;
email?: string;
label?: "idea" | "issue" | "question" | "complaint" | "featureRequest" | "other";

Create new event

const event = await projectAIClient.createEvent({
  key: "User Created",
});

Typings

key: string;

Get changelog

const changelog = await projectAIClient.getChangeLog();

Typings

// Returns an array of changelog items
id: string;
date: string;
title: string;
post: string;

The end

This project is not affiliated with Project Planner AI. It is just to make it easier to interact with the API.

MIT License

About

License:MIT License


Languages

Language:TypeScript 100.0%