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/directory/README.md DELETED
@@ -1,727 +0,0 @@
1
- # Directory
2
- (*directory*)
3
-
4
- ## Overview
5
-
6
- Operations related to directory
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Directory Member List
11
- * [create](#create) - Create Directory Member
12
- * [getById](#getbyid) - Get Directory Member By Id
13
- * [update](#update) - Update Directory Member
14
- * [delete](#delete) - Delete Directory Member
15
- * [directoryMemberTestExtension](#directorymembertestextension) - Test Directory Member Extension
16
- * [directoryMemberBulkLoad](#directorymemberbulkload) - Bulk Load Directory Members
17
- * [directoryMemberDownload](#directorymemberdownload) - Download Directory Members
18
-
19
- ## list
20
-
21
- List the existing directory_members
22
-
23
- ### Example Usage
24
-
25
- <!-- UsageSnippet language="typescript" operationID="directory_member_list" method="get" path="/api/v1/directory_members/" -->
26
- ```typescript
27
- import { SyllableSDK } from "syllable-sdk";
28
-
29
- const syllableSDK = new SyllableSDK({
30
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
31
- });
32
-
33
- async function run() {
34
- const result = await syllableSDK.directory.list({
35
- page: 0,
36
- searchFields: [
37
- "name",
38
- ],
39
- searchFieldValues: [
40
- "Some Object Name",
41
- ],
42
- startDatetime: "2023-01-01T00:00:00Z",
43
- endDatetime: "2024-01-01T00:00:00Z",
44
- });
45
-
46
- console.log(result);
47
- }
48
-
49
- run();
50
- ```
51
-
52
- ### Standalone function
53
-
54
- The standalone function version of this method:
55
-
56
- ```typescript
57
- import { SyllableSDKCore } from "syllable-sdk/core.js";
58
- import { directoryList } from "syllable-sdk/funcs/directoryList.js";
59
-
60
- // Use `SyllableSDKCore` for best tree-shaking performance.
61
- // You can create one instance of it to use across an application.
62
- const syllableSDK = new SyllableSDKCore({
63
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
64
- });
65
-
66
- async function run() {
67
- const res = await directoryList(syllableSDK, {
68
- page: 0,
69
- searchFields: [
70
- "name",
71
- ],
72
- searchFieldValues: [
73
- "Some Object Name",
74
- ],
75
- startDatetime: "2023-01-01T00:00:00Z",
76
- endDatetime: "2024-01-01T00:00:00Z",
77
- });
78
- if (res.ok) {
79
- const { value: result } = res;
80
- console.log(result);
81
- } else {
82
- console.log("directoryList failed:", res.error);
83
- }
84
- }
85
-
86
- run();
87
- ```
88
-
89
- ### Parameters
90
-
91
- | Parameter | Type | Required | Description |
92
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
93
- | `request` | [operations.DirectoryMemberListRequest](../../models/operations/directorymemberlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
94
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
95
- | `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. |
96
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
97
-
98
- ### Response
99
-
100
- **Promise\<[components.ListResponseDirectoryMember](../../models/components/listresponsedirectorymember.md)\>**
101
-
102
- ### Errors
103
-
104
- | Error Type | Status Code | Content Type |
105
- | -------------------------- | -------------------------- | -------------------------- |
106
- | errors.HTTPValidationError | 422 | application/json |
107
- | errors.SDKError | 4XX, 5XX | \*/\* |
108
-
109
- ## create
110
-
111
- Create a new member in the directory
112
-
113
- ### Example Usage
114
-
115
- <!-- UsageSnippet language="typescript" operationID="directory_member_create" method="post" path="/api/v1/directory_members/" -->
116
- ```typescript
117
- import { SyllableSDK } from "syllable-sdk";
118
-
119
- const syllableSDK = new SyllableSDK({
120
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
121
- });
122
-
123
- async function run() {
124
- const result = await syllableSDK.directory.create({
125
- name: "Jane Doe",
126
- type: "contact",
127
- extensions: [
128
- {
129
- name: "work",
130
- numbers: [
131
- {
132
- number: "+1234567890",
133
- rules: [
134
- {
135
- "language": "en",
136
- },
137
- ],
138
- },
139
- ],
140
- },
141
- ],
142
- contactTags: {
143
- "tag1": [
144
- "value1",
145
- ],
146
- "tag2": [
147
- "value2",
148
- ],
149
- },
150
- });
151
-
152
- console.log(result);
153
- }
154
-
155
- run();
156
- ```
157
-
158
- ### Standalone function
159
-
160
- The standalone function version of this method:
161
-
162
- ```typescript
163
- import { SyllableSDKCore } from "syllable-sdk/core.js";
164
- import { directoryCreate } from "syllable-sdk/funcs/directoryCreate.js";
165
-
166
- // Use `SyllableSDKCore` for best tree-shaking performance.
167
- // You can create one instance of it to use across an application.
168
- const syllableSDK = new SyllableSDKCore({
169
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
170
- });
171
-
172
- async function run() {
173
- const res = await directoryCreate(syllableSDK, {
174
- name: "Jane Doe",
175
- type: "contact",
176
- extensions: [
177
- {
178
- name: "work",
179
- numbers: [
180
- {
181
- number: "+1234567890",
182
- rules: [
183
- {
184
- "language": "en",
185
- },
186
- ],
187
- },
188
- ],
189
- },
190
- ],
191
- contactTags: {
192
- "tag1": [
193
- "value1",
194
- ],
195
- "tag2": [
196
- "value2",
197
- ],
198
- },
199
- });
200
- if (res.ok) {
201
- const { value: result } = res;
202
- console.log(result);
203
- } else {
204
- console.log("directoryCreate failed:", res.error);
205
- }
206
- }
207
-
208
- run();
209
- ```
210
-
211
- ### Parameters
212
-
213
- | Parameter | Type | Required | Description |
214
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
215
- | `request` | [components.DirectoryMemberCreate](../../models/components/directorymembercreate.md) | :heavy_check_mark: | The request object to use for the request. |
216
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
217
- | `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. |
218
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
219
-
220
- ### Response
221
-
222
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
223
-
224
- ### Errors
225
-
226
- | Error Type | Status Code | Content Type |
227
- | -------------------------- | -------------------------- | -------------------------- |
228
- | errors.HTTPValidationError | 422 | application/json |
229
- | errors.SDKError | 4XX, 5XX | \*/\* |
230
-
231
- ## getById
232
-
233
- Get a DirectoryMember by ID.
234
-
235
- ### Example Usage
236
-
237
- <!-- UsageSnippet language="typescript" operationID="directory_member_get_by_id" method="get" path="/api/v1/directory_members/{member_id}" -->
238
- ```typescript
239
- import { SyllableSDK } from "syllable-sdk";
240
-
241
- const syllableSDK = new SyllableSDK({
242
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
243
- });
244
-
245
- async function run() {
246
- const result = await syllableSDK.directory.getById({
247
- memberId: 562571,
248
- });
249
-
250
- console.log(result);
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Standalone function
257
-
258
- The standalone function version of this method:
259
-
260
- ```typescript
261
- import { SyllableSDKCore } from "syllable-sdk/core.js";
262
- import { directoryGetById } from "syllable-sdk/funcs/directoryGetById.js";
263
-
264
- // Use `SyllableSDKCore` for best tree-shaking performance.
265
- // You can create one instance of it to use across an application.
266
- const syllableSDK = new SyllableSDKCore({
267
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
268
- });
269
-
270
- async function run() {
271
- const res = await directoryGetById(syllableSDK, {
272
- memberId: 562571,
273
- });
274
- if (res.ok) {
275
- const { value: result } = res;
276
- console.log(result);
277
- } else {
278
- console.log("directoryGetById failed:", res.error);
279
- }
280
- }
281
-
282
- run();
283
- ```
284
-
285
- ### Parameters
286
-
287
- | Parameter | Type | Required | Description |
288
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
289
- | `request` | [operations.DirectoryMemberGetByIdRequest](../../models/operations/directorymembergetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
290
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
291
- | `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. |
292
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
293
-
294
- ### Response
295
-
296
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
297
-
298
- ### Errors
299
-
300
- | Error Type | Status Code | Content Type |
301
- | -------------------------- | -------------------------- | -------------------------- |
302
- | errors.HTTPValidationError | 422 | application/json |
303
- | errors.SDKError | 4XX, 5XX | \*/\* |
304
-
305
- ## update
306
-
307
- Update a DirectoryMember.
308
-
309
- ### Example Usage
310
-
311
- <!-- UsageSnippet language="typescript" operationID="directory_member_update" method="put" path="/api/v1/directory_members/{member_id}" -->
312
- ```typescript
313
- import { SyllableSDK } from "syllable-sdk";
314
-
315
- const syllableSDK = new SyllableSDK({
316
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
317
- });
318
-
319
- async function run() {
320
- const result = await syllableSDK.directory.update({
321
- memberId: 941217,
322
- directoryMemberUpdate: {
323
- name: "Jane Doe",
324
- type: "contact",
325
- extensions: [
326
- {
327
- name: "work",
328
- numbers: [
329
- {
330
- number: "+1234567890",
331
- rules: [
332
- {
333
- "language": "en",
334
- },
335
- ],
336
- },
337
- ],
338
- },
339
- ],
340
- contactTags: {
341
- "tag1": [
342
- "value1",
343
- ],
344
- "tag2": [
345
- "value2",
346
- ],
347
- },
348
- id: 1,
349
- },
350
- });
351
-
352
- console.log(result);
353
- }
354
-
355
- run();
356
- ```
357
-
358
- ### Standalone function
359
-
360
- The standalone function version of this method:
361
-
362
- ```typescript
363
- import { SyllableSDKCore } from "syllable-sdk/core.js";
364
- import { directoryUpdate } from "syllable-sdk/funcs/directoryUpdate.js";
365
-
366
- // Use `SyllableSDKCore` for best tree-shaking performance.
367
- // You can create one instance of it to use across an application.
368
- const syllableSDK = new SyllableSDKCore({
369
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
370
- });
371
-
372
- async function run() {
373
- const res = await directoryUpdate(syllableSDK, {
374
- memberId: 941217,
375
- directoryMemberUpdate: {
376
- name: "Jane Doe",
377
- type: "contact",
378
- extensions: [
379
- {
380
- name: "work",
381
- numbers: [
382
- {
383
- number: "+1234567890",
384
- rules: [
385
- {
386
- "language": "en",
387
- },
388
- ],
389
- },
390
- ],
391
- },
392
- ],
393
- contactTags: {
394
- "tag1": [
395
- "value1",
396
- ],
397
- "tag2": [
398
- "value2",
399
- ],
400
- },
401
- id: 1,
402
- },
403
- });
404
- if (res.ok) {
405
- const { value: result } = res;
406
- console.log(result);
407
- } else {
408
- console.log("directoryUpdate failed:", res.error);
409
- }
410
- }
411
-
412
- run();
413
- ```
414
-
415
- ### Parameters
416
-
417
- | Parameter | Type | Required | Description |
418
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
419
- | `request` | [operations.DirectoryMemberUpdateRequest](../../models/operations/directorymemberupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
420
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
421
- | `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. |
422
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
423
-
424
- ### Response
425
-
426
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
427
-
428
- ### Errors
429
-
430
- | Error Type | Status Code | Content Type |
431
- | -------------------------- | -------------------------- | -------------------------- |
432
- | errors.HTTPValidationError | 422 | application/json |
433
- | errors.SDKError | 4XX, 5XX | \*/\* |
434
-
435
- ## delete
436
-
437
- Delete a DirectoryMember.
438
-
439
- ### Example Usage
440
-
441
- <!-- UsageSnippet language="typescript" operationID="directory_member_delete" method="delete" path="/api/v1/directory_members/{member_id}" -->
442
- ```typescript
443
- import { SyllableSDK } from "syllable-sdk";
444
-
445
- const syllableSDK = new SyllableSDK({
446
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
447
- });
448
-
449
- async function run() {
450
- const result = await syllableSDK.directory.delete({
451
- memberId: 569311,
452
- });
453
-
454
- console.log(result);
455
- }
456
-
457
- run();
458
- ```
459
-
460
- ### Standalone function
461
-
462
- The standalone function version of this method:
463
-
464
- ```typescript
465
- import { SyllableSDKCore } from "syllable-sdk/core.js";
466
- import { directoryDelete } from "syllable-sdk/funcs/directoryDelete.js";
467
-
468
- // Use `SyllableSDKCore` for best tree-shaking performance.
469
- // You can create one instance of it to use across an application.
470
- const syllableSDK = new SyllableSDKCore({
471
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
472
- });
473
-
474
- async function run() {
475
- const res = await directoryDelete(syllableSDK, {
476
- memberId: 569311,
477
- });
478
- if (res.ok) {
479
- const { value: result } = res;
480
- console.log(result);
481
- } else {
482
- console.log("directoryDelete failed:", res.error);
483
- }
484
- }
485
-
486
- run();
487
- ```
488
-
489
- ### Parameters
490
-
491
- | Parameter | Type | Required | Description |
492
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
493
- | `request` | [operations.DirectoryMemberDeleteRequest](../../models/operations/directorymemberdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
494
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
495
- | `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. |
496
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
497
-
498
- ### Response
499
-
500
- **Promise\<[any](../../models/.md)\>**
501
-
502
- ### Errors
503
-
504
- | Error Type | Status Code | Content Type |
505
- | -------------------------- | -------------------------- | -------------------------- |
506
- | errors.HTTPValidationError | 422 | application/json |
507
- | errors.SDKError | 4XX, 5XX | \*/\* |
508
-
509
- ## directoryMemberTestExtension
510
-
511
- Test directory member extension at a specific timestamp and language.
512
-
513
- ### Example Usage
514
-
515
- <!-- UsageSnippet language="typescript" operationID="directory_member_test_extension" method="get" path="/api/v1/directory_members/{member_id}/test" -->
516
- ```typescript
517
- import { SyllableSDK } from "syllable-sdk";
518
-
519
- const syllableSDK = new SyllableSDK({
520
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
521
- });
522
-
523
- async function run() {
524
- const result = await syllableSDK.directory.directoryMemberTestExtension({
525
- memberId: 922412,
526
- timestamp: new Date("2024-07-02T14:32:47.235Z"),
527
- });
528
-
529
- console.log(result);
530
- }
531
-
532
- run();
533
- ```
534
-
535
- ### Standalone function
536
-
537
- The standalone function version of this method:
538
-
539
- ```typescript
540
- import { SyllableSDKCore } from "syllable-sdk/core.js";
541
- import { directoryDirectoryMemberTestExtension } from "syllable-sdk/funcs/directoryDirectoryMemberTestExtension.js";
542
-
543
- // Use `SyllableSDKCore` for best tree-shaking performance.
544
- // You can create one instance of it to use across an application.
545
- const syllableSDK = new SyllableSDKCore({
546
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
547
- });
548
-
549
- async function run() {
550
- const res = await directoryDirectoryMemberTestExtension(syllableSDK, {
551
- memberId: 922412,
552
- timestamp: new Date("2024-07-02T14:32:47.235Z"),
553
- });
554
- if (res.ok) {
555
- const { value: result } = res;
556
- console.log(result);
557
- } else {
558
- console.log("directoryDirectoryMemberTestExtension failed:", res.error);
559
- }
560
- }
561
-
562
- run();
563
- ```
564
-
565
- ### Parameters
566
-
567
- | Parameter | Type | Required | Description |
568
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
569
- | `request` | [operations.DirectoryMemberTestExtensionRequest](../../models/operations/directorymembertestextensionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
570
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
571
- | `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. |
572
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
573
-
574
- ### Response
575
-
576
- **Promise\<[components.DirectoryMemberTestResponse](../../models/components/directorymembertestresponse.md)\>**
577
-
578
- ### Errors
579
-
580
- | Error Type | Status Code | Content Type |
581
- | -------------------------- | -------------------------- | -------------------------- |
582
- | errors.HTTPValidationError | 422 | application/json |
583
- | errors.SDKError | 4XX, 5XX | \*/\* |
584
-
585
- ## directoryMemberBulkLoad
586
-
587
- Update Directory Members in chunks of 100.
588
-
589
- ### Example Usage
590
-
591
- <!-- UsageSnippet language="typescript" operationID="directory_member_bulk_load" method="put" path="/api/v1/directory_members/upload/" -->
592
- ```typescript
593
- import { openAsBlob } from "node:fs";
594
- import { SyllableSDK } from "syllable-sdk";
595
-
596
- const syllableSDK = new SyllableSDK({
597
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
598
- });
599
-
600
- async function run() {
601
- const result = await syllableSDK.directory.directoryMemberBulkLoad({
602
- file: await openAsBlob("example.file"),
603
- });
604
-
605
- console.log(result);
606
- }
607
-
608
- run();
609
- ```
610
-
611
- ### Standalone function
612
-
613
- The standalone function version of this method:
614
-
615
- ```typescript
616
- import { openAsBlob } from "node:fs";
617
- import { SyllableSDKCore } from "syllable-sdk/core.js";
618
- import { directoryDirectoryMemberBulkLoad } from "syllable-sdk/funcs/directoryDirectoryMemberBulkLoad.js";
619
-
620
- // Use `SyllableSDKCore` for best tree-shaking performance.
621
- // You can create one instance of it to use across an application.
622
- const syllableSDK = new SyllableSDKCore({
623
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
624
- });
625
-
626
- async function run() {
627
- const res = await directoryDirectoryMemberBulkLoad(syllableSDK, {
628
- file: await openAsBlob("example.file"),
629
- });
630
- if (res.ok) {
631
- const { value: result } = res;
632
- console.log(result);
633
- } else {
634
- console.log("directoryDirectoryMemberBulkLoad failed:", res.error);
635
- }
636
- }
637
-
638
- run();
639
- ```
640
-
641
- ### Parameters
642
-
643
- | Parameter | Type | Required | Description |
644
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
645
- | `request` | [components.BodyDirectoryMemberBulkLoad](../../models/components/bodydirectorymemberbulkload.md) | :heavy_check_mark: | The request object to use for the request. |
646
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
647
- | `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. |
648
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
649
-
650
- ### Response
651
-
652
- **Promise\<[any](../../models/.md)\>**
653
-
654
- ### Errors
655
-
656
- | Error Type | Status Code | Content Type |
657
- | -------------------------- | -------------------------- | -------------------------- |
658
- | errors.HTTPValidationError | 422 | application/json |
659
- | errors.SDKError | 4XX, 5XX | \*/\* |
660
-
661
- ## directoryMemberDownload
662
-
663
- Download the entire directory as a JSON file.
664
-
665
- ### Example Usage
666
-
667
- <!-- UsageSnippet language="typescript" operationID="directory_member_download" method="get" path="/api/v1/directory_members/download/" -->
668
- ```typescript
669
- import { SyllableSDK } from "syllable-sdk";
670
-
671
- const syllableSDK = new SyllableSDK({
672
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
673
- });
674
-
675
- async function run() {
676
- const result = await syllableSDK.directory.directoryMemberDownload();
677
-
678
- console.log(result);
679
- }
680
-
681
- run();
682
- ```
683
-
684
- ### Standalone function
685
-
686
- The standalone function version of this method:
687
-
688
- ```typescript
689
- import { SyllableSDKCore } from "syllable-sdk/core.js";
690
- import { directoryDirectoryMemberDownload } from "syllable-sdk/funcs/directoryDirectoryMemberDownload.js";
691
-
692
- // Use `SyllableSDKCore` for best tree-shaking performance.
693
- // You can create one instance of it to use across an application.
694
- const syllableSDK = new SyllableSDKCore({
695
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
696
- });
697
-
698
- async function run() {
699
- const res = await directoryDirectoryMemberDownload(syllableSDK);
700
- if (res.ok) {
701
- const { value: result } = res;
702
- console.log(result);
703
- } else {
704
- console.log("directoryDirectoryMemberDownload failed:", res.error);
705
- }
706
- }
707
-
708
- run();
709
- ```
710
-
711
- ### Parameters
712
-
713
- | Parameter | Type | Required | Description |
714
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
715
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
716
- | `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. |
717
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
718
-
719
- ### Response
720
-
721
- **Promise\<[any](../../models/.md)\>**
722
-
723
- ### Errors
724
-
725
- | Error Type | Status Code | Content Type |
726
- | --------------- | --------------- | --------------- |
727
- | errors.SDKError | 4XX, 5XX | \*/\* |