syllable-sdk 1.0.8-rc.1 → 1.0.8-rc.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.
Files changed (91) hide show
  1. package/bin/mcp-server.js +135 -59
  2. package/bin/mcp-server.js.map +13 -12
  3. package/examples/package-lock.json +1 -1
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +3 -3
  6. package/lib/config.js +3 -3
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/server.js +1 -1
  9. package/models/components/daotoolresponse.d.ts +80 -0
  10. package/models/components/daotoolresponse.d.ts.map +1 -0
  11. package/models/components/daotoolresponse.js +111 -0
  12. package/models/components/daotoolresponse.js.map +1 -0
  13. package/models/components/index.d.ts +1 -0
  14. package/models/components/index.d.ts.map +1 -1
  15. package/models/components/index.js +1 -0
  16. package/models/components/index.js.map +1 -1
  17. package/models/components/promptcreaterequest.d.ts +5 -0
  18. package/models/components/promptcreaterequest.d.ts.map +1 -1
  19. package/models/components/promptcreaterequest.js +4 -0
  20. package/models/components/promptcreaterequest.js.map +1 -1
  21. package/models/components/promptresponse.d.ts +11 -0
  22. package/models/components/promptresponse.d.ts.map +1 -1
  23. package/models/components/promptresponse.js +9 -0
  24. package/models/components/promptresponse.js.map +1 -1
  25. package/models/components/promptupdaterequest.d.ts +5 -0
  26. package/models/components/promptupdaterequest.d.ts.map +1 -1
  27. package/models/components/promptupdaterequest.js +4 -0
  28. package/models/components/promptupdaterequest.js.map +1 -1
  29. package/openapi.json +243 -33
  30. package/package.json +1 -1
  31. package/src/lib/config.ts +3 -3
  32. package/src/mcp-server/mcp-server.ts +1 -1
  33. package/src/mcp-server/server.ts +1 -1
  34. package/src/models/components/daotoolresponse.ts +171 -0
  35. package/src/models/components/index.ts +1 -0
  36. package/src/models/components/promptcreaterequest.ts +9 -0
  37. package/src/models/components/promptresponse.ts +24 -0
  38. package/src/models/components/promptupdaterequest.ts +9 -0
  39. package/.devcontainer/README.md +0 -35
  40. package/api-reference/sdks/agents/README.md +0 -224
  41. package/api-reference/sdks/availabletargets/README.md +0 -49
  42. package/api-reference/sdks/channels/README.md +0 -92
  43. package/api-reference/sdks/chats/README.md +0 -55
  44. package/api-reference/sdks/conversations/README.md +0 -91
  45. package/api-reference/sdks/dashboards/README.md +0 -321
  46. package/api-reference/sdks/events/README.md +0 -50
  47. package/api-reference/sdks/greetings/README.md +0 -223
  48. package/api-reference/sdks/organizations/README.md +0 -48
  49. package/api-reference/sdks/prompts/README.md +0 -225
  50. package/api-reference/sdks/sessions/README.md +0 -50
  51. package/api-reference/sdks/syllable/README.md +0 -22
  52. package/api-reference/sdks/targets/README.md +0 -194
  53. package/api-reference/sdks/tools/README.md +0 -92
  54. package/docs/sdks/agents/README.md +0 -589
  55. package/docs/sdks/batches/README.md +0 -742
  56. package/docs/sdks/campaigns/README.md +0 -526
  57. package/docs/sdks/channels/README.md +0 -401
  58. package/docs/sdks/conversations/README.md +0 -100
  59. package/docs/sdks/custommessages/README.md +0 -496
  60. package/docs/sdks/dashboards/README.md +0 -481
  61. package/docs/sdks/datasources/README.md +0 -458
  62. package/docs/sdks/directory/README.md +0 -727
  63. package/docs/sdks/events/README.md +0 -100
  64. package/docs/sdks/folders/README.md +0 -675
  65. package/docs/sdks/fullsummary/README.md +0 -82
  66. package/docs/sdks/incidents/README.md +0 -501
  67. package/docs/sdks/insights/README.md +0 -100
  68. package/docs/sdks/languagegroups/README.md +0 -565
  69. package/docs/sdks/latency/README.md +0 -82
  70. package/docs/sdks/numbers/README.md +0 -250
  71. package/docs/sdks/organizations/README.md +0 -317
  72. package/docs/sdks/permissions/README.md +0 -78
  73. package/docs/sdks/prompts/README.md +0 -592
  74. package/docs/sdks/pronunciations/README.md +0 -360
  75. package/docs/sdks/roles/README.md +0 -430
  76. package/docs/sdks/services/README.md +0 -430
  77. package/docs/sdks/sessiondebug/README.md +0 -236
  78. package/docs/sdks/sessionlabels/README.md +0 -262
  79. package/docs/sdks/sessions/README.md +0 -325
  80. package/docs/sdks/syllablesdktools/README.md +0 -578
  81. package/docs/sdks/takeouts/README.md +0 -228
  82. package/docs/sdks/targets/README.md +0 -454
  83. package/docs/sdks/test/README.md +0 -92
  84. package/docs/sdks/tools/README.md +0 -518
  85. package/docs/sdks/transcript/README.md +0 -82
  86. package/docs/sdks/twilio/README.md +0 -246
  87. package/docs/sdks/users/README.md +0 -561
  88. package/docs/sdks/v1/README.md +0 -561
  89. package/docs/sdks/voicegroups/README.md +0 -551
  90. package/docs/sdks/workflows/README.md +0 -781
  91. package/examples/README.md +0 -31
