postboost 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -0
  2. package/package.json +27 -26
package/README.md CHANGED
@@ -0,0 +1,31 @@
1
+ # PostBoost TypeScript / Node.js SDK
2
+
3
+ Official TypeScript/Node.js client for the [PostBoost API](https://postboost.co/docs/api).
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install postboost
9
+ ```
10
+
11
+ | | |
12
+ |---|---|
13
+ | **npm** | [npmjs.com/package/postboost](https://www.npmjs.com/package/postboost) |
14
+ | **GitHub** | [postboost-co/postboost-node](https://github.com/postboost-co/postboost-node) |
15
+ | **Docs** | [postboost.co/docs/api](https://postboost.co/docs/api) |
16
+ | **Version** | v1.2.0 |
17
+
18
+ ## Quick start
19
+
20
+ ```typescript
21
+ import { PostsApi, Configuration } from 'postboost';
22
+
23
+ const api = new PostsApi(new Configuration({ accessToken: process.env.POSTBOOST_API_TOKEN }));
24
+
25
+ const posts = await api.listPosts('YOUR_WORKSPACE_UUID');
26
+ posts.forEach(post => console.log(post.uuid));
27
+ ```
28
+
29
+ ## License
30
+
31
+ MIT
package/package.json CHANGED
@@ -1,28 +1,29 @@
1
1
  {
2
- "name": "postboost",
3
- "version": "1.0.0",
4
- "description": "NodeJS client for postboost",
5
- "repository": {
6
- "type": "git",
7
- "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
8
- },
9
- "main": "dist/api.js",
10
- "types": "dist/api.d.ts",
11
- "scripts": {
12
- "clean": "rm -Rf node_modules/ *.js",
13
- "build": "tsc",
14
- "test": "npm run build && node dist/client.js"
15
- },
16
- "author": "OpenAPI-Generator Contributors",
17
- "license": "Unlicense",
18
- "dependencies": {
19
- "bluebird": "^3.7.2",
20
- "request": "^2.88.2"
21
- },
22
- "devDependencies": {
23
- "@types/bluebird": "^3.5.33",
24
- "@types/node": "^12",
25
- "@types/request": "^2.48.8",
26
- "typescript": "^4.0 || ^5.0"
27
- }
2
+ "name": "postboost",
3
+ "version": "1.2.0",
4
+ "description": "NodeJS client for postboost",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/postboost-co/postboost-node.git"
8
+ },
9
+ "main": "dist/api.js",
10
+ "types": "dist/api.d.ts",
11
+ "scripts": {
12
+ "clean": "rm -Rf node_modules/ *.js",
13
+ "build": "tsc",
14
+ "test": "npm run build && node dist/client.js"
15
+ },
16
+ "author": "PostBoost",
17
+ "license": "MIT",
18
+ "dependencies": {
19
+ "bluebird": "^3.7.2",
20
+ "request": "^2.88.2"
21
+ },
22
+ "devDependencies": {
23
+ "@types/bluebird": "^3.5.33",
24
+ "@types/node": "^12",
25
+ "@types/request": "^2.48.8",
26
+ "typescript": "^4.0 || ^5.0"
27
+ },
28
+ "homepage": "https://github.com/postboost-co/postboost-node#readme"
28
29
  }