syllable-sdk 1.0.7 → 1.0.8-rc.2

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 (92) hide show
  1. package/bin/mcp-server.js +54 -17
  2. package/bin/mcp-server.js.map +11 -10
  3. package/examples/package-lock.json +1 -1
  4. package/funcs/directoryUpdate.js +3 -1
  5. package/funcs/directoryUpdate.js.map +1 -1
  6. package/jsr.json +1 -1
  7. package/lib/config.d.ts +3 -3
  8. package/lib/config.js +3 -3
  9. package/lib/config.js.map +1 -1
  10. package/mcp-server/mcp-server.js +1 -1
  11. package/mcp-server/mcp-server.js.map +1 -1
  12. package/mcp-server/server.js +1 -1
  13. package/mcp-server/server.js.map +1 -1
  14. package/models/components/directorymember.d.ts +4 -4
  15. package/models/components/directorymember.d.ts.map +1 -1
  16. package/models/components/directorymember.js +4 -4
  17. package/models/components/directorymember.js.map +1 -1
  18. package/models/components/directorymemberupdate.d.ts +60 -0
  19. package/models/components/directorymemberupdate.d.ts.map +1 -0
  20. package/models/components/directorymemberupdate.js +87 -0
  21. package/models/components/directorymemberupdate.js.map +1 -0
  22. package/models/components/index.d.ts +1 -0
  23. package/models/components/index.d.ts.map +1 -1
  24. package/models/components/index.js +1 -0
  25. package/models/components/index.js.map +1 -1
  26. package/models/operations/directorymemberupdate.d.ts +2 -2
  27. package/models/operations/directorymemberupdate.d.ts.map +1 -1
  28. package/models/operations/directorymemberupdate.js +4 -4
  29. package/models/operations/directorymemberupdate.js.map +1 -1
  30. package/openapi.json +136 -52
  31. package/package.json +1 -1
  32. package/src/funcs/directoryUpdate.ts +3 -1
  33. package/src/lib/config.ts +3 -3
  34. package/src/mcp-server/mcp-server.ts +1 -1
  35. package/src/mcp-server/server.ts +1 -1
  36. package/src/models/components/directorymember.ts +8 -10
  37. package/src/models/components/directorymemberupdate.ts +115 -0
  38. package/src/models/components/index.ts +1 -0
  39. package/src/models/operations/directorymemberupdate.ts +6 -6
  40. package/.devcontainer/README.md +0 -35
  41. package/api-reference/sdks/agents/README.md +0 -224
  42. package/api-reference/sdks/availabletargets/README.md +0 -49
  43. package/api-reference/sdks/channels/README.md +0 -92
  44. package/api-reference/sdks/chats/README.md +0 -55
  45. package/api-reference/sdks/conversations/README.md +0 -91
  46. package/api-reference/sdks/dashboards/README.md +0 -321
  47. package/api-reference/sdks/events/README.md +0 -50
  48. package/api-reference/sdks/greetings/README.md +0 -223
  49. package/api-reference/sdks/organizations/README.md +0 -48
  50. package/api-reference/sdks/prompts/README.md +0 -225
  51. package/api-reference/sdks/sessions/README.md +0 -50
  52. package/api-reference/sdks/syllable/README.md +0 -22
  53. package/api-reference/sdks/targets/README.md +0 -194
  54. package/api-reference/sdks/tools/README.md +0 -92
  55. package/docs/sdks/agents/README.md +0 -589
  56. package/docs/sdks/batches/README.md +0 -742
  57. package/docs/sdks/campaigns/README.md +0 -526
  58. package/docs/sdks/channels/README.md +0 -401
  59. package/docs/sdks/conversations/README.md +0 -100
  60. package/docs/sdks/custommessages/README.md +0 -496
  61. package/docs/sdks/dashboards/README.md +0 -481
  62. package/docs/sdks/datasources/README.md +0 -458
  63. package/docs/sdks/directory/README.md +0 -731
  64. package/docs/sdks/events/README.md +0 -100
  65. package/docs/sdks/folders/README.md +0 -675
  66. package/docs/sdks/fullsummary/README.md +0 -82
  67. package/docs/sdks/incidents/README.md +0 -501
  68. package/docs/sdks/insights/README.md +0 -100
  69. package/docs/sdks/languagegroups/README.md +0 -565
  70. package/docs/sdks/latency/README.md +0 -82
  71. package/docs/sdks/numbers/README.md +0 -250
  72. package/docs/sdks/organizations/README.md +0 -317
  73. package/docs/sdks/permissions/README.md +0 -78
  74. package/docs/sdks/prompts/README.md +0 -592
  75. package/docs/sdks/pronunciations/README.md +0 -360
  76. package/docs/sdks/roles/README.md +0 -430
  77. package/docs/sdks/services/README.md +0 -430
  78. package/docs/sdks/sessiondebug/README.md +0 -236
  79. package/docs/sdks/sessionlabels/README.md +0 -262
  80. package/docs/sdks/sessions/README.md +0 -325
  81. package/docs/sdks/syllablesdktools/README.md +0 -578
  82. package/docs/sdks/takeouts/README.md +0 -228
  83. package/docs/sdks/targets/README.md +0 -454
  84. package/docs/sdks/test/README.md +0 -92
  85. package/docs/sdks/tools/README.md +0 -518
  86. package/docs/sdks/transcript/README.md +0 -82
  87. package/docs/sdks/twilio/README.md +0 -246
  88. package/docs/sdks/users/README.md +0 -561
  89. package/docs/sdks/v1/README.md +0 -561
  90. package/docs/sdks/voicegroups/README.md +0 -551
  91. package/docs/sdks/workflows/README.md +0 -781
  92. package/examples/README.md +0 -31
