@fbrc/sdk 0.0.1 → 0.0.3
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 +9 -10
- package/package.json +1 -5
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @fbrc/sdk@0.0.3
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the api.fabric.so API.
|
|
4
4
|
|
|
@@ -7,7 +7,7 @@ A TypeScript SDK client for the api.fabric.so API.
|
|
|
7
7
|
First, install the SDK from npm.
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npm install @
|
|
10
|
+
npm install @fbrc/sdk --save
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
Next, try it out.
|
|
@@ -15,19 +15,18 @@ Next, try it out.
|
|
|
15
15
|
```ts
|
|
16
16
|
import {
|
|
17
17
|
FabricApi,
|
|
18
|
-
} from '@
|
|
18
|
+
} from '@fbrc/sdk';
|
|
19
19
|
|
|
20
20
|
async function example() {
|
|
21
|
-
console.log(
|
|
22
|
-
const api = new FabricApi({apiKey: 'YOUR_API_KEY'});
|
|
21
|
+
console.log('🚀 Testing @fbrc/sdk SDK...');
|
|
22
|
+
const api = new FabricApi({ apiKey: 'YOUR_API_KEY' });
|
|
23
23
|
|
|
24
24
|
const body = {
|
|
25
|
-
|
|
26
|
-
createBookmarkRequest: ...,
|
|
25
|
+
...
|
|
27
26
|
} satisfies CreateBookmarkOperationRequest;
|
|
28
27
|
|
|
29
28
|
try {
|
|
30
|
-
const data = await api.
|
|
29
|
+
const data = await api.bookmarks.create(body);
|
|
31
30
|
console.log(data);
|
|
32
31
|
} catch (error) {
|
|
33
32
|
console.error(error);
|
|
@@ -43,7 +42,7 @@ Select a specific delegated workspace
|
|
|
43
42
|
```ts
|
|
44
43
|
import {
|
|
45
44
|
FabricApi,
|
|
46
|
-
} from '@
|
|
45
|
+
} from '@fbrc/sdk';
|
|
47
46
|
|
|
48
47
|
// Provide workspace id in class constructor
|
|
49
48
|
const api = new FabricApi({apiKey: 'YOUR_API_KEY', workspaceId: `xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`});
|
|
@@ -51,7 +50,7 @@ const api = new FabricApi({apiKey: 'YOUR_API_KEY', workspaceId: `xxxxx-xxxx-xxxx
|
|
|
51
50
|
|
|
52
51
|
## Documentation
|
|
53
52
|
|
|
54
|
-
[https://developers.fabric.so/
|
|
53
|
+
[https://developers.fabric.so/fabric-api](https://developers.fabric.so/reference)
|
|
55
54
|
|
|
56
55
|
### Authorization
|
|
57
56
|
|
package/package.json
CHANGED
|
@@ -1,13 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fbrc/sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "Client library for Fabric API",
|
|
5
5
|
"author": "",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
|
-
"repository": {
|
|
8
|
-
"type": "git",
|
|
9
|
-
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
|
|
10
|
-
},
|
|
11
7
|
"main": "./dist/index.js",
|
|
12
8
|
"types": "./dist/index.d.ts",
|
|
13
9
|
"module": "./dist/esm/index.js",
|