syllable-sdk 0.1.0-alpha.74 → 0.1.0-alpha.76
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 +5 -15
- package/docs/sdks/batches/README.md +14 -14
- package/docs/sdks/latency/README.md +85 -0
- package/funcs/{v1PostListDashboard.d.ts → sessionsLatencyGetById.d.ts} +3 -9
- package/funcs/sessionsLatencyGetById.d.ts.map +1 -0
- package/funcs/{v1PostGetDashboard.js → sessionsLatencyGetById.js} +15 -19
- package/funcs/sessionsLatencyGetById.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/index.d.ts +5 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +5 -0
- package/models/components/index.js.map +1 -1
- package/models/components/inspectlatencyresponse.d.ts +42 -0
- package/models/components/inspectlatencyresponse.d.ts.map +1 -0
- package/models/components/inspectlatencyresponse.js +74 -0
- package/models/components/inspectlatencyresponse.js.map +1 -0
- package/models/components/latencycategory.d.ts +37 -0
- package/models/components/latencycategory.d.ts.map +1 -0
- package/models/components/latencycategory.js +53 -0
- package/models/components/latencycategory.js.map +1 -0
- package/models/components/latencyentry.d.ts +50 -0
- package/models/components/latencyentry.d.ts.map +1 -0
- package/models/components/latencyentry.js +92 -0
- package/models/components/latencyentry.js.map +1 -0
- package/models/components/latencyunittype.d.ts +37 -0
- package/models/components/latencyunittype.d.ts.map +1 -0
- package/models/components/latencyunittype.js +53 -0
- package/models/components/latencyunittype.js.map +1 -0
- package/models/components/promptcreaterequest.d.ts +1 -1
- package/models/components/promptupdaterequest.d.ts +1 -1
- package/models/components/summaryentry.d.ts +46 -0
- package/models/components/summaryentry.d.ts.map +1 -0
- package/models/components/summaryentry.js +87 -0
- package/models/components/summaryentry.js.map +1 -0
- package/models/operations/index.d.ts +1 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/sessionlatencygetbyid.d.ts +29 -0
- package/models/operations/sessionlatencygetbyid.d.ts.map +1 -0
- package/models/operations/sessionlatencygetbyid.js +68 -0
- package/models/operations/sessionlatencygetbyid.js.map +1 -0
- package/openapi.json +18739 -18645
- package/package.json +1 -1
- package/sdk/latency.d.ts +10 -0
- package/sdk/latency.d.ts.map +1 -0
- package/sdk/latency.js +19 -0
- package/sdk/latency.js.map +1 -0
- package/sdk/sdk.d.ts +0 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -4
- package/sdk/sdk.js.map +1 -1
- package/sdk/sessions.d.ts +3 -0
- package/sdk/sessions.d.ts.map +1 -1
- package/sdk/sessions.js +4 -0
- package/sdk/sessions.js.map +1 -1
- package/src/funcs/{v1PostGetDashboard.ts → sessionsLatencyGetById.ts} +18 -21
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +5 -0
- package/src/models/components/inspectlatencyresponse.ts +102 -0
- package/src/models/components/latencycategory.ts +36 -0
- package/src/models/components/latencyentry.ts +124 -0
- package/src/models/components/latencyunittype.ts +36 -0
- package/src/models/components/promptcreaterequest.ts +1 -1
- package/src/models/components/promptupdaterequest.ts +1 -1
- package/src/models/components/summaryentry.ts +110 -0
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/sessionlatencygetbyid.ts +77 -0
- package/src/sdk/latency.ts +25 -0
- package/src/sdk/sdk.ts +0 -6
- package/src/sdk/sessions.ts +6 -0
- package/docs/sdks/v1/README.md +0 -497
- package/funcs/v1PostGetDashboard.d.ts +0 -20
- package/funcs/v1PostGetDashboard.d.ts.map +0 -1
- package/funcs/v1PostGetDashboard.js.map +0 -1
- package/funcs/v1PostListDashboard.d.ts.map +0 -1
- package/funcs/v1PostListDashboard.js +0 -117
- package/funcs/v1PostListDashboard.js.map +0 -1
- package/funcs/v1PostSessionEventsDashboard.d.ts +0 -21
- package/funcs/v1PostSessionEventsDashboard.d.ts.map +0 -1
- package/funcs/v1PostSessionEventsDashboard.js +0 -94
- package/funcs/v1PostSessionEventsDashboard.js.map +0 -1
- package/funcs/v1PostSessionSummaryDashboard.d.ts +0 -21
- package/funcs/v1PostSessionSummaryDashboard.d.ts.map +0 -1
- package/funcs/v1PostSessionSummaryDashboard.js +0 -94
- package/funcs/v1PostSessionSummaryDashboard.js.map +0 -1
- package/funcs/v1PostSessionTransfersDashboard.d.ts +0 -21
- package/funcs/v1PostSessionTransfersDashboard.d.ts.map +0 -1
- package/funcs/v1PostSessionTransfersDashboard.js +0 -94
- package/funcs/v1PostSessionTransfersDashboard.js.map +0 -1
- package/funcs/v1PostSessionsDashboard.d.ts +0 -21
- package/funcs/v1PostSessionsDashboard.d.ts.map +0 -1
- package/funcs/v1PostSessionsDashboard.js +0 -94
- package/funcs/v1PostSessionsDashboard.js.map +0 -1
- package/sdk/v1.d.ts +0 -78
- package/sdk/v1.d.ts.map +0 -1
- package/sdk/v1.js +0 -102
- package/sdk/v1.js.map +0 -1
- package/src/funcs/v1PostListDashboard.ts +0 -151
- package/src/funcs/v1PostSessionEventsDashboard.ts +0 -117
- package/src/funcs/v1PostSessionSummaryDashboard.ts +0 -117
- package/src/funcs/v1PostSessionTransfersDashboard.ts +0 -117
- package/src/funcs/v1PostSessionsDashboard.ts +0 -117
- package/src/sdk/v1.ts +0 -140
package/docs/sdks/v1/README.md
DELETED
|
@@ -1,497 +0,0 @@
|
|
|
1
|
-
# V1
|
|
2
|
-
(*v1*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
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**
|
|
14
|
-
|
|
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
|
-
page: 0,
|
|
34
|
-
searchFields: [
|
|
35
|
-
"name",
|
|
36
|
-
],
|
|
37
|
-
searchFieldValues: [
|
|
38
|
-
"Some Object Name",
|
|
39
|
-
],
|
|
40
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
41
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
// Handle the result
|
|
45
|
-
console.log(result);
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
run();
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### Standalone function
|
|
52
|
-
|
|
53
|
-
The standalone function version of this method:
|
|
54
|
-
|
|
55
|
-
```typescript
|
|
56
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
57
|
-
import { v1PostListDashboard } from "syllable-sdk/funcs/v1PostListDashboard.js";
|
|
58
|
-
|
|
59
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
60
|
-
// You can create one instance of it to use across an application.
|
|
61
|
-
const syllableSDK = new SyllableSDKCore({
|
|
62
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
async function run() {
|
|
66
|
-
const res = await v1PostListDashboard(syllableSDK, {
|
|
67
|
-
page: 0,
|
|
68
|
-
searchFields: [
|
|
69
|
-
"name",
|
|
70
|
-
],
|
|
71
|
-
searchFieldValues: [
|
|
72
|
-
"Some Object Name",
|
|
73
|
-
],
|
|
74
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
75
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
76
|
-
});
|
|
77
|
-
|
|
78
|
-
if (!res.ok) {
|
|
79
|
-
throw res.error;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
const { value: result } = res;
|
|
83
|
-
|
|
84
|
-
// Handle the result
|
|
85
|
-
console.log(result);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
run();
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### Parameters
|
|
92
|
-
|
|
93
|
-
| Parameter | Type | Required | Description |
|
|
94
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
95
|
-
| `request` | [operations.PostListDashboardRequest](../../models/operations/postlistdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
96
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
97
|
-
| `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. |
|
|
98
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
99
|
-
|
|
100
|
-
### Response
|
|
101
|
-
|
|
102
|
-
**Promise\<[components.ListResponseDashboardResponse](../../models/components/listresponsedashboardresponse.md)\>**
|
|
103
|
-
|
|
104
|
-
### Errors
|
|
105
|
-
|
|
106
|
-
| Error Type | Status Code | Content Type |
|
|
107
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
108
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
109
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
110
|
-
|
|
111
|
-
## postGetDashboard
|
|
112
|
-
|
|
113
|
-
METHOD: POST
|
|
114
|
-
URL: /dashboard/fetch_info
|
|
115
|
-
ARGUMENTS: None
|
|
116
|
-
RETURNS: Dashboard info for embedding
|
|
117
|
-
|
|
118
|
-
### Example Usage
|
|
119
|
-
|
|
120
|
-
```typescript
|
|
121
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
122
|
-
|
|
123
|
-
const syllableSDK = new SyllableSDK({
|
|
124
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
async function run() {
|
|
128
|
-
const result = await syllableSDK.v1.postGetDashboard({
|
|
129
|
-
dashboardName: "<value>",
|
|
130
|
-
});
|
|
131
|
-
|
|
132
|
-
// Handle the result
|
|
133
|
-
console.log(result);
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
run();
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Standalone function
|
|
140
|
-
|
|
141
|
-
The standalone function version of this method:
|
|
142
|
-
|
|
143
|
-
```typescript
|
|
144
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
145
|
-
import { v1PostGetDashboard } from "syllable-sdk/funcs/v1PostGetDashboard.js";
|
|
146
|
-
|
|
147
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
148
|
-
// You can create one instance of it to use across an application.
|
|
149
|
-
const syllableSDK = new SyllableSDKCore({
|
|
150
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
151
|
-
});
|
|
152
|
-
|
|
153
|
-
async function run() {
|
|
154
|
-
const res = await v1PostGetDashboard(syllableSDK, {
|
|
155
|
-
dashboardName: "<value>",
|
|
156
|
-
});
|
|
157
|
-
|
|
158
|
-
if (!res.ok) {
|
|
159
|
-
throw res.error;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
const { value: result } = res;
|
|
163
|
-
|
|
164
|
-
// Handle the result
|
|
165
|
-
console.log(result);
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
run();
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### Parameters
|
|
172
|
-
|
|
173
|
-
| Parameter | Type | Required | Description |
|
|
174
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
175
|
-
| `request` | [operations.PostGetDashboardRequest](../../models/operations/postgetdashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
176
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
177
|
-
| `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. |
|
|
178
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
179
|
-
|
|
180
|
-
### Response
|
|
181
|
-
|
|
182
|
-
**Promise\<[components.DashboardTokenResponse](../../models/components/dashboardtokenresponse.md)\>**
|
|
183
|
-
|
|
184
|
-
### Errors
|
|
185
|
-
|
|
186
|
-
| Error Type | Status Code | Content Type |
|
|
187
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
188
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
189
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
190
|
-
|
|
191
|
-
## ~~postSessionEventsDashboard~~
|
|
192
|
-
|
|
193
|
-
METHOD: POST
|
|
194
|
-
URL: /dashboard/session_events
|
|
195
|
-
ARGUMENTS: None
|
|
196
|
-
RETURNS: Dashboard info for embedding
|
|
197
|
-
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
198
|
-
|
|
199
|
-
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
200
|
-
|
|
201
|
-
### Example Usage
|
|
202
|
-
|
|
203
|
-
```typescript
|
|
204
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
205
|
-
|
|
206
|
-
const syllableSDK = new SyllableSDK({
|
|
207
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
208
|
-
});
|
|
209
|
-
|
|
210
|
-
async function run() {
|
|
211
|
-
const result = await syllableSDK.v1.postSessionEventsDashboard();
|
|
212
|
-
|
|
213
|
-
// Handle the result
|
|
214
|
-
console.log(result);
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
run();
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
### Standalone function
|
|
221
|
-
|
|
222
|
-
The standalone function version of this method:
|
|
223
|
-
|
|
224
|
-
```typescript
|
|
225
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
226
|
-
import { v1PostSessionEventsDashboard } from "syllable-sdk/funcs/v1PostSessionEventsDashboard.js";
|
|
227
|
-
|
|
228
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
229
|
-
// You can create one instance of it to use across an application.
|
|
230
|
-
const syllableSDK = new SyllableSDKCore({
|
|
231
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
232
|
-
});
|
|
233
|
-
|
|
234
|
-
async function run() {
|
|
235
|
-
const res = await v1PostSessionEventsDashboard(syllableSDK);
|
|
236
|
-
|
|
237
|
-
if (!res.ok) {
|
|
238
|
-
throw res.error;
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
const { value: result } = res;
|
|
242
|
-
|
|
243
|
-
// Handle the result
|
|
244
|
-
console.log(result);
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
run();
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
### Parameters
|
|
251
|
-
|
|
252
|
-
| Parameter | Type | Required | Description |
|
|
253
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
254
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
255
|
-
| `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. |
|
|
256
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
257
|
-
|
|
258
|
-
### Response
|
|
259
|
-
|
|
260
|
-
**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
|
|
261
|
-
|
|
262
|
-
### Errors
|
|
263
|
-
|
|
264
|
-
| Error Type | Status Code | Content Type |
|
|
265
|
-
| --------------- | --------------- | --------------- |
|
|
266
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
267
|
-
|
|
268
|
-
## ~~postSessionSummaryDashboard~~
|
|
269
|
-
|
|
270
|
-
METHOD: POST
|
|
271
|
-
URL: /dashboard/session_summary
|
|
272
|
-
ARGUMENTS: None
|
|
273
|
-
RETURNS: Dashboard info for embedding
|
|
274
|
-
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
275
|
-
|
|
276
|
-
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
277
|
-
|
|
278
|
-
### Example Usage
|
|
279
|
-
|
|
280
|
-
```typescript
|
|
281
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
282
|
-
|
|
283
|
-
const syllableSDK = new SyllableSDK({
|
|
284
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
285
|
-
});
|
|
286
|
-
|
|
287
|
-
async function run() {
|
|
288
|
-
const result = await syllableSDK.v1.postSessionSummaryDashboard();
|
|
289
|
-
|
|
290
|
-
// Handle the result
|
|
291
|
-
console.log(result);
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
run();
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
### Standalone function
|
|
298
|
-
|
|
299
|
-
The standalone function version of this method:
|
|
300
|
-
|
|
301
|
-
```typescript
|
|
302
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
303
|
-
import { v1PostSessionSummaryDashboard } from "syllable-sdk/funcs/v1PostSessionSummaryDashboard.js";
|
|
304
|
-
|
|
305
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
306
|
-
// You can create one instance of it to use across an application.
|
|
307
|
-
const syllableSDK = new SyllableSDKCore({
|
|
308
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
309
|
-
});
|
|
310
|
-
|
|
311
|
-
async function run() {
|
|
312
|
-
const res = await v1PostSessionSummaryDashboard(syllableSDK);
|
|
313
|
-
|
|
314
|
-
if (!res.ok) {
|
|
315
|
-
throw res.error;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
const { value: result } = res;
|
|
319
|
-
|
|
320
|
-
// Handle the result
|
|
321
|
-
console.log(result);
|
|
322
|
-
}
|
|
323
|
-
|
|
324
|
-
run();
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
### Parameters
|
|
328
|
-
|
|
329
|
-
| Parameter | Type | Required | Description |
|
|
330
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
331
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
332
|
-
| `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. |
|
|
333
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
334
|
-
|
|
335
|
-
### Response
|
|
336
|
-
|
|
337
|
-
**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
|
|
338
|
-
|
|
339
|
-
### Errors
|
|
340
|
-
|
|
341
|
-
| Error Type | Status Code | Content Type |
|
|
342
|
-
| --------------- | --------------- | --------------- |
|
|
343
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
344
|
-
|
|
345
|
-
## ~~postSessionTransfersDashboard~~
|
|
346
|
-
|
|
347
|
-
METHOD: POST
|
|
348
|
-
URL: /dashboard/session_transfers
|
|
349
|
-
ARGUMENTS: None
|
|
350
|
-
RETURNS: Dashboard info for embedding
|
|
351
|
-
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
352
|
-
|
|
353
|
-
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
354
|
-
|
|
355
|
-
### Example Usage
|
|
356
|
-
|
|
357
|
-
```typescript
|
|
358
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
359
|
-
|
|
360
|
-
const syllableSDK = new SyllableSDK({
|
|
361
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
362
|
-
});
|
|
363
|
-
|
|
364
|
-
async function run() {
|
|
365
|
-
const result = await syllableSDK.v1.postSessionTransfersDashboard();
|
|
366
|
-
|
|
367
|
-
// Handle the result
|
|
368
|
-
console.log(result);
|
|
369
|
-
}
|
|
370
|
-
|
|
371
|
-
run();
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
### Standalone function
|
|
375
|
-
|
|
376
|
-
The standalone function version of this method:
|
|
377
|
-
|
|
378
|
-
```typescript
|
|
379
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
380
|
-
import { v1PostSessionTransfersDashboard } from "syllable-sdk/funcs/v1PostSessionTransfersDashboard.js";
|
|
381
|
-
|
|
382
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
383
|
-
// You can create one instance of it to use across an application.
|
|
384
|
-
const syllableSDK = new SyllableSDKCore({
|
|
385
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
386
|
-
});
|
|
387
|
-
|
|
388
|
-
async function run() {
|
|
389
|
-
const res = await v1PostSessionTransfersDashboard(syllableSDK);
|
|
390
|
-
|
|
391
|
-
if (!res.ok) {
|
|
392
|
-
throw res.error;
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
const { value: result } = res;
|
|
396
|
-
|
|
397
|
-
// Handle the result
|
|
398
|
-
console.log(result);
|
|
399
|
-
}
|
|
400
|
-
|
|
401
|
-
run();
|
|
402
|
-
```
|
|
403
|
-
|
|
404
|
-
### Parameters
|
|
405
|
-
|
|
406
|
-
| Parameter | Type | Required | Description |
|
|
407
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
408
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
409
|
-
| `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. |
|
|
410
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
411
|
-
|
|
412
|
-
### Response
|
|
413
|
-
|
|
414
|
-
**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
|
|
415
|
-
|
|
416
|
-
### Errors
|
|
417
|
-
|
|
418
|
-
| Error Type | Status Code | Content Type |
|
|
419
|
-
| --------------- | --------------- | --------------- |
|
|
420
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
421
|
-
|
|
422
|
-
## ~~postSessionsDashboard~~
|
|
423
|
-
|
|
424
|
-
METHOD: POST
|
|
425
|
-
URL: /dashboard/sessions
|
|
426
|
-
ARGUMENTS: None
|
|
427
|
-
RETURNS: Dashboard info for embedding
|
|
428
|
-
DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
|
|
429
|
-
|
|
430
|
-
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
431
|
-
|
|
432
|
-
### Example Usage
|
|
433
|
-
|
|
434
|
-
```typescript
|
|
435
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
436
|
-
|
|
437
|
-
const syllableSDK = new SyllableSDK({
|
|
438
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
439
|
-
});
|
|
440
|
-
|
|
441
|
-
async function run() {
|
|
442
|
-
const result = await syllableSDK.v1.postSessionsDashboard();
|
|
443
|
-
|
|
444
|
-
// Handle the result
|
|
445
|
-
console.log(result);
|
|
446
|
-
}
|
|
447
|
-
|
|
448
|
-
run();
|
|
449
|
-
```
|
|
450
|
-
|
|
451
|
-
### Standalone function
|
|
452
|
-
|
|
453
|
-
The standalone function version of this method:
|
|
454
|
-
|
|
455
|
-
```typescript
|
|
456
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
457
|
-
import { v1PostSessionsDashboard } from "syllable-sdk/funcs/v1PostSessionsDashboard.js";
|
|
458
|
-
|
|
459
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
460
|
-
// You can create one instance of it to use across an application.
|
|
461
|
-
const syllableSDK = new SyllableSDKCore({
|
|
462
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
463
|
-
});
|
|
464
|
-
|
|
465
|
-
async function run() {
|
|
466
|
-
const res = await v1PostSessionsDashboard(syllableSDK);
|
|
467
|
-
|
|
468
|
-
if (!res.ok) {
|
|
469
|
-
throw res.error;
|
|
470
|
-
}
|
|
471
|
-
|
|
472
|
-
const { value: result } = res;
|
|
473
|
-
|
|
474
|
-
// Handle the result
|
|
475
|
-
console.log(result);
|
|
476
|
-
}
|
|
477
|
-
|
|
478
|
-
run();
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
### Parameters
|
|
482
|
-
|
|
483
|
-
| Parameter | Type | Required | Description |
|
|
484
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
485
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
486
|
-
| `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. |
|
|
487
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
488
|
-
|
|
489
|
-
### Response
|
|
490
|
-
|
|
491
|
-
**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
|
|
492
|
-
|
|
493
|
-
### Errors
|
|
494
|
-
|
|
495
|
-
| Error Type | Status Code | Content Type |
|
|
496
|
-
| --------------- | --------------- | --------------- |
|
|
497
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,20 +0,0 @@
|
|
|
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 v1PostGetDashboard(client: SyllableSDKCore, request: operations.PostGetDashboardRequest, options?: RequestOptions): Promise<Result<components.DashboardTokenResponse, errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
20
|
-
//# sourceMappingURL=v1PostGetDashboard.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"v1PostGetDashboard.d.ts","sourceRoot":"","sources":["../src/funcs/v1PostGetDashboard.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,kBAAkB,CACtC,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,CA2FA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"v1PostGetDashboard.js","sourceRoot":"","sources":["../src/funcs/v1PostGetDashboard.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;AAiCH,gDA2GC;AAzID,sDAAsD;AACtD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAC3C,0EAA4D;AAQ5D,kEAAoD;AAGpD,0EAA4D;AAG5D;;;;;;;;GAQG;AACI,KAAK,UAAU,kBAAkB,CACtC,MAAuB,EACvB,OAA2C,EAC3C,OAAwB;IAcxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,sCAAsC,CAAC,KAAK,CAAC,KAAK,CAAC,EACzE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,+BAA+B,CAAC,EAAE,CAAC;IAE3D,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,gBAAgB,EAAE,OAAO,CAAC,cAAc;KACzC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACtE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;IAC3E,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,EAAE;QACjC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY;QAC5C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAW5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,oCAAoC,CAAC,EAC5D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"v1PostListDashboard.d.ts","sourceRoot":"","sources":["../src/funcs/v1PostListDashboard.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,mBAAmB,CACvC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,6BAA6B,EACtC,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAmGA"}
|