@unipile/sdk 2.0.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.
- package/README.md +36 -0
- package/package.json +27 -0
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Unipile Node SDK
|
|
2
|
+
|
|
3
|
+
TypeScript SDK for the Unipile API.
|
|
4
|
+
|
|
5
|
+
This SDK is only for **Unipile API v2 (BETA)**. Use https://github.com/unipile/unipile-node-sdk for Unipile API v1.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
The package is not published on npm yet. Install it directly from GitHub:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install git+https://github.com/unipile/unipile-node.git
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You can also pin a branch, tag, or commit:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install git+https://github.com/unipile/unipile-node.git#main
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import { UnipileMessaging } from "unipile";
|
|
25
|
+
|
|
26
|
+
const key = "apikey";
|
|
27
|
+
const messagingApi = new UnipileMessaging({ key });
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
For endpoint details, see the Unipile v2 API documentation.
|
|
31
|
+
|
|
32
|
+
## Links
|
|
33
|
+
|
|
34
|
+
- [Documentation](https://developer.unipile.com/v2.0/docs/welcome)
|
|
35
|
+
- [API Reference](https://developer.unipile.com/v2.0/reference/api-usage)
|
|
36
|
+
- [Dashboard](https://dashboardv2.unipile.com)
|
package/package.json
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@unipile/sdk",
|
|
3
|
+
"version": "2.0.0",
|
|
4
|
+
"description": "TypeScript SDK for Unipile API",
|
|
5
|
+
"homepage": "https://github.com/unipile/unipile-node#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/unipile/unipile-node/issues"
|
|
8
|
+
},
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/unipile/unipile-node.git"
|
|
12
|
+
},
|
|
13
|
+
"license": "Unlicense",
|
|
14
|
+
"author": "Unipile API",
|
|
15
|
+
"main": "dist/index.js",
|
|
16
|
+
"types": "dist/index.d.ts",
|
|
17
|
+
"files": [
|
|
18
|
+
"dist"
|
|
19
|
+
],
|
|
20
|
+
"scripts": {
|
|
21
|
+
"build": "tsc -p tsconfig.json",
|
|
22
|
+
"clean": "rm -rf dist"
|
|
23
|
+
},
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"typescript": "^5.8.2"
|
|
26
|
+
}
|
|
27
|
+
}
|