syllable-sdk 0.1.0-alpha.169 → 0.1.0-alpha.174

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 (199) hide show
  1. package/README.md +24 -0
  2. package/docs/sdks/batches/README.md +4 -4
  3. package/docs/sdks/campaigns/README.md +18 -2
  4. package/docs/sdks/languagegroups/README.md +4 -4
  5. package/docs/sdks/numbers/README.md +164 -0
  6. package/docs/sdks/users/README.md +424 -1
  7. package/docs/sdks/v1/README.md +424 -1
  8. package/docs/sdks/workflows/README.md +8 -8
  9. package/funcs/channelsTwilioNumbersList.d.ts +17 -0
  10. package/funcs/channelsTwilioNumbersList.d.ts.map +1 -0
  11. package/funcs/channelsTwilioNumbersList.js +108 -0
  12. package/funcs/channelsTwilioNumbersList.js.map +1 -0
  13. package/funcs/channelsTwilioNumbersUpdate.d.ts +17 -0
  14. package/funcs/channelsTwilioNumbersUpdate.d.ts.map +1 -0
  15. package/funcs/channelsTwilioNumbersUpdate.js +111 -0
  16. package/funcs/channelsTwilioNumbersUpdate.js.map +1 -0
  17. package/funcs/usersCreate.d.ts +16 -0
  18. package/funcs/usersCreate.d.ts.map +1 -0
  19. package/funcs/usersCreate.js +102 -0
  20. package/funcs/usersCreate.js.map +1 -0
  21. package/funcs/usersDelete.d.ts +16 -0
  22. package/funcs/usersDelete.d.ts.map +1 -0
  23. package/funcs/usersDelete.js +103 -0
  24. package/funcs/usersDelete.js.map +1 -0
  25. package/funcs/usersList.d.ts +17 -0
  26. package/funcs/usersList.d.ts.map +1 -0
  27. package/funcs/usersList.js +114 -0
  28. package/funcs/usersList.js.map +1 -0
  29. package/funcs/usersUpdate.d.ts +16 -0
  30. package/funcs/usersUpdate.d.ts.map +1 -0
  31. package/funcs/usersUpdate.js +102 -0
  32. package/funcs/usersUpdate.js.map +1 -0
  33. package/funcs/usersUsersDeleteAccount.d.ts +4 -0
  34. package/funcs/usersUsersDeleteAccount.d.ts.map +1 -1
  35. package/funcs/usersUsersDeleteAccount.js +4 -0
  36. package/funcs/usersUsersDeleteAccount.js.map +1 -1
  37. package/funcs/usersUsersGetByEmail.d.ts +17 -0
  38. package/funcs/usersUsersGetByEmail.d.ts.map +1 -0
  39. package/funcs/usersUsersGetByEmail.js +108 -0
  40. package/funcs/usersUsersGetByEmail.js.map +1 -0
  41. package/funcs/v1Create.d.ts +16 -0
  42. package/funcs/v1Create.d.ts.map +1 -0
  43. package/funcs/v1Create.js +102 -0
  44. package/funcs/v1Create.js.map +1 -0
  45. package/funcs/v1Delete.d.ts +16 -0
  46. package/funcs/v1Delete.d.ts.map +1 -0
  47. package/funcs/v1Delete.js +103 -0
  48. package/funcs/v1Delete.js.map +1 -0
  49. package/funcs/v1List.d.ts +17 -0
  50. package/funcs/v1List.d.ts.map +1 -0
  51. package/funcs/v1List.js +114 -0
  52. package/funcs/v1List.js.map +1 -0
  53. package/funcs/v1Update.d.ts +16 -0
  54. package/funcs/v1Update.d.ts.map +1 -0
  55. package/funcs/v1Update.js +102 -0
  56. package/funcs/v1Update.js.map +1 -0
  57. package/funcs/v1UsersDeleteAccount.d.ts +4 -0
  58. package/funcs/v1UsersDeleteAccount.d.ts.map +1 -1
  59. package/funcs/v1UsersDeleteAccount.js +4 -0
  60. package/funcs/v1UsersDeleteAccount.js.map +1 -1
  61. package/funcs/v1UsersGetByEmail.d.ts +17 -0
  62. package/funcs/v1UsersGetByEmail.d.ts.map +1 -0
  63. package/funcs/v1UsersGetByEmail.js +108 -0
  64. package/funcs/v1UsersGetByEmail.js.map +1 -0
  65. package/jsr.json +1 -1
  66. package/lib/config.d.ts +2 -2
  67. package/lib/config.js +2 -2
  68. package/models/components/campaignproperties.d.ts +3 -0
  69. package/models/components/campaignproperties.d.ts.map +1 -1
  70. package/models/components/campaignproperties.js +1 -0
  71. package/models/components/campaignproperties.js.map +1 -1
  72. package/models/components/index.d.ts +10 -0
  73. package/models/components/index.d.ts.map +1 -1
  74. package/models/components/index.js +10 -0
  75. package/models/components/index.js.map +1 -1
  76. package/models/components/languagecode.d.ts +6 -0
  77. package/models/components/languagecode.d.ts.map +1 -1
  78. package/models/components/languagecode.js +2 -0
  79. package/models/components/languagecode.js.map +1 -1
  80. package/models/components/listresponseuserresponse.d.ts +53 -0
  81. package/models/components/listresponseuserresponse.d.ts.map +1 -0
  82. package/models/components/listresponseuserresponse.js +81 -0
  83. package/models/components/listresponseuserresponse.js.map +1 -0
  84. package/models/components/outboundcampaign.d.ts +8 -1
  85. package/models/components/outboundcampaign.d.ts.map +1 -1
  86. package/models/components/outboundcampaign.js +2 -0
  87. package/models/components/outboundcampaign.js.map +1 -1
  88. package/models/components/outboundcampaigninput.d.ts +8 -1
  89. package/models/components/outboundcampaigninput.d.ts.map +1 -1
  90. package/models/components/outboundcampaigninput.js +2 -0
  91. package/models/components/outboundcampaigninput.js.map +1 -1
  92. package/models/components/twiliolistnumbersresponse.d.ts +36 -0
  93. package/models/components/twiliolistnumbersresponse.d.ts.map +1 -0
  94. package/models/components/twiliolistnumbersresponse.js +69 -0
  95. package/models/components/twiliolistnumbersresponse.js.map +1 -0
  96. package/models/components/twilionumberupdaterequest.d.ts +40 -0
  97. package/models/components/twilionumberupdaterequest.d.ts.map +1 -0
  98. package/models/components/twilionumberupdaterequest.js +72 -0
  99. package/models/components/twilionumberupdaterequest.js.map +1 -0
  100. package/models/components/twilionumberupdateresponse.d.ts +35 -0
  101. package/models/components/twilionumberupdateresponse.d.ts.map +1 -0
  102. package/models/components/twilionumberupdateresponse.js +68 -0
  103. package/models/components/twilionumberupdateresponse.js.map +1 -0
  104. package/models/components/twiliophonenumber.d.ts +47 -0
  105. package/models/components/twiliophonenumber.d.ts.map +1 -0
  106. package/models/components/twiliophonenumber.js +78 -0
  107. package/models/components/twiliophonenumber.js.map +1 -0
  108. package/models/components/usercreaterequest.d.ts +50 -0
  109. package/models/components/usercreaterequest.d.ts.map +1 -0
  110. package/models/components/usercreaterequest.js +78 -0
  111. package/models/components/usercreaterequest.js.map +1 -0
  112. package/models/components/userdeleterequest.d.ts +40 -0
  113. package/models/components/userdeleterequest.d.ts.map +1 -0
  114. package/models/components/userdeleterequest.js +61 -0
  115. package/models/components/userdeleterequest.js.map +1 -0
  116. package/models/components/userproperties.d.ts +40 -0
  117. package/models/components/userproperties.d.ts.map +1 -0
  118. package/models/components/userproperties.js +55 -0
  119. package/models/components/userproperties.js.map +1 -0
  120. package/models/components/userresponse.d.ts +75 -0
  121. package/models/components/userresponse.d.ts.map +1 -0
  122. package/models/components/userresponse.js +97 -0
  123. package/models/components/userresponse.js.map +1 -0
  124. package/models/components/userupdaterequest.d.ts +55 -0
  125. package/models/components/userupdaterequest.d.ts.map +1 -0
  126. package/models/components/userupdaterequest.js +82 -0
  127. package/models/components/userupdaterequest.js.map +1 -0
  128. package/models/operations/channelstwilionumberslist.d.ts +29 -0
  129. package/models/operations/channelstwilionumberslist.d.ts.map +1 -0
  130. package/models/operations/channelstwilionumberslist.js +68 -0
  131. package/models/operations/channelstwilionumberslist.js.map +1 -0
  132. package/models/operations/channelstwilionumbersupdate.d.ts +32 -0
  133. package/models/operations/channelstwilionumbersupdate.d.ts.map +1 -0
  134. package/models/operations/channelstwilionumbersupdate.js +73 -0
  135. package/models/operations/channelstwilionumbersupdate.js.map +1 -0
  136. package/models/operations/index.d.ts +4 -0
  137. package/models/operations/index.d.ts.map +1 -1
  138. package/models/operations/index.js +4 -0
  139. package/models/operations/index.js.map +1 -1
  140. package/models/operations/usersgetbyemail.d.ts +29 -0
  141. package/models/operations/usersgetbyemail.d.ts.map +1 -0
  142. package/models/operations/usersgetbyemail.js +68 -0
  143. package/models/operations/usersgetbyemail.js.map +1 -0
  144. package/models/operations/userslist.d.ts +73 -0
  145. package/models/operations/userslist.d.ts.map +1 -0
  146. package/models/operations/userslist.js +99 -0
  147. package/models/operations/userslist.js.map +1 -0
  148. package/openapi.json +1353 -343
  149. package/package.json +1 -1
  150. package/sdk/numbers.d.ts +14 -0
  151. package/sdk/numbers.d.ts.map +1 -1
  152. package/sdk/numbers.js +20 -0
  153. package/sdk/numbers.js.map +1 -1
  154. package/sdk/users.d.ts +41 -0
  155. package/sdk/users.d.ts.map +1 -1
  156. package/sdk/users.js +54 -0
  157. package/sdk/users.js.map +1 -1
  158. package/sdk/v1.d.ts +41 -0
  159. package/sdk/v1.d.ts.map +1 -1
  160. package/sdk/v1.js +54 -0
  161. package/sdk/v1.js.map +1 -1
  162. package/src/funcs/channelsTwilioNumbersList.ts +145 -0
  163. package/src/funcs/channelsTwilioNumbersUpdate.ts +148 -0
  164. package/src/funcs/usersCreate.ts +135 -0
  165. package/src/funcs/usersDelete.ts +136 -0
  166. package/src/funcs/usersList.ts +148 -0
  167. package/src/funcs/usersUpdate.ts +135 -0
  168. package/src/funcs/usersUsersDeleteAccount.ts +4 -0
  169. package/src/funcs/usersUsersGetByEmail.ts +142 -0
  170. package/src/funcs/v1Create.ts +135 -0
  171. package/src/funcs/v1Delete.ts +136 -0
  172. package/src/funcs/v1List.ts +148 -0
  173. package/src/funcs/v1Update.ts +135 -0
  174. package/src/funcs/v1UsersDeleteAccount.ts +4 -0
  175. package/src/funcs/v1UsersGetByEmail.ts +142 -0
  176. package/src/lib/config.ts +2 -2
  177. package/src/models/components/campaignproperties.ts +1 -0
  178. package/src/models/components/index.ts +10 -0
  179. package/src/models/components/languagecode.ts +2 -0
  180. package/src/models/components/listresponseuserresponse.ts +116 -0
  181. package/src/models/components/outboundcampaign.ts +10 -1
  182. package/src/models/components/outboundcampaigninput.ts +10 -1
  183. package/src/models/components/twiliolistnumbersresponse.ts +87 -0
  184. package/src/models/components/twilionumberupdaterequest.ts +90 -0
  185. package/src/models/components/twilionumberupdateresponse.ts +81 -0
  186. package/src/models/components/twiliophonenumber.ts +103 -0
  187. package/src/models/components/usercreaterequest.ts +106 -0
  188. package/src/models/components/userdeleterequest.ts +79 -0
  189. package/src/models/components/userproperties.ts +41 -0
  190. package/src/models/components/userresponse.ts +150 -0
  191. package/src/models/components/userupdaterequest.ts +115 -0
  192. package/src/models/operations/channelstwilionumberslist.ts +77 -0
  193. package/src/models/operations/channelstwilionumbersupdate.ts +87 -0
  194. package/src/models/operations/index.ts +4 -0
  195. package/src/models/operations/usersgetbyemail.ts +75 -0
  196. package/src/models/operations/userslist.ts +149 -0
  197. package/src/sdk/numbers.ts +36 -0
  198. package/src/sdk/users.ts +96 -0
  199. package/src/sdk/v1.ts +96 -0
