syllable-sdk 0.1.0-alpha.39 → 0.1.0-alpha.40
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 +24 -16
- package/docs/sdks/dashboards/README.md +178 -8
- package/docs/sdks/tools/README.md +12 -4
- package/docs/sdks/v1/README.md +178 -8
- package/funcs/dashboardsPostGetDashboard.d.ts +20 -0
- package/funcs/dashboardsPostGetDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostGetDashboard.js +108 -0
- package/funcs/dashboardsPostGetDashboard.js.map +1 -0
- package/funcs/dashboardsPostListDashboard.d.ts +20 -0
- package/funcs/dashboardsPostListDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostListDashboard.js +116 -0
- package/funcs/dashboardsPostListDashboard.js.map +1 -0
- package/funcs/dashboardsPostSessionEventsDashboard.d.ts +3 -0
- package/funcs/dashboardsPostSessionEventsDashboard.d.ts.map +1 -1
- package/funcs/dashboardsPostSessionEventsDashboard.js +3 -0
- package/funcs/dashboardsPostSessionEventsDashboard.js.map +1 -1
- package/funcs/dashboardsPostSessionSummaryDashboard.d.ts +3 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.d.ts.map +1 -1
- package/funcs/dashboardsPostSessionSummaryDashboard.js +3 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.js.map +1 -1
- package/funcs/dashboardsPostSessionTransfersDashboard.d.ts +3 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.d.ts.map +1 -1
- package/funcs/dashboardsPostSessionTransfersDashboard.js +3 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.js.map +1 -1
- package/funcs/dashboardsPostSessionsDashboard.d.ts +3 -0
- package/funcs/dashboardsPostSessionsDashboard.d.ts.map +1 -1
- package/funcs/dashboardsPostSessionsDashboard.js +3 -0
- package/funcs/dashboardsPostSessionsDashboard.js.map +1 -1
- package/funcs/v1PostGetDashboard.d.ts +20 -0
- package/funcs/v1PostGetDashboard.d.ts.map +1 -0
- package/funcs/v1PostGetDashboard.js +108 -0
- package/funcs/v1PostGetDashboard.js.map +1 -0
- package/funcs/v1PostListDashboard.d.ts +20 -0
- package/funcs/v1PostListDashboard.d.ts.map +1 -0
- package/funcs/v1PostListDashboard.js +116 -0
- package/funcs/v1PostListDashboard.js.map +1 -0
- package/funcs/v1PostSessionEventsDashboard.d.ts +3 -0
- package/funcs/v1PostSessionEventsDashboard.d.ts.map +1 -1
- package/funcs/v1PostSessionEventsDashboard.js +3 -0
- package/funcs/v1PostSessionEventsDashboard.js.map +1 -1
- package/funcs/v1PostSessionSummaryDashboard.d.ts +3 -0
- package/funcs/v1PostSessionSummaryDashboard.d.ts.map +1 -1
- package/funcs/v1PostSessionSummaryDashboard.js +3 -0
- package/funcs/v1PostSessionSummaryDashboard.js.map +1 -1
- package/funcs/v1PostSessionTransfersDashboard.d.ts +3 -0
- package/funcs/v1PostSessionTransfersDashboard.d.ts.map +1 -1
- package/funcs/v1PostSessionTransfersDashboard.js +3 -0
- package/funcs/v1PostSessionTransfersDashboard.js.map +1 -1
- package/funcs/v1PostSessionsDashboard.d.ts +3 -0
- package/funcs/v1PostSessionsDashboard.d.ts.map +1 -1
- package/funcs/v1PostSessionsDashboard.js +3 -0
- package/funcs/v1PostSessionsDashboard.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/dashboard.d.ts +3 -0
- package/models/components/dashboard.d.ts.map +1 -1
- package/models/components/dashboard.js.map +1 -1
- package/models/components/dashboardproperties.d.ts +37 -0
- package/models/components/dashboardproperties.d.ts.map +1 -0
- package/models/components/dashboardproperties.js +53 -0
- package/models/components/dashboardproperties.js.map +1 -0
- package/models/components/dashboardresponse.d.ts +50 -0
- package/models/components/dashboardresponse.d.ts.map +1 -0
- package/models/components/dashboardresponse.js +74 -0
- package/models/components/dashboardresponse.js.map +1 -0
- package/models/components/dashboardtokenresponse.d.ts +65 -0
- package/models/components/dashboardtokenresponse.d.ts.map +1 -0
- package/models/components/dashboardtokenresponse.js +86 -0
- package/models/components/dashboardtokenresponse.js.map +1 -0
- package/models/components/index.d.ts +4 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +4 -0
- package/models/components/index.js.map +1 -1
- package/models/components/listresponsedashboardresponse.d.ts +38 -0
- package/models/components/listresponsedashboardresponse.d.ts.map +1 -0
- package/models/components/listresponsedashboardresponse.js +81 -0
- package/models/components/listresponsedashboardresponse.js.map +1 -0
- package/models/components/tooldefinition.d.ts +8 -50
- package/models/components/tooldefinition.d.ts.map +1 -1
- package/models/components/tooldefinition.js +7 -68
- package/models/components/tooldefinition.js.map +1 -1
- package/models/components/toolfunction.d.ts +2 -26
- package/models/components/toolfunction.d.ts.map +1 -1
- package/models/components/toolfunction.js +3 -26
- package/models/components/toolfunction.js.map +1 -1
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/postgetdashboard.d.ts +29 -0
- package/models/operations/postgetdashboard.d.ts.map +1 -0
- package/models/operations/postgetdashboard.js +68 -0
- package/models/operations/postgetdashboard.js.map +1 -0
- package/models/operations/postlistdashboard.d.ts +46 -0
- package/models/operations/postlistdashboard.d.ts.map +1 -0
- package/models/operations/postlistdashboard.js +101 -0
- package/models/operations/postlistdashboard.js.map +1 -0
- package/openapi.json +381 -11
- package/package.json +1 -1
- package/sdk/dashboards.d.ts +33 -0
- package/sdk/dashboards.d.ts.map +1 -1
- package/sdk/dashboards.js +38 -0
- package/sdk/dashboards.js.map +1 -1
- package/sdk/v1.d.ts +33 -0
- package/sdk/v1.d.ts.map +1 -1
- package/sdk/v1.js +38 -0
- package/sdk/v1.js.map +1 -1
- package/src/funcs/dashboardsPostGetDashboard.ts +142 -0
- package/src/funcs/dashboardsPostListDashboard.ts +150 -0
- package/src/funcs/dashboardsPostSessionEventsDashboard.ts +3 -0
- package/src/funcs/dashboardsPostSessionSummaryDashboard.ts +3 -0
- package/src/funcs/dashboardsPostSessionTransfersDashboard.ts +3 -0
- package/src/funcs/dashboardsPostSessionsDashboard.ts +3 -0
- package/src/funcs/v1PostGetDashboard.ts +142 -0
- package/src/funcs/v1PostListDashboard.ts +150 -0
- package/src/funcs/v1PostSessionEventsDashboard.ts +3 -0
- package/src/funcs/v1PostSessionSummaryDashboard.ts +3 -0
- package/src/funcs/v1PostSessionTransfersDashboard.ts +3 -0
- package/src/funcs/v1PostSessionsDashboard.ts +3 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/dashboard.ts +3 -0
- package/src/models/components/dashboardproperties.ts +36 -0
- package/src/models/components/dashboardresponse.ts +102 -0
- package/src/models/components/dashboardtokenresponse.ts +129 -0
- package/src/models/components/index.ts +4 -0
- package/src/models/components/listresponsedashboardresponse.ts +103 -0
- package/src/models/components/tooldefinition.ts +12 -107
- package/src/models/components/toolfunction.ts +4 -53
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/postgetdashboard.ts +75 -0
- package/src/models/operations/postlistdashboard.ts +124 -0
- package/src/sdk/dashboards.ts +55 -0
- package/src/sdk/v1.ts +55 -0
package/README.md
CHANGED
|
@@ -165,10 +165,12 @@ run();
|
|
|
165
165
|
|
|
166
166
|
### [dashboards](docs/sdks/dashboards/README.md)
|
|
167
167
|
|
|
168
|
-
* [
|
|
169
|
-
* [
|
|
170
|
-
* [
|
|
171
|
-
* [
|
|
168
|
+
* [postListDashboard](docs/sdks/dashboards/README.md#postlistdashboard) - Post List Dashboards
|
|
169
|
+
* [postGetDashboard](docs/sdks/dashboards/README.md#postgetdashboard) - Post Fetch Info
|
|
170
|
+
* [~~postSessionEventsDashboard~~](docs/sdks/dashboards/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
171
|
+
* [~~postSessionSummaryDashboard~~](docs/sdks/dashboards/README.md#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
172
|
+
* [~~postSessionTransfersDashboard~~](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
173
|
+
* [~~postSessionsDashboard~~](docs/sdks/dashboards/README.md#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
172
174
|
|
|
173
175
|
### [dataSources](docs/sdks/datasources/README.md)
|
|
174
176
|
|
|
@@ -227,10 +229,12 @@ run();
|
|
|
227
229
|
|
|
228
230
|
### [v1](docs/sdks/v1/README.md)
|
|
229
231
|
|
|
230
|
-
* [
|
|
231
|
-
* [
|
|
232
|
-
* [
|
|
233
|
-
* [
|
|
232
|
+
* [postListDashboard](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
|
|
233
|
+
* [postGetDashboard](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
|
|
234
|
+
* [~~postSessionEventsDashboard~~](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
235
|
+
* [~~postSessionSummaryDashboard~~](docs/sdks/v1/README.md#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
236
|
+
* [~~postSessionTransfersDashboard~~](docs/sdks/v1/README.md#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
237
|
+
* [~~postSessionsDashboard~~](docs/sdks/v1/README.md#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
234
238
|
|
|
235
239
|
</details>
|
|
236
240
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -270,10 +274,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
270
274
|
- [`customMessagesGetById`](docs/sdks/custommessages/README.md#getbyid) - Get Custom Message By Id
|
|
271
275
|
- [`customMessagesList`](docs/sdks/custommessages/README.md#list) - Custom Messages List
|
|
272
276
|
- [`customMessagesUpdate`](docs/sdks/custommessages/README.md#update) - Update Custom Message
|
|
273
|
-
- [`
|
|
274
|
-
- [`
|
|
275
|
-
- [`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard) - Post Session Summary
|
|
276
|
-
- [`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers
|
|
277
|
+
- [`dashboardsPostGetDashboard`](docs/sdks/dashboards/README.md#postgetdashboard) - Post Fetch Info
|
|
278
|
+
- [`dashboardsPostListDashboard`](docs/sdks/dashboards/README.md#postlistdashboard) - Post List Dashboards
|
|
277
279
|
- [`dataSourcesCreate`](docs/sdks/datasources/README.md#create) - Create Data Source
|
|
278
280
|
- [`dataSourcesDelete`](docs/sdks/datasources/README.md#delete) - Delete Data Source
|
|
279
281
|
- [`dataSourcesGetByName`](docs/sdks/datasources/README.md#getbyname) - Get Data Source
|
|
@@ -304,10 +306,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
304
306
|
- [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
305
307
|
- [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
|
|
306
308
|
- [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
|
|
307
|
-
- [`
|
|
308
|
-
- [`
|
|
309
|
-
- [`
|
|
310
|
-
- [`
|
|
309
|
+
- [`v1PostGetDashboard`](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
|
|
310
|
+
- [`v1PostListDashboard`](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
|
|
311
|
+
- ~~[`dashboardsPostSessionEventsDashboard`](docs/sdks/dashboards/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
|
|
312
|
+
- ~~[`dashboardsPostSessionsDashboard`](docs/sdks/dashboards/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
|
|
313
|
+
- ~~[`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
|
|
314
|
+
- ~~[`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
|
|
315
|
+
- ~~[`v1PostSessionEventsDashboard`](docs/sdks/v1/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
|
|
316
|
+
- ~~[`v1PostSessionsDashboard`](docs/sdks/v1/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
|
|
317
|
+
- ~~[`v1PostSessionSummaryDashboard`](docs/sdks/v1/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
|
|
318
|
+
- ~~[`v1PostSessionTransfersDashboard`](docs/sdks/v1/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
|
|
311
319
|
|
|
312
320
|
</details>
|
|
313
321
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
@@ -7,17 +7,178 @@ Operations related to dashboards. Currently the API/SDK only supports
|
|
|
7
7
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [
|
|
10
|
+
* [postListDashboard](#postlistdashboard) - Post List Dashboards
|
|
11
|
+
* [postGetDashboard](#postgetdashboard) - Post Fetch Info
|
|
12
|
+
* [~~postSessionEventsDashboard~~](#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
13
|
+
* [~~postSessionSummaryDashboard~~](#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
14
|
+
* [~~postSessionTransfersDashboard~~](#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
15
|
+
* [~~postSessionsDashboard~~](#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
14
16
|
|
|
15
|
-
##
|
|
17
|
+
## postListDashboard
|
|
18
|
+
|
|
19
|
+
METHOD: POST
|
|
20
|
+
URL: /dashboard/list
|
|
21
|
+
ARGUMENTS: None
|
|
22
|
+
RETURNS: List of dashboards
|
|
23
|
+
|
|
24
|
+
### Example Usage
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
28
|
+
|
|
29
|
+
const syllableSDK = new SyllableSDK({
|
|
30
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
async function run() {
|
|
34
|
+
const result = await syllableSDK.dashboards.postListDashboard({});
|
|
35
|
+
|
|
36
|
+
// Handle the result
|
|
37
|
+
console.log(result);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
run();
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Standalone function
|
|
44
|
+
|
|
45
|
+
The standalone function version of this method:
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
49
|
+
import { dashboardsPostListDashboard } from "syllable-sdk/funcs/dashboardsPostListDashboard.js";
|
|
50
|
+
|
|
51
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
52
|
+
// You can create one instance of it to use across an application.
|
|
53
|
+
const syllableSDK = new SyllableSDKCore({
|
|
54
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
async function run() {
|
|
58
|
+
const res = await dashboardsPostListDashboard(syllableSDK, {});
|
|
59
|
+
|
|
60
|
+
if (!res.ok) {
|
|
61
|
+
throw res.error;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const { value: result } = res;
|
|
65
|
+
|
|
66
|
+
// Handle the result
|
|
67
|
+
console.log(result);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
run();
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
| Parameter | Type | Required | Description |
|
|
76
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
77
|
+
| `request` | [operations.PostListDashboardRequest](../../models/operations/postlistdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
78
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
79
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
80
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
81
|
+
|
|
82
|
+
### Response
|
|
83
|
+
|
|
84
|
+
**Promise\<[components.ListResponseDashboardResponse](../../models/components/listresponsedashboardresponse.md)\>**
|
|
85
|
+
|
|
86
|
+
### Errors
|
|
87
|
+
|
|
88
|
+
| Error Type | Status Code | Content Type |
|
|
89
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
90
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
91
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
92
|
+
|
|
93
|
+
## postGetDashboard
|
|
94
|
+
|
|
95
|
+
METHOD: POST
|
|
96
|
+
URL: /dashboard/fetch_info
|
|
97
|
+
ARGUMENTS: None
|
|
98
|
+
RETURNS: Dashboard info for embedding
|
|
99
|
+
|
|
100
|
+
### Example Usage
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
104
|
+
|
|
105
|
+
const syllableSDK = new SyllableSDK({
|
|
106
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
async function run() {
|
|
110
|
+
const result = await syllableSDK.dashboards.postGetDashboard({
|
|
111
|
+
dashboardName: "<value>",
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
// Handle the result
|
|
115
|
+
console.log(result);
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
run();
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Standalone function
|
|
122
|
+
|
|
123
|
+
The standalone function version of this method:
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
127
|
+
import { dashboardsPostGetDashboard } from "syllable-sdk/funcs/dashboardsPostGetDashboard.js";
|
|
128
|
+
|
|
129
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
130
|
+
// You can create one instance of it to use across an application.
|
|
131
|
+
const syllableSDK = new SyllableSDKCore({
|
|
132
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
async function run() {
|
|
136
|
+
const res = await dashboardsPostGetDashboard(syllableSDK, {
|
|
137
|
+
dashboardName: "<value>",
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
if (!res.ok) {
|
|
141
|
+
throw res.error;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
const { value: result } = res;
|
|
145
|
+
|
|
146
|
+
// Handle the result
|
|
147
|
+
console.log(result);
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
run();
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
| Parameter | Type | Required | Description |
|
|
156
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
157
|
+
| `request` | [operations.PostGetDashboardRequest](../../models/operations/postgetdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
158
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
159
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
160
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
161
|
+
|
|
162
|
+
### Response
|
|
163
|
+
|
|
164
|
+
**Promise\<[components.DashboardTokenResponse](../../models/components/dashboardtokenresponse.md)\>**
|
|
165
|
+
|
|
166
|
+
### Errors
|
|
167
|
+
|
|
168
|
+
| Error Type | Status Code | Content Type |
|
|
169
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
170
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
171
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
172
|
+
|
|
173
|
+
## ~~postSessionEventsDashboard~~
|
|
16
174
|
|
|
17
175
|
METHOD: POST
|
|
18
176
|
URL: /dashboard/session_events
|
|
19
177
|
ARGUMENTS: None
|
|
20
178
|
RETURNS: Dashboard info for embedding
|
|
179
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
180
|
+
|
|
181
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
21
182
|
|
|
22
183
|
### Example Usage
|
|
23
184
|
|
|
@@ -86,12 +247,15 @@ run();
|
|
|
86
247
|
| --------------- | --------------- | --------------- |
|
|
87
248
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
88
249
|
|
|
89
|
-
## postSessionSummaryDashboard
|
|
250
|
+
## ~~postSessionSummaryDashboard~~
|
|
90
251
|
|
|
91
252
|
METHOD: POST
|
|
92
253
|
URL: /dashboard/session_summary
|
|
93
254
|
ARGUMENTS: None
|
|
94
255
|
RETURNS: Dashboard info for embedding
|
|
256
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
257
|
+
|
|
258
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
95
259
|
|
|
96
260
|
### Example Usage
|
|
97
261
|
|
|
@@ -160,12 +324,15 @@ run();
|
|
|
160
324
|
| --------------- | --------------- | --------------- |
|
|
161
325
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
162
326
|
|
|
163
|
-
## postSessionTransfersDashboard
|
|
327
|
+
## ~~postSessionTransfersDashboard~~
|
|
164
328
|
|
|
165
329
|
METHOD: POST
|
|
166
330
|
URL: /dashboard/session_transfers
|
|
167
331
|
ARGUMENTS: None
|
|
168
332
|
RETURNS: Dashboard info for embedding
|
|
333
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
334
|
+
|
|
335
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
169
336
|
|
|
170
337
|
### Example Usage
|
|
171
338
|
|
|
@@ -234,12 +401,15 @@ run();
|
|
|
234
401
|
| --------------- | --------------- | --------------- |
|
|
235
402
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
236
403
|
|
|
237
|
-
## postSessionsDashboard
|
|
404
|
+
## ~~postSessionsDashboard~~
|
|
238
405
|
|
|
239
406
|
METHOD: POST
|
|
240
407
|
URL: /dashboard/sessions
|
|
241
408
|
ARGUMENTS: None
|
|
242
409
|
RETURNS: Dashboard info for embedding
|
|
410
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
411
|
+
|
|
412
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
243
413
|
|
|
244
414
|
### Example Usage
|
|
245
415
|
|
|
@@ -107,7 +107,9 @@ async function run() {
|
|
|
107
107
|
function: {
|
|
108
108
|
name: "<value>",
|
|
109
109
|
description: "yuck vice between gee ugh ha",
|
|
110
|
-
parameters: {
|
|
110
|
+
parameters: {
|
|
111
|
+
|
|
112
|
+
},
|
|
111
113
|
},
|
|
112
114
|
},
|
|
113
115
|
},
|
|
@@ -143,7 +145,9 @@ async function run() {
|
|
|
143
145
|
function: {
|
|
144
146
|
name: "<value>",
|
|
145
147
|
description: "yuck vice between gee ugh ha",
|
|
146
|
-
parameters: {
|
|
148
|
+
parameters: {
|
|
149
|
+
|
|
150
|
+
},
|
|
147
151
|
},
|
|
148
152
|
},
|
|
149
153
|
},
|
|
@@ -204,7 +208,9 @@ async function run() {
|
|
|
204
208
|
function: {
|
|
205
209
|
name: "<value>",
|
|
206
210
|
description: "awful underneath retention too mobility char innocently dowse restfully",
|
|
207
|
-
parameters: {
|
|
211
|
+
parameters: {
|
|
212
|
+
|
|
213
|
+
},
|
|
208
214
|
},
|
|
209
215
|
},
|
|
210
216
|
},
|
|
@@ -241,7 +247,9 @@ async function run() {
|
|
|
241
247
|
function: {
|
|
242
248
|
name: "<value>",
|
|
243
249
|
description: "awful underneath retention too mobility char innocently dowse restfully",
|
|
244
|
-
parameters: {
|
|
250
|
+
parameters: {
|
|
251
|
+
|
|
252
|
+
},
|
|
245
253
|
},
|
|
246
254
|
},
|
|
247
255
|
},
|
package/docs/sdks/v1/README.md
CHANGED
|
@@ -5,17 +5,178 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
8
|
+
* [postListDashboard](#postlistdashboard) - Post List Dashboards
|
|
9
|
+
* [postGetDashboard](#postgetdashboard) - Post Fetch Info
|
|
10
|
+
* [~~postSessionEventsDashboard~~](#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
11
|
+
* [~~postSessionSummaryDashboard~~](#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
12
|
+
* [~~postSessionTransfersDashboard~~](#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
13
|
+
* [~~postSessionsDashboard~~](#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
12
14
|
|
|
13
|
-
##
|
|
15
|
+
## postListDashboard
|
|
16
|
+
|
|
17
|
+
METHOD: POST
|
|
18
|
+
URL: /dashboard/list
|
|
19
|
+
ARGUMENTS: None
|
|
20
|
+
RETURNS: List of dashboards
|
|
21
|
+
|
|
22
|
+
### Example Usage
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
26
|
+
|
|
27
|
+
const syllableSDK = new SyllableSDK({
|
|
28
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
async function run() {
|
|
32
|
+
const result = await syllableSDK.v1.postListDashboard({});
|
|
33
|
+
|
|
34
|
+
// Handle the result
|
|
35
|
+
console.log(result);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
run();
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Standalone function
|
|
42
|
+
|
|
43
|
+
The standalone function version of this method:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
47
|
+
import { v1PostListDashboard } from "syllable-sdk/funcs/v1PostListDashboard.js";
|
|
48
|
+
|
|
49
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
50
|
+
// You can create one instance of it to use across an application.
|
|
51
|
+
const syllableSDK = new SyllableSDKCore({
|
|
52
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
async function run() {
|
|
56
|
+
const res = await v1PostListDashboard(syllableSDK, {});
|
|
57
|
+
|
|
58
|
+
if (!res.ok) {
|
|
59
|
+
throw res.error;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
const { value: result } = res;
|
|
63
|
+
|
|
64
|
+
// Handle the result
|
|
65
|
+
console.log(result);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
run();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Parameter | Type | Required | Description |
|
|
74
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
+
| `request` | [operations.PostListDashboardRequest](../../models/operations/postlistdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
76
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
78
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
+
|
|
80
|
+
### Response
|
|
81
|
+
|
|
82
|
+
**Promise\<[components.ListResponseDashboardResponse](../../models/components/listresponsedashboardresponse.md)\>**
|
|
83
|
+
|
|
84
|
+
### Errors
|
|
85
|
+
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
88
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
89
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
90
|
+
|
|
91
|
+
## postGetDashboard
|
|
92
|
+
|
|
93
|
+
METHOD: POST
|
|
94
|
+
URL: /dashboard/fetch_info
|
|
95
|
+
ARGUMENTS: None
|
|
96
|
+
RETURNS: Dashboard info for embedding
|
|
97
|
+
|
|
98
|
+
### Example Usage
|
|
99
|
+
|
|
100
|
+
```typescript
|
|
101
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
102
|
+
|
|
103
|
+
const syllableSDK = new SyllableSDK({
|
|
104
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
async function run() {
|
|
108
|
+
const result = await syllableSDK.v1.postGetDashboard({
|
|
109
|
+
dashboardName: "<value>",
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
// Handle the result
|
|
113
|
+
console.log(result);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
run();
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Standalone function
|
|
120
|
+
|
|
121
|
+
The standalone function version of this method:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
125
|
+
import { v1PostGetDashboard } from "syllable-sdk/funcs/v1PostGetDashboard.js";
|
|
126
|
+
|
|
127
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
128
|
+
// You can create one instance of it to use across an application.
|
|
129
|
+
const syllableSDK = new SyllableSDKCore({
|
|
130
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
async function run() {
|
|
134
|
+
const res = await v1PostGetDashboard(syllableSDK, {
|
|
135
|
+
dashboardName: "<value>",
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
if (!res.ok) {
|
|
139
|
+
throw res.error;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
const { value: result } = res;
|
|
143
|
+
|
|
144
|
+
// Handle the result
|
|
145
|
+
console.log(result);
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
run();
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
| Parameter | Type | Required | Description |
|
|
154
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
155
|
+
| `request` | [operations.PostGetDashboardRequest](../../models/operations/postgetdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
156
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
157
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
158
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
159
|
+
|
|
160
|
+
### Response
|
|
161
|
+
|
|
162
|
+
**Promise\<[components.DashboardTokenResponse](../../models/components/dashboardtokenresponse.md)\>**
|
|
163
|
+
|
|
164
|
+
### Errors
|
|
165
|
+
|
|
166
|
+
| Error Type | Status Code | Content Type |
|
|
167
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
168
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
169
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
170
|
+
|
|
171
|
+
## ~~postSessionEventsDashboard~~
|
|
14
172
|
|
|
15
173
|
METHOD: POST
|
|
16
174
|
URL: /dashboard/session_events
|
|
17
175
|
ARGUMENTS: None
|
|
18
176
|
RETURNS: Dashboard info for embedding
|
|
177
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
178
|
+
|
|
179
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
19
180
|
|
|
20
181
|
### Example Usage
|
|
21
182
|
|
|
@@ -84,12 +245,15 @@ run();
|
|
|
84
245
|
| --------------- | --------------- | --------------- |
|
|
85
246
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
86
247
|
|
|
87
|
-
## postSessionSummaryDashboard
|
|
248
|
+
## ~~postSessionSummaryDashboard~~
|
|
88
249
|
|
|
89
250
|
METHOD: POST
|
|
90
251
|
URL: /dashboard/session_summary
|
|
91
252
|
ARGUMENTS: None
|
|
92
253
|
RETURNS: Dashboard info for embedding
|
|
254
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
255
|
+
|
|
256
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
93
257
|
|
|
94
258
|
### Example Usage
|
|
95
259
|
|
|
@@ -158,12 +322,15 @@ run();
|
|
|
158
322
|
| --------------- | --------------- | --------------- |
|
|
159
323
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
160
324
|
|
|
161
|
-
## postSessionTransfersDashboard
|
|
325
|
+
## ~~postSessionTransfersDashboard~~
|
|
162
326
|
|
|
163
327
|
METHOD: POST
|
|
164
328
|
URL: /dashboard/session_transfers
|
|
165
329
|
ARGUMENTS: None
|
|
166
330
|
RETURNS: Dashboard info for embedding
|
|
331
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
332
|
+
|
|
333
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
167
334
|
|
|
168
335
|
### Example Usage
|
|
169
336
|
|
|
@@ -232,12 +399,15 @@ run();
|
|
|
232
399
|
| --------------- | --------------- | --------------- |
|
|
233
400
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
234
401
|
|
|
235
|
-
## postSessionsDashboard
|
|
402
|
+
## ~~postSessionsDashboard~~
|
|
236
403
|
|
|
237
404
|
METHOD: POST
|
|
238
405
|
URL: /dashboard/sessions
|
|
239
406
|
ARGUMENTS: None
|
|
240
407
|
RETURNS: Dashboard info for embedding
|
|
408
|
+
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
409
|
+
|
|
410
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
241
411
|
|
|
242
412
|
### Example Usage
|
|
243
413
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { SyllableSDKCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import * as components from "../models/components/index.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
5
|
+
import * as errors from "../models/errors/index.js";
|
|
6
|
+
import { SDKError } from "../models/errors/sdkerror.js";
|
|
7
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Post Fetch Info
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* METHOD: POST
|
|
15
|
+
* URL: /dashboard/fetch_info
|
|
16
|
+
* ARGUMENTS: None
|
|
17
|
+
* RETURNS: Dashboard info for embedding
|
|
18
|
+
*/
|
|
19
|
+
export declare function dashboardsPostGetDashboard(client: SyllableSDKCore, request: operations.PostGetDashboardRequest, options?: RequestOptions): Promise<Result<components.DashboardTokenResponse, errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
20
|
+
//# sourceMappingURL=dashboardsPostGetDashboard.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dashboardsPostGetDashboard.d.ts","sourceRoot":"","sources":["../src/funcs/dashboardsPostGetDashboard.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;GAQG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,sBAAsB,EAC/B,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CA0FA"}
|