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/custommessages/README.md DELETED
@@ -1,496 +0,0 @@
1
- # CustomMessages
2
- (*customMessages*)
3
-
4
- ## Overview
5
-
6
- Operations related to custom message configuration. A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week. For more information, see [Console docs](https://docs.syllable.ai/Resources/Messages).
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Custom Messages List
11
- * [create](#create) - Create Custom Message
12
- * [update](#update) - Update Custom Message
13
- * [getById](#getbyid) - Get Custom Message By Id
14
- * [delete](#delete) - Delete Custom Message
15
-
16
- ## list
17
-
18
- List the existing custom_messages
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="custom_messages_list" method="get" path="/api/v1/custom_messages/" -->
23
- ```typescript
24
- import { SyllableSDK } from "syllable-sdk";
25
-
26
- const syllableSDK = new SyllableSDK({
27
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
28
- });
29
-
30
- async function run() {
31
- const result = await syllableSDK.customMessages.list({
32
- page: 0,
33
- searchFields: [
34
- "name",
35
- ],
36
- searchFieldValues: [
37
- "Some Object Name",
38
- ],
39
- startDatetime: "2023-01-01T00:00:00Z",
40
- endDatetime: "2024-01-01T00:00:00Z",
41
- });
42
-
43
- console.log(result);
44
- }
45
-
46
- run();
47
- ```
48
-
49
- ### Standalone function
50
-
51
- The standalone function version of this method:
52
-
53
- ```typescript
54
- import { SyllableSDKCore } from "syllable-sdk/core.js";
55
- import { customMessagesList } from "syllable-sdk/funcs/customMessagesList.js";
56
-
57
- // Use `SyllableSDKCore` for best tree-shaking performance.
58
- // You can create one instance of it to use across an application.
59
- const syllableSDK = new SyllableSDKCore({
60
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
61
- });
62
-
63
- async function run() {
64
- const res = await customMessagesList(syllableSDK, {
65
- page: 0,
66
- searchFields: [
67
- "name",
68
- ],
69
- searchFieldValues: [
70
- "Some Object Name",
71
- ],
72
- startDatetime: "2023-01-01T00:00:00Z",
73
- endDatetime: "2024-01-01T00:00:00Z",
74
- });
75
- if (res.ok) {
76
- const { value: result } = res;
77
- console.log(result);
78
- } else {
79
- console.log("customMessagesList failed:", res.error);
80
- }
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Parameters
87
-
88
- | Parameter | Type | Required | Description |
89
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
- | `request` | [operations.CustomMessagesListRequest](../../models/operations/custommessageslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
91
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
92
- | `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. |
93
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
94
-
95
- ### Response
96
-
97
- **Promise\<[components.ListResponseCustomMessageResponse](../../models/components/listresponsecustommessageresponse.md)\>**
98
-
99
- ### Errors
100
-
101
- | Error Type | Status Code | Content Type |
102
- | -------------------------- | -------------------------- | -------------------------- |
103
- | errors.HTTPValidationError | 422 | application/json |
104
- | errors.SDKError | 4XX, 5XX | \*/\* |
105
-
106
- ## create
107
-
108
- Create a new custom message
109
-
110
- ### Example Usage
111
-
112
- <!-- UsageSnippet language="typescript" operationID="custom_messages_create" method="post" path="/api/v1/custom_messages/" -->
113
- ```typescript
114
- import { SyllableSDK } from "syllable-sdk";
115
-
116
- const syllableSDK = new SyllableSDK({
117
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
118
- });
119
-
120
- async function run() {
121
- const result = await syllableSDK.customMessages.create({
122
- name: "Customer service greeting",
123
- text: "Hello and thank you for calling customer service. How can I help you today?",
124
- label: "Customer service",
125
- rules: [
126
- {
127
- description: "Closed on New Year's Day",
128
- timeRangeStart: "09:00",
129
- timeRangeEnd: "17:00",
130
- date: "2025-01-01",
131
- invert: false,
132
- text: "Hello, thank you for calling. Sorry, we're closed today.",
133
- },
134
- {
135
- description: "Closed on weekends",
136
- timeRangeStart: "09:00",
137
- timeRangeEnd: "17:00",
138
- daysOfWeek: [
139
- "sa",
140
- "su",
141
- ],
142
- invert: false,
143
- text: "Hello, thank you for calling. Sorry, we're closed on weekends.",
144
- },
145
- ],
146
- });
147
-
148
- console.log(result);
149
- }
150
-
151
- run();
152
- ```
153
-
154
- ### Standalone function
155
-
156
- The standalone function version of this method:
157
-
158
- ```typescript
159
- import { SyllableSDKCore } from "syllable-sdk/core.js";
160
- import { customMessagesCreate } from "syllable-sdk/funcs/customMessagesCreate.js";
161
-
162
- // Use `SyllableSDKCore` for best tree-shaking performance.
163
- // You can create one instance of it to use across an application.
164
- const syllableSDK = new SyllableSDKCore({
165
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
166
- });
167
-
168
- async function run() {
169
- const res = await customMessagesCreate(syllableSDK, {
170
- name: "Customer service greeting",
171
- text: "Hello and thank you for calling customer service. How can I help you today?",
172
- label: "Customer service",
173
- rules: [
174
- {
175
- description: "Closed on New Year's Day",
176
- timeRangeStart: "09:00",
177
- timeRangeEnd: "17:00",
178
- date: "2025-01-01",
179
- invert: false,
180
- text: "Hello, thank you for calling. Sorry, we're closed today.",
181
- },
182
- {
183
- description: "Closed on weekends",
184
- timeRangeStart: "09:00",
185
- timeRangeEnd: "17:00",
186
- daysOfWeek: [
187
- "sa",
188
- "su",
189
- ],
190
- invert: false,
191
- text: "Hello, thank you for calling. Sorry, we're closed on weekends.",
192
- },
193
- ],
194
- });
195
- if (res.ok) {
196
- const { value: result } = res;
197
- console.log(result);
198
- } else {
199
- console.log("customMessagesCreate failed:", res.error);
200
- }
201
- }
202
-
203
- run();
204
- ```
205
-
206
- ### Parameters
207
-
208
- | Parameter | Type | Required | Description |
209
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
210
- | `request` | [components.CustomMessageCreateRequest](../../models/components/custommessagecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
211
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
212
- | `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. |
213
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
214
-
215
- ### Response
216
-
217
- **Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
218
-
219
- ### Errors
220
-
221
- | Error Type | Status Code | Content Type |
222
- | -------------------------- | -------------------------- | -------------------------- |
223
- | errors.HTTPValidationError | 422 | application/json |
224
- | errors.SDKError | 4XX, 5XX | \*/\* |
225
-
226
- ## update
227
-
228
- Update a custom message
229
-
230
- ### Example Usage
231
-
232
- <!-- UsageSnippet language="typescript" operationID="custom_messages_update" method="put" path="/api/v1/custom_messages/" -->
233
- ```typescript
234
- import { SyllableSDK } from "syllable-sdk";
235
-
236
- const syllableSDK = new SyllableSDK({
237
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
238
- });
239
-
240
- async function run() {
241
- const result = await syllableSDK.customMessages.update({
242
- name: "Customer service greeting",
243
- text: "Hello and thank you for calling customer service. How can I help you today?",
244
- label: "Customer service",
245
- rules: [
246
- {
247
- description: "Closed on New Year's Day",
248
- timeRangeStart: "09:00",
249
- timeRangeEnd: "17:00",
250
- date: "2025-01-01",
251
- invert: false,
252
- text: "Hello, thank you for calling. Sorry, we're closed today.",
253
- },
254
- {
255
- description: "Closed on weekends",
256
- timeRangeStart: "09:00",
257
- timeRangeEnd: "17:00",
258
- daysOfWeek: [
259
- "sa",
260
- "su",
261
- ],
262
- invert: false,
263
- text: "Hello, thank you for calling. Sorry, we're closed on weekends.",
264
- },
265
- ],
266
- id: 1,
267
- });
268
-
269
- console.log(result);
270
- }
271
-
272
- run();
273
- ```
274
-
275
- ### Standalone function
276
-
277
- The standalone function version of this method:
278
-
279
- ```typescript
280
- import { SyllableSDKCore } from "syllable-sdk/core.js";
281
- import { customMessagesUpdate } from "syllable-sdk/funcs/customMessagesUpdate.js";
282
-
283
- // Use `SyllableSDKCore` for best tree-shaking performance.
284
- // You can create one instance of it to use across an application.
285
- const syllableSDK = new SyllableSDKCore({
286
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
287
- });
288
-
289
- async function run() {
290
- const res = await customMessagesUpdate(syllableSDK, {
291
- name: "Customer service greeting",
292
- text: "Hello and thank you for calling customer service. How can I help you today?",
293
- label: "Customer service",
294
- rules: [
295
- {
296
- description: "Closed on New Year's Day",
297
- timeRangeStart: "09:00",
298
- timeRangeEnd: "17:00",
299
- date: "2025-01-01",
300
- invert: false,
301
- text: "Hello, thank you for calling. Sorry, we're closed today.",
302
- },
303
- {
304
- description: "Closed on weekends",
305
- timeRangeStart: "09:00",
306
- timeRangeEnd: "17:00",
307
- daysOfWeek: [
308
- "sa",
309
- "su",
310
- ],
311
- invert: false,
312
- text: "Hello, thank you for calling. Sorry, we're closed on weekends.",
313
- },
314
- ],
315
- id: 1,
316
- });
317
- if (res.ok) {
318
- const { value: result } = res;
319
- console.log(result);
320
- } else {
321
- console.log("customMessagesUpdate failed:", res.error);
322
- }
323
- }
324
-
325
- run();
326
- ```
327
-
328
- ### Parameters
329
-
330
- | Parameter | Type | Required | Description |
331
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
332
- | `request` | [components.CustomMessageUpdateRequest](../../models/components/custommessageupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
333
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
334
- | `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. |
335
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
336
-
337
- ### Response
338
-
339
- **Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
340
-
341
- ### Errors
342
-
343
- | Error Type | Status Code | Content Type |
344
- | -------------------------- | -------------------------- | -------------------------- |
345
- | errors.HTTPValidationError | 422 | application/json |
346
- | errors.SDKError | 4XX, 5XX | \*/\* |
347
-
348
- ## getById
349
-
350
- Get the custom message by its ID
351
-
352
- ### Example Usage
353
-
354
- <!-- UsageSnippet language="typescript" operationID="custom_message_get_by_id" method="get" path="/api/v1/custom_messages/{custom_message_id}" -->
355
- ```typescript
356
- import { SyllableSDK } from "syllable-sdk";
357
-
358
- const syllableSDK = new SyllableSDK({
359
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
360
- });
361
-
362
- async function run() {
363
- const result = await syllableSDK.customMessages.getById({
364
- customMessageId: 909433,
365
- });
366
-
367
- console.log(result);
368
- }
369
-
370
- run();
371
- ```
372
-
373
- ### Standalone function
374
-
375
- The standalone function version of this method:
376
-
377
- ```typescript
378
- import { SyllableSDKCore } from "syllable-sdk/core.js";
379
- import { customMessagesGetById } from "syllable-sdk/funcs/customMessagesGetById.js";
380
-
381
- // Use `SyllableSDKCore` for best tree-shaking performance.
382
- // You can create one instance of it to use across an application.
383
- const syllableSDK = new SyllableSDKCore({
384
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
385
- });
386
-
387
- async function run() {
388
- const res = await customMessagesGetById(syllableSDK, {
389
- customMessageId: 909433,
390
- });
391
- if (res.ok) {
392
- const { value: result } = res;
393
- console.log(result);
394
- } else {
395
- console.log("customMessagesGetById failed:", res.error);
396
- }
397
- }
398
-
399
- run();
400
- ```
401
-
402
- ### Parameters
403
-
404
- | Parameter | Type | Required | Description |
405
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
406
- | `request` | [operations.CustomMessageGetByIdRequest](../../models/operations/custommessagegetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
407
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
408
- | `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. |
409
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
410
-
411
- ### Response
412
-
413
- **Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
414
-
415
- ### Errors
416
-
417
- | Error Type | Status Code | Content Type |
418
- | -------------------------- | -------------------------- | -------------------------- |
419
- | errors.HTTPValidationError | 422 | application/json |
420
- | errors.SDKError | 4XX, 5XX | \*/\* |
421
-
422
- ## delete
423
-
424
- Delete custom message by ID
425
-
426
- ### Example Usage
427
-
428
- <!-- UsageSnippet language="typescript" operationID="custom_messages_delete" method="delete" path="/api/v1/custom_messages/{custom_message_id}" -->
429
- ```typescript
430
- import { SyllableSDK } from "syllable-sdk";
431
-
432
- const syllableSDK = new SyllableSDK({
433
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
434
- });
435
-
436
- async function run() {
437
- const result = await syllableSDK.customMessages.delete({
438
- customMessageId: 729986,
439
- reason: "<value>",
440
- });
441
-
442
- console.log(result);
443
- }
444
-
445
- run();
446
- ```
447
-
448
- ### Standalone function
449
-
450
- The standalone function version of this method:
451
-
452
- ```typescript
453
- import { SyllableSDKCore } from "syllable-sdk/core.js";
454
- import { customMessagesDelete } from "syllable-sdk/funcs/customMessagesDelete.js";
455
-
456
- // Use `SyllableSDKCore` for best tree-shaking performance.
457
- // You can create one instance of it to use across an application.
458
- const syllableSDK = new SyllableSDKCore({
459
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
460
- });
461
-
462
- async function run() {
463
- const res = await customMessagesDelete(syllableSDK, {
464
- customMessageId: 729986,
465
- reason: "<value>",
466
- });
467
- if (res.ok) {
468
- const { value: result } = res;
469
- console.log(result);
470
- } else {
471
- console.log("customMessagesDelete failed:", res.error);
472
- }
473
- }
474
-
475
- run();
476
- ```
477
-
478
- ### Parameters
479
-
480
- | Parameter | Type | Required | Description |
481
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
482
- | `request` | [operations.CustomMessagesDeleteRequest](../../models/operations/custommessagesdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
483
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
484
- | `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. |
485
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
486
-
487
- ### Response
488
-
489
- **Promise\<[any](../../models/.md)\>**
490
-
491
- ### Errors
492
-
493
- | Error Type | Status Code | Content Type |
494
- | -------------------------- | -------------------------- | -------------------------- |
495
- | errors.HTTPValidationError | 422 | application/json |
496
- | errors.SDKError | 4XX, 5XX | \*/\* |