package/README.md CHANGED
@@ -171,6 +171,8 @@ run();
171
171
  #### [channels.twilio.numbers](docs/sdks/numbers/README.md)
172
172
 
173
173
  * [add](docs/sdks/numbers/README.md#add) - Add Twilio Number
174
+ * [update](docs/sdks/numbers/README.md#update) - Update Twilio Number
175
+ * [list](docs/sdks/numbers/README.md#list) - List Twilio Phone Numbers
174
176
 
175
177
  ### [conversations](docs/sdks/conversations/README.md)
176
178
 
@@ -360,10 +362,20 @@ run();
360
362
 
361
363
  ### [users](docs/sdks/users/README.md)
362
364
 
365
+ * [list](docs/sdks/users/README.md#list) - List Users
366
+ * [create](docs/sdks/users/README.md#create) - Create User
367
+ * [update](docs/sdks/users/README.md#update) - Update User
368
+ * [delete](docs/sdks/users/README.md#delete) - Delete User
369
+ * [usersGetByEmail](docs/sdks/users/README.md#usersgetbyemail) - Get User
363
370
  * [usersDeleteAccount](docs/sdks/users/README.md#usersdeleteaccount) - Request Removal Of This Account
364
371
 
365
372
  ### [v1](docs/sdks/v1/README.md)
366
373
 
374
+ * [list](docs/sdks/v1/README.md#list) - List Users
375
+ * [create](docs/sdks/v1/README.md#create) - Create User
376
+ * [update](docs/sdks/v1/README.md#update) - Update User
377
+ * [delete](docs/sdks/v1/README.md#delete) - Delete User
378
+ * [usersGetByEmail](docs/sdks/v1/README.md#usersgetbyemail) - Get User
367
379
  * [usersDeleteAccount](docs/sdks/v1/README.md#usersdeleteaccount) - Request Removal Of This Account
368
380
 
369
381
  </details>
@@ -401,6 +413,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
401
413
  - [`channelsTwilioCreate`](docs/sdks/twilio/README.md#create) - Create Twilio Channel
402
414
  - [`channelsTwilioGetById`](docs/sdks/twilio/README.md#getbyid) - Get Twilio Channel By Id
403
415
  - [`channelsTwilioNumbersAdd`](docs/sdks/numbers/README.md#add) - Add Twilio Number
416
+ - [`channelsTwilioNumbersList`](docs/sdks/numbers/README.md#list) - List Twilio Phone Numbers
417
+ - [`channelsTwilioNumbersUpdate`](docs/sdks/numbers/README.md#update) - Update Twilio Number
404
418
  - [`channelsTwilioUpdate`](docs/sdks/twilio/README.md#update) - Update Twilio Channel
405
419
  - [`conversationsList`](docs/sdks/conversations/README.md#list) - Conversations List
406
420
  - [`customMessagesCreate`](docs/sdks/custommessages/README.md#create) - Create Custom Message
@@ -505,8 +519,18 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
505
519
  - [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
506
520
  - [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
507
521
  - [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
522
+ - [`usersCreate`](docs/sdks/users/README.md#create) - Create User
523
+ - [`usersDelete`](docs/sdks/users/README.md#delete) - Delete User
524
+ - [`usersList`](docs/sdks/users/README.md#list) - List Users
525
+ - [`usersUpdate`](docs/sdks/users/README.md#update) - Update User
508
526
  - [`usersUsersDeleteAccount`](docs/sdks/users/README.md#usersdeleteaccount) - Request Removal Of This Account
527
+ - [`usersUsersGetByEmail`](docs/sdks/users/README.md#usersgetbyemail) - Get User
528
+ - [`v1Create`](docs/sdks/v1/README.md#create) - Create User
529
+ - [`v1Delete`](docs/sdks/v1/README.md#delete) - Delete User
530
+ - [`v1List`](docs/sdks/v1/README.md#list) - List Users
531
+ - [`v1Update`](docs/sdks/v1/README.md#update) - Update User
509
532
  - [`v1UsersDeleteAccount`](docs/sdks/v1/README.md#usersdeleteaccount) - Request Removal Of This Account
533
+ - [`v1UsersGetByEmail`](docs/sdks/v1/README.md#usersgetbyemail) - Get User
510
534
  - ~~[`dashboardsPostSessionEventsDashboard`](docs/sdks/dashboards/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
511
535
  - ~~[`dashboardsPostSessionsDashboard`](docs/sdks/dashboards/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
512
536
  - ~~[`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
@@ -125,9 +125,9 @@ const syllableSDK = new SyllableSDK({
125
125
 
126
126
  async function run() {
127
127
  const result = await syllableSDK.outbound.batches.create({
128
- batchId: "20250530.9",
128
+ batchId: "20250603.9",
129
129
  campaignId: 1,
130
- expiresOn: new Date("2025-05-31T00:00:00Z"),
130
+ expiresOn: new Date("2025-06-04T00:00:00Z"),
131
131
  paused: true,
132
132
  });
133
133
 
@@ -154,9 +154,9 @@ const syllableSDK = new SyllableSDKCore({
154
154
 
155
155
  async function run() {
156
156
  const res = await outboundBatchesCreate(syllableSDK, {
157
- batchId: "20250530.9",
157
+ batchId: "20250603.9",
158
158
  campaignId: 1,
159
- expiresOn: new Date("2025-05-31T00:00:00Z"),
159
+ expiresOn: new Date("2025-06-04T00:00:00Z"),
160
160
  paused: true,
161
161
  });
162
162
 
@@ -30,7 +30,7 @@ async function run() {
30
30
  const result = await syllableSDK.outbound.campaigns.list({
31
31
  page: 0,
32
32
  searchFields: [
33
- "caller_id",
33
+ "updated_at",
34
34
  ],
35
35
  searchFieldValues: [
36
36
  "Some Object Name",
@@ -64,7 +64,7 @@ async function run() {
64
64
  const res = await outboundCampaignsList(syllableSDK, {
65
65
  page: 0,
66
66
  searchFields: [
67
- "caller_id",
67
+ "updated_at",
68
68
  ],
69
69
  searchFieldValues: [
70
70
  "Some Object Name",
@@ -124,6 +124,10 @@ async function run() {
124
124
  campaignName: "Outbound Campaign 1",
125
125
  description: "This is a test campaign",
126
126
  label: "test",
127
+ labels: [
128
+ "test",
129
+ "demo",
130
+ ],
127
131
  campaignVariables: {
128
132
  "key": "value",
129
133
  "key2": "value2",
@@ -164,6 +168,10 @@ async function run() {
164
168
  campaignName: "Outbound Campaign 1",
165
169
  description: "This is a test campaign",
166
170
  label: "test",
171
+ labels: [
172
+ "test",
173
+ "demo",
174
+ ],
167
175
  campaignVariables: {
168
176
  "key": "value",
169
177
  "key2": "value2",
@@ -308,6 +316,10 @@ async function run() {
308
316
  campaignName: "Outbound Campaign 1",
309
317
  description: "This is a test campaign",
310
318
  label: "demo",
319
+ labels: [
320
+ "test",
321
+ "demo",
322
+ ],
311
323
  campaignVariables: {
312
324
  "key": "value",
313
325
  "key2": "value2",
@@ -351,6 +363,10 @@ async function run() {
351
363
  campaignName: "Outbound Campaign 1",
352
364
  description: "This is a test campaign",
353
365
  label: "demo",
366
+ labels: [
367
+ "test",
368
+ "demo",
369
+ ],
354
370
  campaignVariables: {
355
371
  "key": "value",
356
372
  "key2": "value2",
@@ -136,7 +136,7 @@ async function run() {
136
136
  {
137
137
  languageCode: "es-US",
138
138
  voiceProvider: "Google",
139
- voiceDisplayName: "Alejandro",
139
+ voiceDisplayName: "es-US-Neural2-B",
140
140
  voiceSpeed: 1,
141
141
  voicePitch: 0,
142
142
  dtmfCode: 1,
@@ -182,7 +182,7 @@ async function run() {
182
182
  {
183
183
  languageCode: "es-US",
184
184
  voiceProvider: "Google",
185
- voiceDisplayName: "Alejandro",
185
+ voiceDisplayName: "es-US-Neural2-B",
186
186
  voiceSpeed: 1,
187
187
  voicePitch: 0,
188
188
  dtmfCode: 1,
@@ -253,7 +253,7 @@ async function run() {
253
253
  {
254
254
  languageCode: "es-US",
255
255
  voiceProvider: "Google",
256
- voiceDisplayName: "Alejandro",
256
+ voiceDisplayName: "es-US-Neural2-B",
257
257
  voiceSpeed: 1,
258
258
  voicePitch: 0,
259
259
  dtmfCode: 1,
@@ -301,7 +301,7 @@ async function run() {
301
301
  {
302
302
  languageCode: "es-US",
303
303
  voiceProvider: "Google",
304
- voiceDisplayName: "Alejandro",
304
+ voiceDisplayName: "es-US-Neural2-B",
305
305
  voiceSpeed: 1,
306
306
  voicePitch: 0,
307
307
  dtmfCode: 1,
@@ -8,6 +8,8 @@ Operations related to setting up phone numbers in Twilio for use in ch
8
8
  ### Available Operations
9
9
 
10
10
  * [add](#add) - Add Twilio Number
11
+ * [update](#update) - Update Twilio Number
12
+ * [list](#list) - List Twilio Phone Numbers
11
13
 
12
14
  ## add
13
15
 
@@ -89,6 +91,168 @@ run();
89
91
 
90
92
  ### Errors
91
93
 
94
+ | Error Type | Status Code | Content Type |
95
+ | -------------------------- | -------------------------- | -------------------------- |
96
+ | errors.HTTPValidationError | 422 | application/json |
97
+ | errors.SDKError | 4XX, 5XX | \*/\* |
98
+
99
+ ## update
100
+
101
+ Update a Twilio number and associate it with a channel.
102
+
103
+ ### Example Usage
104
+
105
+ ```typescript
106
+ import { SyllableSDK } from "syllable-sdk";
107
+
108
+ const syllableSDK = new SyllableSDK({
109
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
110
+ });
111
+
112
+ async function run() {
113
+ const result = await syllableSDK.channels.twilio.numbers.update({
114
+ channelId: 857478,
115
+ twilioNumberUpdateRequest: {
116
+ friendlyName: "Support Line",
117
+ phoneSid: "PN123",
118
+ },
119
+ });
120
+
121
+ // Handle the result
122
+ console.log(result);
123
+ }
124
+
125
+ run();
126
+ ```
127
+
128
+ ### Standalone function
129
+
130
+ The standalone function version of this method:
131
+
132
+ ```typescript
133
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
134
+ import { channelsTwilioNumbersUpdate } from "syllable-sdk/funcs/channelsTwilioNumbersUpdate.js";
135
+
136
+ // Use `SyllableSDKCore` for best tree-shaking performance.
137
+ // You can create one instance of it to use across an application.
138
+ const syllableSDK = new SyllableSDKCore({
139
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
140
+ });
141
+
142
+ async function run() {
143
+ const res = await channelsTwilioNumbersUpdate(syllableSDK, {
144
+ channelId: 857478,
145
+ twilioNumberUpdateRequest: {
146
+ friendlyName: "Support Line",
147
+ phoneSid: "PN123",
148
+ },
149
+ });
150
+
151
+ if (!res.ok) {
152
+ throw res.error;
153
+ }
154
+
155
+ const { value: result } = res;
156
+
157
+ // Handle the result
158
+ console.log(result);
159
+ }
160
+
161
+ run();
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ | Parameter | Type | Required | Description |
167
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
168
+ | `request` | [operations.ChannelsTwilioNumbersUpdateRequest](../../models/operations/channelstwilionumbersupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
169
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
170
+ | `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. |
171
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
172
+
173
+ ### Response
174
+
175
+ **Promise\<[components.TwilioNumberUpdateResponse](../../models/components/twilionumberupdateresponse.md)\>**
176
+
177
+ ### Errors
178
+
179
+ | Error Type | Status Code | Content Type |
180
+ | -------------------------- | -------------------------- | -------------------------- |
181
+ | errors.HTTPValidationError | 422 | application/json |
182
+ | errors.SDKError | 4XX, 5XX | \*/\* |
183
+
184
+ ## list
185
+
186
+ List Twilio phone numbers.
187
+
188
+ ### Example Usage
189
+
190
+ ```typescript
191
+ import { SyllableSDK } from "syllable-sdk";
192
+
193
+ const syllableSDK = new SyllableSDK({
194
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
195
+ });
196
+
197
+ async function run() {
198
+ const result = await syllableSDK.channels.twilio.numbers.list({
199
+ channelId: 768578,
200
+ });
201
+
202
+ // Handle the result
203
+ console.log(result);
204
+ }
205
+
206
+ run();
207
+ ```
208
+
209
+ ### Standalone function
210
+
211
+ The standalone function version of this method:
212
+
213
+ ```typescript
214
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
215
+ import { channelsTwilioNumbersList } from "syllable-sdk/funcs/channelsTwilioNumbersList.js";
216
+
217
+ // Use `SyllableSDKCore` for best tree-shaking performance.
218
+ // You can create one instance of it to use across an application.
219
+ const syllableSDK = new SyllableSDKCore({
220
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
221
+ });
222
+
223
+ async function run() {
224
+ const res = await channelsTwilioNumbersList(syllableSDK, {
225
+ channelId: 768578,
226
+ });
227
+
228
+ if (!res.ok) {
229
+ throw res.error;
230
+ }
231
+
232
+ const { value: result } = res;
233
+
234
+ // Handle the result
235
+ console.log(result);
236
+ }
237
+
238
+ run();
239
+ ```
240
+
241
+ ### Parameters
242
+
243
+ | Parameter | Type | Required | Description |
244
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
245
+ | `request` | [operations.ChannelsTwilioNumbersListRequest](../../models/operations/channelstwilionumberslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
246
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
247
+ | `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. |
248
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
249
+
250
+ ### Response
251
+
252
+ **Promise\<[components.TwilioListNumbersResponse](../../models/components/twiliolistnumbersresponse.md)\>**
253
+
254
+ ### Errors
255
+
92
256
  | Error Type | Status Code | Content Type |
93
257
  | -------------------------- | -------------------------- | -------------------------- |
94
258
  | errors.HTTPValidationError | 422 | application/json |