package/docs/sdks/sessiondebug/README.md DELETED
@@ -1,236 +0,0 @@
1
- # SessionDebug
2
- (*sessionDebug*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [getSessionDataBySid](#getsessiondatabysid) - Get Session Data By Sid
9
- * [getSessionDataBySessionId](#getsessiondatabysessionid) - Get Session Data By Session Id
10
- * [getSessionToolCallResultById](#getsessiontoolcallresultbyid) - Get Session Tool Call Result By Id
11
-
12
- ## getSessionDataBySid
13
-
14
- Get Session Data By Sid
15
-
16
- ### Example Usage
17
-
18
- <!-- UsageSnippet language="typescript" operationID="get_session_data_by_sid" method="get" path="/api/v1/session_debug/sid/{channel_manager_service}/{channel_manager_sid}" -->
19
- ```typescript
20
- import { SyllableSDK } from "syllable-sdk";
21
-
22
- const syllableSDK = new SyllableSDK({
23
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
24
- });
25
-
26
- async function run() {
27
- const result = await syllableSDK.sessionDebug.getSessionDataBySid({
28
- channelManagerService: "<value>",
29
- channelManagerSid: "<id>",
30
- });
31
-
32
- console.log(result);
33
- }
34
-
35
- run();
36
- ```
37
-
38
- ### Standalone function
39
-
40
- The standalone function version of this method:
41
-
42
- ```typescript
43
- import { SyllableSDKCore } from "syllable-sdk/core.js";
44
- import { sessionDebugGetSessionDataBySid } from "syllable-sdk/funcs/sessionDebugGetSessionDataBySid.js";
45
-
46
- // Use `SyllableSDKCore` for best tree-shaking performance.
47
- // You can create one instance of it to use across an application.
48
- const syllableSDK = new SyllableSDKCore({
49
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
50
- });
51
-
52
- async function run() {
53
- const res = await sessionDebugGetSessionDataBySid(syllableSDK, {
54
- channelManagerService: "<value>",
55
- channelManagerSid: "<id>",
56
- });
57
- if (res.ok) {
58
- const { value: result } = res;
59
- console.log(result);
60
- } else {
61
- console.log("sessionDebugGetSessionDataBySid failed:", res.error);
62
- }
63
- }
64
-
65
- run();
66
- ```
67
-
68
- ### Parameters
69
-
70
- | Parameter | Type | Required | Description |
71
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
72
- | `request` | [operations.GetSessionDataBySidRequest](../../models/operations/getsessiondatabysidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
73
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
74
- | `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. |
75
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
76
-
77
- ### Response
78
-
79
- **Promise\<[components.SessionData](../../models/components/sessiondata.md)\>**
80
-
81
- ### Errors
82
-
83
- | Error Type | Status Code | Content Type |
84
- | -------------------------- | -------------------------- | -------------------------- |
85
- | errors.HTTPValidationError | 422 | application/json |
86
- | errors.SDKError | 4XX, 5XX | \*/\* |
87
-
88
- ## getSessionDataBySessionId
89
-
90
- Get Session Data By Session Id
91
-
92
- ### Example Usage
93
-
94
- <!-- UsageSnippet language="typescript" operationID="get_session_data_by_session_id" method="get" path="/api/v1/session_debug/session_id/{session_id}" -->
95
- ```typescript
96
- import { SyllableSDK } from "syllable-sdk";
97
-
98
- const syllableSDK = new SyllableSDK({
99
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
100
- });
101
-
102
- async function run() {
103
- const result = await syllableSDK.sessionDebug.getSessionDataBySessionId({
104
- sessionId: 303182,
105
- });
106
-
107
- console.log(result);
108
- }
109
-
110
- run();
111
- ```
112
-
113
- ### Standalone function
114
-
115
- The standalone function version of this method:
116
-
117
- ```typescript
118
- import { SyllableSDKCore } from "syllable-sdk/core.js";
119
- import { sessionDebugGetSessionDataBySessionId } from "syllable-sdk/funcs/sessionDebugGetSessionDataBySessionId.js";
120
-
121
- // Use `SyllableSDKCore` for best tree-shaking performance.
122
- // You can create one instance of it to use across an application.
123
- const syllableSDK = new SyllableSDKCore({
124
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
125
- });
126
-
127
- async function run() {
128
- const res = await sessionDebugGetSessionDataBySessionId(syllableSDK, {
129
- sessionId: 303182,
130
- });
131
- if (res.ok) {
132
- const { value: result } = res;
133
- console.log(result);
134
- } else {
135
- console.log("sessionDebugGetSessionDataBySessionId failed:", res.error);
136
- }
137
- }
138
-
139
- run();
140
- ```
141
-
142
- ### Parameters
143
-
144
- | Parameter | Type | Required | Description |
145
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
146
- | `request` | [operations.GetSessionDataBySessionIdRequest](../../models/operations/getsessiondatabysessionidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
147
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
148
- | `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. |
149
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
150
-
151
- ### Response
152
-
153
- **Promise\<[components.SessionData](../../models/components/sessiondata.md)\>**
154
-
155
- ### Errors
156
-
157
- | Error Type | Status Code | Content Type |
158
- | -------------------------- | -------------------------- | -------------------------- |
159
- | errors.HTTPValidationError | 422 | application/json |
160
- | errors.SDKError | 4XX, 5XX | \*/\* |
161
-
162
- ## getSessionToolCallResultById
163
-
164
- Get Session Tool Call Result By Id
165
-
166
- ### Example Usage
167
-
168
- <!-- UsageSnippet language="typescript" operationID="get_session_tool_call_result_by_id" method="get" path="/api/v1/session_debug/tool_result/{session_id}/{tool_call_id}" -->
169
- ```typescript
170
- import { SyllableSDK } from "syllable-sdk";
171
-
172
- const syllableSDK = new SyllableSDK({
173
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
174
- });
175
-
176
- async function run() {
177
- const result = await syllableSDK.sessionDebug.getSessionToolCallResultById({
178
- sessionId: 832133,
179
- toolCallId: "<id>",
180
- });
181
-
182
- console.log(result);
183
- }
184
-
185
- run();
186
- ```
187
-
188
- ### Standalone function
189
-
190
- The standalone function version of this method:
191
-
192
- ```typescript
193
- import { SyllableSDKCore } from "syllable-sdk/core.js";
194
- import { sessionDebugGetSessionToolCallResultById } from "syllable-sdk/funcs/sessionDebugGetSessionToolCallResultById.js";
195
-
196
- // Use `SyllableSDKCore` for best tree-shaking performance.
197
- // You can create one instance of it to use across an application.
198
- const syllableSDK = new SyllableSDKCore({
199
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
200
- });
201
-
202
- async function run() {
203
- const res = await sessionDebugGetSessionToolCallResultById(syllableSDK, {
204
- sessionId: 832133,
205
- toolCallId: "<id>",
206
- });
207
- if (res.ok) {
208
- const { value: result } = res;
209
- console.log(result);
210
- } else {
211
- console.log("sessionDebugGetSessionToolCallResultById failed:", res.error);
212
- }
213
- }
214
-
215
- run();
216
- ```
217
-
218
- ### Parameters
219
-
220
- | Parameter | Type | Required | Description |
221
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
222
- | `request` | [operations.GetSessionToolCallResultByIdRequest](../../models/operations/getsessiontoolcallresultbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
223
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
224
- | `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. |
225
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
226
-
227
- ### Response
228
-
229
- **Promise\<[components.ToolResultData](../../models/components/toolresultdata.md)\>**
230
-
231
- ### Errors
232
-
233
- | Error Type | Status Code | Content Type |
234
- | -------------------------- | -------------------------- | -------------------------- |
235
- | errors.HTTPValidationError | 422 | application/json |
236
- | errors.SDKError | 4XX, 5XX | \*/\* |
package/docs/sdks/sessionlabels/README.md DELETED
@@ -1,262 +0,0 @@
1
- # SessionLabels
2
- (*sessionLabels*)
3
-
4
- ## Overview
5
-
6
- Operations related to labeling sessions with evaluations of quality and descriptions of issues the user encountered or other details. For more information, see [Console docs](https://docs.syllable.ai/workspaces/Sessions).
7
-
8
- ### Available Operations
9
-
10
- * [getById](#getbyid) - Get Label By Id
11
- * [create](#create) - Create Label
12
- * [list](#list) - Session Labels List
13
-
14
- ## getById
15
-
16
- Get Label By Id
17
-
18
- ### Example Usage
19
-
20
- <!-- UsageSnippet language="typescript" operationID="session_label_get_by_id" method="get" path="/api/v1/session_labels/{session_label_id}" -->
21
- ```typescript
22
- import { SyllableSDK } from "syllable-sdk";
23
-
24
- const syllableSDK = new SyllableSDK({
25
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
26
- });
27
-
28
- async function run() {
29
- const result = await syllableSDK.sessionLabels.getById({
30
- sessionLabelId: 491550,
31
- });
32
-
33
- console.log(result);
34
- }
35
-
36
- run();
37
- ```
38
-
39
- ### Standalone function
40
-
41
- The standalone function version of this method:
42
-
43
- ```typescript
44
- import { SyllableSDKCore } from "syllable-sdk/core.js";
45
- import { sessionLabelsGetById } from "syllable-sdk/funcs/sessionLabelsGetById.js";
46
-
47
- // Use `SyllableSDKCore` for best tree-shaking performance.
48
- // You can create one instance of it to use across an application.
49
- const syllableSDK = new SyllableSDKCore({
50
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
51
- });
52
-
53
- async function run() {
54
- const res = await sessionLabelsGetById(syllableSDK, {
55
- sessionLabelId: 491550,
56
- });
57
- if (res.ok) {
58
- const { value: result } = res;
59
- console.log(result);
60
- } else {
61
- console.log("sessionLabelsGetById failed:", res.error);
62
- }
63
- }
64
-
65
- run();
66
- ```
67
-
68
- ### Parameters
69
-
70
- | Parameter | Type | Required | Description |
71
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
72
- | `request` | [operations.SessionLabelGetByIdRequest](../../models/operations/sessionlabelgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
73
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
74
- | `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. |
75
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
76
-
77
- ### Response
78
-
79
- **Promise\<[components.SessionLabel](../../models/components/sessionlabel.md)\>**
80
-
81
- ### Errors
82
-
83
- | Error Type | Status Code | Content Type |
84
- | -------------------------- | -------------------------- | -------------------------- |
85
- | errors.HTTPValidationError | 422 | application/json |
86
- | errors.SDKError | 4XX, 5XX | \*/\* |
87
-
88
- ## create
89
-
90
- Create a new label
91
-
92
- ### Example Usage
93
-
94
- <!-- UsageSnippet language="typescript" operationID="session_label_create" method="post" path="/api/v1/session_labels/" -->
95
- ```typescript
96
- import { SyllableSDK } from "syllable-sdk";
97
-
98
- const syllableSDK = new SyllableSDK({
99
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
100
- });
101
-
102
- async function run() {
103
- const result = await syllableSDK.sessionLabels.create({
104
- sessionId: 1,
105
- type: "auto-rating",
106
- code: "GOOD",
107
- userEmail: "user@email.com",
108
- issueCategories: [
109
- "Silent treatment",
110
- ],
111
- });
112
-
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 { sessionLabelsCreate } from "syllable-sdk/funcs/sessionLabelsCreate.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 sessionLabelsCreate(syllableSDK, {
135
- sessionId: 1,
136
- type: "auto-rating",
137
- code: "GOOD",
138
- userEmail: "user@email.com",
139
- issueCategories: [
140
- "Silent treatment",
141
- ],
142
- });
143
- if (res.ok) {
144
- const { value: result } = res;
145
- console.log(result);
146
- } else {
147
- console.log("sessionLabelsCreate failed:", res.error);
148
- }
149
- }
150
-
151
- run();
152
- ```
153
-
154
- ### Parameters
155
-
156
- | Parameter | Type | Required | Description |
157
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
- | `request` | [components.SessionLabelCreate](../../models/components/sessionlabelcreate.md) | :heavy_check_mark: | The request object to use for the request. |
159
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
- | `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. |
161
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
-
163
- ### Response
164
-
165
- **Promise\<[components.SessionLabel](../../models/components/sessionlabel.md)\>**
166
-
167
- ### Errors
168
-
169
- | Error Type | Status Code | Content Type |
170
- | -------------------------- | -------------------------- | -------------------------- |
171
- | errors.HTTPValidationError | 422 | application/json |
172
- | errors.SDKError | 4XX, 5XX | \*/\* |
173
-
174
- ## list
175
-
176
- Session Labels List
177
-
178
- ### Example Usage
179
-
180
- <!-- UsageSnippet language="typescript" operationID="session_labels_list" method="get" path="/api/v1/session_labels/" -->
181
- ```typescript
182
- import { SyllableSDK } from "syllable-sdk";
183
-
184
- const syllableSDK = new SyllableSDK({
185
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
186
- });
187
-
188
- async function run() {
189
- const result = await syllableSDK.sessionLabels.list({
190
- page: 0,
191
- searchFields: [
192
- "code",
193
- ],
194
- searchFieldValues: [
195
- "Some Object Name",
196
- ],
197
- startDatetime: "2023-01-01T00:00:00Z",
198
- endDatetime: "2024-01-01T00:00:00Z",
199
- });
200
-
201
- console.log(result);
202
- }
203
-
204
- run();
205
- ```
206
-
207
- ### Standalone function
208
-
209
- The standalone function version of this method:
210
-
211
- ```typescript
212
- import { SyllableSDKCore } from "syllable-sdk/core.js";
213
- import { sessionLabelsList } from "syllable-sdk/funcs/sessionLabelsList.js";
214
-
215
- // Use `SyllableSDKCore` for best tree-shaking performance.
216
- // You can create one instance of it to use across an application.
217
- const syllableSDK = new SyllableSDKCore({
218
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
219
- });
220
-
221
- async function run() {
222
- const res = await sessionLabelsList(syllableSDK, {
223
- page: 0,
224
- searchFields: [
225
- "code",
226
- ],
227
- searchFieldValues: [
228
- "Some Object Name",
229
- ],
230
- startDatetime: "2023-01-01T00:00:00Z",
231
- endDatetime: "2024-01-01T00:00:00Z",
232
- });
233
- if (res.ok) {
234
- const { value: result } = res;
235
- console.log(result);
236
- } else {
237
- console.log("sessionLabelsList failed:", res.error);
238
- }
239
- }
240
-
241
- run();
242
- ```
243
-
244
- ### Parameters
245
-
246
- | Parameter | Type | Required | Description |
247
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
- | `request` | [operations.SessionLabelsListRequest](../../models/operations/sessionlabelslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
249
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
- | `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. |
251
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
-
253
- ### Response
254
-
255
- **Promise\<[components.ListResponseSessionLabel](../../models/components/listresponsesessionlabel.md)\>**
256
-
257
- ### Errors
258
-
259
- | Error Type | Status Code | Content Type |
260
- | -------------------------- | -------------------------- | -------------------------- |
261
- | errors.HTTPValidationError | 422 | application/json |
262
- | errors.SDKError | 4XX, 5XX | \*/\* |