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/directory/README.md DELETED
@@ -1,731 +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
- directoryMember: {
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
- updatedAt: new Date("2024-01-01T00:00:00Z"),
350
- lastUpdatedBy: "user@email.com",
351
- },
352
- });
353
-
354
- console.log(result);
355
- }
356
-
357
- run();
358
- ```
359
-
360
- ### Standalone function
361
-
362
- The standalone function version of this method:
363
-
364
- ```typescript
365
- import { SyllableSDKCore } from "syllable-sdk/core.js";
366
- import { directoryUpdate } from "syllable-sdk/funcs/directoryUpdate.js";
367
-
368
- // Use `SyllableSDKCore` for best tree-shaking performance.
369
- // You can create one instance of it to use across an application.
370
- const syllableSDK = new SyllableSDKCore({
371
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
372
- });
373
-
374
- async function run() {
375
- const res = await directoryUpdate(syllableSDK, {
376
- memberId: 941217,
377
- directoryMember: {
378
- name: "Jane Doe",
379
- type: "contact",
380
- extensions: [
381
- {
382
- name: "work",
383
- numbers: [
384
- {
385
- number: "+1234567890",
386
- rules: [
387
- {
388
- "language": "en",
389
- },
390
- ],
391
- },
392
- ],
393
- },
394
- ],
395
- contactTags: {
396
- "tag1": [
397
- "value1",
398
- ],
399
- "tag2": [
400
- "value2",
401
- ],
402
- },
403
- id: 1,
404
- updatedAt: new Date("2024-01-01T00:00:00Z"),
405
- lastUpdatedBy: "user@email.com",
406
- },
407
- });
408
- if (res.ok) {
409
- const { value: result } = res;
410
- console.log(result);
411
- } else {
412
- console.log("directoryUpdate failed:", res.error);
413
- }
414
- }
415
-
416
- run();
417
- ```
418
-
419
- ### Parameters
420
-
421
- | Parameter | Type | Required | Description |
422
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
423
- | `request` | [operations.DirectoryMemberUpdateRequest](../../models/operations/directorymemberupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
424
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
425
- | `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. |
426
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
427
-
428
- ### Response
429
-
430
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
431
-
432
- ### Errors
433
-
434
- | Error Type | Status Code | Content Type |
435
- | -------------------------- | -------------------------- | -------------------------- |
436
- | errors.HTTPValidationError | 422 | application/json |
437
- | errors.SDKError | 4XX, 5XX | \*/\* |
438
-
439
- ## delete
440
-
441
- Delete a DirectoryMember.
442
-
443
- ### Example Usage
444
-
445
- <!-- UsageSnippet language="typescript" operationID="directory_member_delete" method="delete" path="/api/v1/directory_members/{member_id}" -->
446
- ```typescript
447
- import { SyllableSDK } from "syllable-sdk";
448
-
449
- const syllableSDK = new SyllableSDK({
450
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
451
- });
452
-
453
- async function run() {
454
- const result = await syllableSDK.directory.delete({
455
- memberId: 569311,
456
- });
457
-
458
- console.log(result);
459
- }
460
-
461
- run();
462
- ```
463
-
464
- ### Standalone function
465
-
466
- The standalone function version of this method:
467
-
468
- ```typescript
469
- import { SyllableSDKCore } from "syllable-sdk/core.js";
470
- import { directoryDelete } from "syllable-sdk/funcs/directoryDelete.js";
471
-
472
- // Use `SyllableSDKCore` for best tree-shaking performance.
473
- // You can create one instance of it to use across an application.
474
- const syllableSDK = new SyllableSDKCore({
475
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
476
- });
477
-
478
- async function run() {
479
- const res = await directoryDelete(syllableSDK, {
480
- memberId: 569311,
481
- });
482
- if (res.ok) {
483
- const { value: result } = res;
484
- console.log(result);
485
- } else {
486
- console.log("directoryDelete failed:", res.error);
487
- }
488
- }
489
-
490
- run();
491
- ```
492
-
493
- ### Parameters
494
-
495
- | Parameter | Type | Required | Description |
496
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
497
- | `request` | [operations.DirectoryMemberDeleteRequest](../../models/operations/directorymemberdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
498
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
499
- | `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. |
500
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
501
-
502
- ### Response
503
-
504
- **Promise\<[any](../../models/.md)\>**
505
-
506
- ### Errors
507
-
508
- | Error Type | Status Code | Content Type |
509
- | -------------------------- | -------------------------- | -------------------------- |
510
- | errors.HTTPValidationError | 422 | application/json |
511
- | errors.SDKError | 4XX, 5XX | \*/\* |
512
-
513
- ## directoryMemberTestExtension
514
-
515
- Test directory member extension at a specific timestamp and language.
516
-
517
- ### Example Usage
518
-
519
- <!-- UsageSnippet language="typescript" operationID="directory_member_test_extension" method="get" path="/api/v1/directory_members/{member_id}/test" -->
520
- ```typescript
521
- import { SyllableSDK } from "syllable-sdk";
522
-
523
- const syllableSDK = new SyllableSDK({
524
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
525
- });
526
-
527
- async function run() {
528
- const result = await syllableSDK.directory.directoryMemberTestExtension({
529
- memberId: 922412,
530
- timestamp: new Date("2024-07-02T14:32:47.235Z"),
531
- });
532
-
533
- console.log(result);
534
- }
535
-
536
- run();
537
- ```
538
-
539
- ### Standalone function
540
-
541
- The standalone function version of this method:
542
-
543
- ```typescript
544
- import { SyllableSDKCore } from "syllable-sdk/core.js";
545
- import { directoryDirectoryMemberTestExtension } from "syllable-sdk/funcs/directoryDirectoryMemberTestExtension.js";
546
-
547
- // Use `SyllableSDKCore` for best tree-shaking performance.
548
- // You can create one instance of it to use across an application.
549
- const syllableSDK = new SyllableSDKCore({
550
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
551
- });
552
-
553
- async function run() {
554
- const res = await directoryDirectoryMemberTestExtension(syllableSDK, {
555
- memberId: 922412,
556
- timestamp: new Date("2024-07-02T14:32:47.235Z"),
557
- });
558
- if (res.ok) {
559
- const { value: result } = res;
560
- console.log(result);
561
- } else {
562
- console.log("directoryDirectoryMemberTestExtension failed:", res.error);
563
- }
564
- }
565
-
566
- run();
567
- ```
568
-
569
- ### Parameters
570
-
571
- | Parameter | Type | Required | Description |
572
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
573
- | `request` | [operations.DirectoryMemberTestExtensionRequest](../../models/operations/directorymembertestextensionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
574
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
575
- | `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. |
576
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
577
-
578
- ### Response
579
-
580
- **Promise\<[components.DirectoryMemberTestResponse](../../models/components/directorymembertestresponse.md)\>**
581
-
582
- ### Errors
583
-
584
- | Error Type | Status Code | Content Type |
585
- | -------------------------- | -------------------------- | -------------------------- |
586
- | errors.HTTPValidationError | 422 | application/json |
587
- | errors.SDKError | 4XX, 5XX | \*/\* |
588
-
589
- ## directoryMemberBulkLoad
590
-
591
- Update Directory Members in chunks of 100.
592
-
593
- ### Example Usage
594
-
595
- <!-- UsageSnippet language="typescript" operationID="directory_member_bulk_load" method="put" path="/api/v1/directory_members/upload/" -->
596
- ```typescript
597
- import { openAsBlob } from "node:fs";
598
- import { SyllableSDK } from "syllable-sdk";
599
-
600
- const syllableSDK = new SyllableSDK({
601
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
602
- });
603
-
604
- async function run() {
605
- const result = await syllableSDK.directory.directoryMemberBulkLoad({
606
- file: await openAsBlob("example.file"),
607
- });
608
-
609
- console.log(result);
610
- }
611
-
612
- run();
613
- ```
614
-
615
- ### Standalone function
616
-
617
- The standalone function version of this method:
618
-
619
- ```typescript
620
- import { openAsBlob } from "node:fs";
621
- import { SyllableSDKCore } from "syllable-sdk/core.js";
622
- import { directoryDirectoryMemberBulkLoad } from "syllable-sdk/funcs/directoryDirectoryMemberBulkLoad.js";
623
-
624
- // Use `SyllableSDKCore` for best tree-shaking performance.
625
- // You can create one instance of it to use across an application.
626
- const syllableSDK = new SyllableSDKCore({
627
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
628
- });
629
-
630
- async function run() {
631
- const res = await directoryDirectoryMemberBulkLoad(syllableSDK, {
632
- file: await openAsBlob("example.file"),
633
- });
634
- if (res.ok) {
635
- const { value: result } = res;
636
- console.log(result);
637
- } else {
638
- console.log("directoryDirectoryMemberBulkLoad failed:", res.error);
639
- }
640
- }
641
-
642
- run();
643
- ```
644
-
645
- ### Parameters
646
-
647
- | Parameter | Type | Required | Description |
648
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
649
- | `request` | [components.BodyDirectoryMemberBulkLoad](../../models/components/bodydirectorymemberbulkload.md) | :heavy_check_mark: | The request object to use for the request. |
650
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
651
- | `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. |
652
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
653
-
654
- ### Response
655
-
656
- **Promise\<[any](../../models/.md)\>**
657
-
658
- ### Errors
659
-
660
- | Error Type | Status Code | Content Type |
661
- | -------------------------- | -------------------------- | -------------------------- |
662
- | errors.HTTPValidationError | 422 | application/json |
663
- | errors.SDKError | 4XX, 5XX | \*/\* |
664
-
665
- ## directoryMemberDownload
666
-
667
- Download the entire directory as a JSON file.
668
-
669
- ### Example Usage
670
-
671
- <!-- UsageSnippet language="typescript" operationID="directory_member_download" method="get" path="/api/v1/directory_members/download/" -->
672
- ```typescript
673
- import { SyllableSDK } from "syllable-sdk";
674
-
675
- const syllableSDK = new SyllableSDK({
676
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
677
- });
678
-
679
- async function run() {
680
- const result = await syllableSDK.directory.directoryMemberDownload();
681
-
682
- console.log(result);
683
- }
684
-
685
- run();
686
- ```
687
-
688
- ### Standalone function
689
-
690
- The standalone function version of this method:
691
-
692
- ```typescript
693
- import { SyllableSDKCore } from "syllable-sdk/core.js";
694
- import { directoryDirectoryMemberDownload } from "syllable-sdk/funcs/directoryDirectoryMemberDownload.js";
695
-
696
- // Use `SyllableSDKCore` for best tree-shaking performance.
697
- // You can create one instance of it to use across an application.
698
- const syllableSDK = new SyllableSDKCore({
699
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
700
- });
701
-
702
- async function run() {
703
- const res = await directoryDirectoryMemberDownload(syllableSDK);
704
- if (res.ok) {
705
- const { value: result } = res;
706
- console.log(result);
707
- } else {
708
- console.log("directoryDirectoryMemberDownload failed:", res.error);
709
- }
710
- }
711
-
712
- run();
713
- ```
714
-
715
- ### Parameters
716
-
717
- | Parameter | Type | Required | Description |
718
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
719
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
720
- | `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. |
721
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
722
-
723
- ### Response
724
-
725
- **Promise\<[any](../../models/.md)\>**
726
-
727
- ### Errors
728
-
729
- | Error Type | Status Code | Content Type |
730
- | --------------- | --------------- | --------------- |
731
- | errors.SDKError | 4XX, 5XX | \*/\* |