Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lassejlv/projectplannerai.js
https://github.com/lassejlv/projectplannerai.js
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lassejlv/projectplannerai.js
- Owner: lassejlv
- License: mit
- Created: 2024-05-08T07:57:16.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-08T08:03:38.000Z (8 months ago)
- Last Synced: 2024-10-31T17:46:38.688Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# projectplannerai.js
An API for interacting with the Project Planner AI API.
# Installation
```bash
npm install projectplannerai # or bun, pnpm, yarn etc.
```
## Usage
```javascript
import { ProjectPlannerAI } from "projectplannerai";
const projectAIClient = ProjectPlannerAI({
projectId: "",
});
```
## Typings
```typescript
projectId: string;
```
## Create new feedback
```javascript
const newFeedback = await projectAIClient.createFeedback({
feedback: "Need more features", // required
name: "John Doe", // optional
email: "[email protected]", // optional
label: "complaint", // optional
});
```
## Typings
```typescript
feedback: string;
name?: string;
email?: string;
label?: "idea" | "issue" | "question" | "complaint" | "featureRequest" | "other";
```
## Create new event
```javascript
const event = await projectAIClient.createEvent({
key: "User Created",
});
```
## Typings
```typescript
key: string;
```
## Get changelog
```javascript
const changelog = await projectAIClient.getChangeLog();
```
## Typings
```typescript
// 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
```