package/docs/sdks/campaigns/README.md DELETED
@@ -1,526 +0,0 @@
1
- # Campaigns
2
- (*outbound.campaigns*)
3
-
4
- ## Overview
5
-
6
- Operations related to outbound message campaigns
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - List Outbound Communication Campaigns
11
- * [create](#create) - Create Outbound Communication Campaign
12
- * [getById](#getbyid) - Get Outbound Communication Campaign
13
- * [update](#update) - Update Outbound Communication Campaign
14
- * [delete](#delete) - Delete Outbound Communication Campaign
15
-
16
- ## list
17
-
18
- List Outbound Communication Campaigns
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="outbound_campaign_list" method="get" path="/api/v1/outbound/campaigns" -->
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.outbound.campaigns.list({
32
- page: 0,
33
- searchFields: [
34
- "id",
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 { outboundCampaignsList } from "syllable-sdk/funcs/outboundCampaignsList.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 outboundCampaignsList(syllableSDK, {
65
- page: 0,
66
- searchFields: [
67
- "id",
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("outboundCampaignsList failed:", res.error);
80
- }
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Parameters
87
-
88
- | Parameter | Type | Required | Description |
89
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
- | `request` | [operations.OutboundCampaignListRequest](../../models/operations/outboundcampaignlistrequest.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.ListResponseOutboundCampaign](../../models/components/listresponseoutboundcampaign.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 Outbound Communication Campaign
109
-
110
- ### Example Usage
111
-
112
- <!-- UsageSnippet language="typescript" operationID="outbound_campaign_create" method="post" path="/api/v1/outbound/campaigns" -->
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.outbound.campaigns.create({
122
- campaignName: "Outbound Campaign 1",
123
- description: "This is a test campaign",
124
- mode: "voice",
125
- smsSessionTtl: 720,
126
- labels: [
127
- "test",
128
- "demo",
129
- ],
130
- campaignVariables: {
131
- "key": "value",
132
- "key2": "value2",
133
- },
134
- dailyStartTime: "09:00:00",
135
- dailyEndTime: "17:00:00",
136
- source: "+19032900844",
137
- callerId: "19995551234",
138
- hourlyRate: 25,
139
- retryCount: 1,
140
- retryInterval: "30m",
141
- activeDays: [
142
- "mon",
143
- "tue",
144
- "wed",
145
- "thu",
146
- "fri",
147
- ],
148
- voicemailDetection: {
149
- "voicemail_detection_overall_timeout": 30,
150
- "voicemail_detection_post_speech_timeout": 1.75,
151
- "voicemail_detection_pre_speech_timeout": 3.5,
152
- },
153
- });
154
-
155
- console.log(result);
156
- }
157
-
158
- run();
159
- ```
160
-
161
- ### Standalone function
162
-
163
- The standalone function version of this method:
164
-
165
- ```typescript
166
- import { SyllableSDKCore } from "syllable-sdk/core.js";
167
- import { outboundCampaignsCreate } from "syllable-sdk/funcs/outboundCampaignsCreate.js";
168
-
169
- // Use `SyllableSDKCore` for best tree-shaking performance.
170
- // You can create one instance of it to use across an application.
171
- const syllableSDK = new SyllableSDKCore({
172
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
173
- });
174
-
175
- async function run() {
176
- const res = await outboundCampaignsCreate(syllableSDK, {
177
- campaignName: "Outbound Campaign 1",
178
- description: "This is a test campaign",
179
- mode: "voice",
180
- smsSessionTtl: 720,
181
- labels: [
182
- "test",
183
- "demo",
184
- ],
185
- campaignVariables: {
186
- "key": "value",
187
- "key2": "value2",
188
- },
189
- dailyStartTime: "09:00:00",
190
- dailyEndTime: "17:00:00",
191
- source: "+19032900844",
192
- callerId: "19995551234",
193
- hourlyRate: 25,
194
- retryCount: 1,
195
- retryInterval: "30m",
196
- activeDays: [
197
- "mon",
198
- "tue",
199
- "wed",
200
- "thu",
201
- "fri",
202
- ],
203
- voicemailDetection: {
204
- "voicemail_detection_overall_timeout": 30,
205
- "voicemail_detection_post_speech_timeout": 1.75,
206
- "voicemail_detection_pre_speech_timeout": 3.5,
207
- },
208
- });
209
- if (res.ok) {
210
- const { value: result } = res;
211
- console.log(result);
212
- } else {
213
- console.log("outboundCampaignsCreate failed:", res.error);
214
- }
215
- }
216
-
217
- run();
218
- ```
219
-
220
- ### Parameters
221
-
222
- | Parameter | Type | Required | Description |
223
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
224
- | `request` | [components.OutboundCampaignInput](../../models/components/outboundcampaigninput.md) | :heavy_check_mark: | The request object to use for the request. |
225
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
226
- | `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. |
227
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
228
-
229
- ### Response
230
-
231
- **Promise\<[components.OutboundCampaign](../../models/components/outboundcampaign.md)\>**
232
-
233
- ### Errors
234
-
235
- | Error Type | Status Code | Content Type |
236
- | -------------------------- | -------------------------- | -------------------------- |
237
- | errors.HTTPValidationError | 422 | application/json |
238
- | errors.SDKError | 4XX, 5XX | \*/\* |
239
-
240
- ## getById
241
-
242
- Get Outbound Communication Campaign
243
-
244
- ### Example Usage
245
-
246
- <!-- UsageSnippet language="typescript" operationID="outbound_campaign_get_by_id" method="get" path="/api/v1/outbound/campaigns/{campaign_id}" -->
247
- ```typescript
248
- import { SyllableSDK } from "syllable-sdk";
249
-
250
- const syllableSDK = new SyllableSDK({
251
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
252
- });
253
-
254
- async function run() {
255
- const result = await syllableSDK.outbound.campaigns.getById({
256
- campaignId: 11227,
257
- });
258
-
259
- console.log(result);
260
- }
261
-
262
- run();
263
- ```
264
-
265
- ### Standalone function
266
-
267
- The standalone function version of this method:
268
-
269
- ```typescript
270
- import { SyllableSDKCore } from "syllable-sdk/core.js";
271
- import { outboundCampaignsGetById } from "syllable-sdk/funcs/outboundCampaignsGetById.js";
272
-
273
- // Use `SyllableSDKCore` for best tree-shaking performance.
274
- // You can create one instance of it to use across an application.
275
- const syllableSDK = new SyllableSDKCore({
276
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
277
- });
278
-
279
- async function run() {
280
- const res = await outboundCampaignsGetById(syllableSDK, {
281
- campaignId: 11227,
282
- });
283
- if (res.ok) {
284
- const { value: result } = res;
285
- console.log(result);
286
- } else {
287
- console.log("outboundCampaignsGetById failed:", res.error);
288
- }
289
- }
290
-
291
- run();
292
- ```
293
-
294
- ### Parameters
295
-
296
- | Parameter | Type | Required | Description |
297
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
298
- | `request` | [operations.OutboundCampaignGetByIdRequest](../../models/operations/outboundcampaigngetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
299
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
300
- | `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. |
301
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
302
-
303
- ### Response
304
-
305
- **Promise\<[components.OutboundCampaign](../../models/components/outboundcampaign.md)\>**
306
-
307
- ### Errors
308
-
309
- | Error Type | Status Code | Content Type |
310
- | -------------------------- | -------------------------- | -------------------------- |
311
- | errors.HTTPValidationError | 422 | application/json |
312
- | errors.SDKError | 4XX, 5XX | \*/\* |
313
-
314
- ## update
315
-
316
- Update Outbound Communication Campaign
317
-
318
- ### Example Usage
319
-
320
- <!-- UsageSnippet language="typescript" operationID="outbound_campaign_update" method="put" path="/api/v1/outbound/campaigns/{campaign_id}" -->
321
- ```typescript
322
- import { SyllableSDK } from "syllable-sdk";
323
-
324
- const syllableSDK = new SyllableSDK({
325
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
326
- });
327
-
328
- async function run() {
329
- const result = await syllableSDK.outbound.campaigns.update({
330
- campaignId: 679645,
331
- outboundCampaignInput: {
332
- campaignName: "Outbound Campaign 1",
333
- description: "This is a test campaign",
334
- mode: "voice",
335
- smsSessionTtl: 720,
336
- labels: [
337
- "test",
338
- "demo",
339
- ],
340
- campaignVariables: {
341
- "key": "value",
342
- "key2": "value2",
343
- },
344
- dailyStartTime: "09:00:00",
345
- dailyEndTime: "17:00:00",
346
- source: "+19032900844",
347
- callerId: "19995551234",
348
- hourlyRate: 25,
349
- retryCount: 1,
350
- retryInterval: "30m",
351
- activeDays: [
352
- "mon",
353
- "tue",
354
- "wed",
355
- "thu",
356
- "fri",
357
- ],
358
- voicemailDetection: {
359
- "voicemail_detection_overall_timeout": 30,
360
- "voicemail_detection_post_speech_timeout": 1.75,
361
- "voicemail_detection_pre_speech_timeout": 3.5,
362
- },
363
- },
364
- });
365
-
366
- console.log(result);
367
- }
368
-
369
- run();
370
- ```
371
-
372
- ### Standalone function
373
-
374
- The standalone function version of this method:
375
-
376
- ```typescript
377
- import { SyllableSDKCore } from "syllable-sdk/core.js";
378
- import { outboundCampaignsUpdate } from "syllable-sdk/funcs/outboundCampaignsUpdate.js";
379
-
380
- // Use `SyllableSDKCore` for best tree-shaking performance.
381
- // You can create one instance of it to use across an application.
382
- const syllableSDK = new SyllableSDKCore({
383
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
384
- });
385
-
386
- async function run() {
387
- const res = await outboundCampaignsUpdate(syllableSDK, {
388
- campaignId: 679645,
389
- outboundCampaignInput: {
390
- campaignName: "Outbound Campaign 1",
391
- description: "This is a test campaign",
392
- mode: "voice",
393
- smsSessionTtl: 720,
394
- labels: [
395
- "test",
396
- "demo",
397
- ],
398
- campaignVariables: {
399
- "key": "value",
400
- "key2": "value2",
401
- },
402
- dailyStartTime: "09:00:00",
403
- dailyEndTime: "17:00:00",
404
- source: "+19032900844",
405
- callerId: "19995551234",
406
- hourlyRate: 25,
407
- retryCount: 1,
408
- retryInterval: "30m",
409
- activeDays: [
410
- "mon",
411
- "tue",
412
- "wed",
413
- "thu",
414
- "fri",
415
- ],
416
- voicemailDetection: {
417
- "voicemail_detection_overall_timeout": 30,
418
- "voicemail_detection_post_speech_timeout": 1.75,
419
- "voicemail_detection_pre_speech_timeout": 3.5,
420
- },
421
- },
422
- });
423
- if (res.ok) {
424
- const { value: result } = res;
425
- console.log(result);
426
- } else {
427
- console.log("outboundCampaignsUpdate failed:", res.error);
428
- }
429
- }
430
-
431
- run();
432
- ```
433
-
434
- ### Parameters
435
-
436
- | Parameter | Type | Required | Description |
437
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
438
- | `request` | [operations.OutboundCampaignUpdateRequest](../../models/operations/outboundcampaignupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
439
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
440
- | `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. |
441
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
442
-
443
- ### Response
444
-
445
- **Promise\<[components.OutboundCampaign](../../models/components/outboundcampaign.md)\>**
446
-
447
- ### Errors
448
-
449
- | Error Type | Status Code | Content Type |
450
- | -------------------------- | -------------------------- | -------------------------- |
451
- | errors.HTTPValidationError | 422 | application/json |
452
- | errors.SDKError | 4XX, 5XX | \*/\* |
453
-
454
- ## delete
455
-
456
- Delete Outbound Communication Campaign
457
-
458
- ### Example Usage
459
-
460
- <!-- UsageSnippet language="typescript" operationID="outbound_campaign_delete" method="delete" path="/api/v1/outbound/campaigns/{campaign_id}" -->
461
- ```typescript
462
- import { SyllableSDK } from "syllable-sdk";
463
-
464
- const syllableSDK = new SyllableSDK({
465
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
466
- });
467
-
468
- async function run() {
469
- const result = await syllableSDK.outbound.campaigns.delete({
470
- campaignId: 439537,
471
- });
472
-
473
- console.log(result);
474
- }
475
-
476
- run();
477
- ```
478
-
479
- ### Standalone function
480
-
481
- The standalone function version of this method:
482
-
483
- ```typescript
484
- import { SyllableSDKCore } from "syllable-sdk/core.js";
485
- import { outboundCampaignsDelete } from "syllable-sdk/funcs/outboundCampaignsDelete.js";
486
-
487
- // Use `SyllableSDKCore` for best tree-shaking performance.
488
- // You can create one instance of it to use across an application.
489
- const syllableSDK = new SyllableSDKCore({
490
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
491
- });
492
-
493
- async function run() {
494
- const res = await outboundCampaignsDelete(syllableSDK, {
495
- campaignId: 439537,
496
- });
497
- if (res.ok) {
498
- const { value: result } = res;
499
- console.log(result);
500
- } else {
501
- console.log("outboundCampaignsDelete failed:", res.error);
502
- }
503
- }
504
-
505
- run();
506
- ```
507
-
508
- ### Parameters
509
-
510
- | Parameter | Type | Required | Description |
511
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
512
- | `request` | [operations.OutboundCampaignDeleteRequest](../../models/operations/outboundcampaigndeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
513
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
514
- | `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. |
515
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
516
-
517
- ### Response
518
-
519
- **Promise\<[any](../../models/.md)\>**
520
-
521
- ### Errors
522
-
523
- | Error Type | Status Code | Content Type |
524
- | -------------------------- | -------------------------- | -------------------------- |
525
- | errors.HTTPValidationError | 422 | application/json |
526
- | errors.SDKError | 4XX, 5XX | \*/\* |