ultracart_rest_api_v2_typescript 4.1.40 → 4.1.41

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 (30) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +3 -2
  3. package/dist/apis/ConversationApi.d.ts +254 -1
  4. package/dist/apis/ConversationApi.js +556 -0
  5. package/dist/models/ConversationPbxAddress.d.ts +97 -0
  6. package/dist/models/ConversationPbxAddress.js +72 -0
  7. package/dist/models/ConversationPbxAddressResponse.d.ts +59 -0
  8. package/dist/models/ConversationPbxAddressResponse.js +62 -0
  9. package/dist/models/ConversationPbxAddressesResponse.d.ts +32 -0
  10. package/dist/models/ConversationPbxAddressesResponse.js +51 -0
  11. package/dist/models/ConversationPbxAvailablePhoneNumber.d.ts +89 -0
  12. package/dist/models/ConversationPbxAvailablePhoneNumber.js +75 -0
  13. package/dist/models/ConversationPbxAvailablePhoneNumbersResponse.d.ts +59 -0
  14. package/dist/models/ConversationPbxAvailablePhoneNumbersResponse.js +62 -0
  15. package/dist/models/ConversationPbxPhoneNumber.d.ts +6 -0
  16. package/dist/models/ConversationPbxPhoneNumber.js +2 -0
  17. package/dist/models/ConversationPbxPhoneNumberPurchaseRequest.d.ts +66 -0
  18. package/dist/models/ConversationPbxPhoneNumberPurchaseRequest.js +68 -0
  19. package/dist/models/index.d.ts +6 -0
  20. package/dist/models/index.js +6 -0
  21. package/package.json +1 -1
  22. package/src/apis/ConversationApi.ts +609 -0
  23. package/src/models/ConversationPbxAddress.ts +155 -0
  24. package/src/models/ConversationPbxAddressResponse.ts +124 -0
  25. package/src/models/ConversationPbxAddressesResponse.ts +74 -0
  26. package/src/models/ConversationPbxAvailablePhoneNumber.ts +143 -0
  27. package/src/models/ConversationPbxAvailablePhoneNumbersResponse.ts +124 -0
  28. package/src/models/ConversationPbxPhoneNumber.ts +8 -0
  29. package/src/models/ConversationPbxPhoneNumberPurchaseRequest.ts +112 -0
  30. package/src/models/index.ts +6 -0
@@ -204,6 +204,9 @@ src/models/ConversationMessagesResponse.ts
204
204
  src/models/ConversationMultimediaUploadUrl.ts
205
205
  src/models/ConversationMultimediaUploadUrlResponse.ts
206
206
  src/models/ConversationParticipant.ts
207
+ src/models/ConversationPbxAddress.ts
208
+ src/models/ConversationPbxAddressResponse.ts
209
+ src/models/ConversationPbxAddressesResponse.ts
207
210
  src/models/ConversationPbxAgent.ts
208
211
  src/models/ConversationPbxAgentResponse.ts
209
212
  src/models/ConversationPbxAgentsResponse.ts
@@ -213,6 +216,8 @@ src/models/ConversationPbxAudioUploadUrl.ts
213
216
  src/models/ConversationPbxAudioUploadUrlResponse.ts
214
217
  src/models/ConversationPbxAudioUsageResponse.ts
215
218
  src/models/ConversationPbxAudiosResponse.ts
219
+ src/models/ConversationPbxAvailablePhoneNumber.ts
220
+ src/models/ConversationPbxAvailablePhoneNumbersResponse.ts
216
221
  src/models/ConversationPbxCustomerSnapshotRequest.ts
217
222
  src/models/ConversationPbxCustomerSnapshotResponse.ts
218
223
  src/models/ConversationPbxMenu.ts
@@ -220,6 +225,7 @@ src/models/ConversationPbxMenuMapping.ts
220
225
  src/models/ConversationPbxMenuResponse.ts
221
226
  src/models/ConversationPbxMenusResponse.ts
222
227
  src/models/ConversationPbxPhoneNumber.ts
228
+ src/models/ConversationPbxPhoneNumberPurchaseRequest.ts
223
229
  src/models/ConversationPbxPhoneNumberResponse.ts
224
230
  src/models/ConversationPbxPhoneNumbersResponse.ts
225
231
  src/models/ConversationPbxQueue.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.40
2
+ ## ultracart_rest_api_v2_typescript@4.1.41
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.40 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.41 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.41 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
88
89
  | 4.1.40 | 01/07/2026 | convseration - AI agent profile voice settings |
89
90
  | 4.1.39 | 12/31/2025 | conversations AI - queue AI settings |
90
91
  | 4.1.38 | 12/29/2025 | conversations - AI agent level capabilities |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
13
+ import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
14
14
  export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
15
15
  userId: number;
16
16
  documentUuid: string;
@@ -28,6 +28,9 @@ export interface DeleteDepartmentRequest {
28
28
  export interface DeleteEngagementRequest {
29
29
  conversationEngagementOid: number;
30
30
  }
31
+ export interface DeletePbxAddressRequest {
32
+ conversationPbxAddressUuid: string;
33
+ }
31
34
  export interface DeletePbxAgentVoicemailRequest {
32
35
  recordingSid: string;
33
36
  }
@@ -37,6 +40,9 @@ export interface DeletePbxAudioRequest {
37
40
  export interface DeletePbxMenuRequest {
38
41
  conversationPbxMenuUuid: string;
39
42
  }
43
+ export interface DeletePbxPhoneNumberRequest {
44
+ conversationPbxPhoneNumberUuid: string;
45
+ }
40
46
  export interface DeletePbxQueueRequest {
41
47
  conversationPbxQueueUuid: string;
42
48
  }
@@ -107,6 +113,9 @@ export interface GetConversationsAutocompleteRequest {
107
113
  export interface GetConversationsSearchRequest {
108
114
  searchRequest: ConversationSearchRequest;
109
115
  }
116
+ export interface GetPbxAddressRequest {
117
+ conversationPbxAddressUuid: string;
118
+ }
110
119
  export interface GetPbxAgentRequest {
111
120
  conversationPbxAgentUuid: string;
112
121
  }
@@ -161,6 +170,9 @@ export interface InsertConversationDepartmentRequest {
161
170
  export interface InsertConversationEngagementRequest {
162
171
  engagement: ConversationEngagement;
163
172
  }
173
+ export interface InsertPbxAddressRequest {
174
+ pbxAddress: ConversationPbxAddress;
175
+ }
164
176
  export interface InsertPbxAudioRequest {
165
177
  pbxAudio: ConversationPbxAudio;
166
178
  }
@@ -196,12 +208,27 @@ export interface ListenedPbxQueueVoicemailRequest {
196
208
  export interface MarkReadConversationRequest {
197
209
  conversationUuid: string;
198
210
  }
211
+ export interface ProtectPbxPhoneNumberRequest {
212
+ conversationPbxPhoneNumberUuid: string;
213
+ }
214
+ export interface PurchasePbxPhoneNumberRequest {
215
+ phoneNumberPurchaseRequest: ConversationPbxPhoneNumberPurchaseRequest;
216
+ }
199
217
  export interface ResetConversationPbxQueueStatisticsRequest {
200
218
  queueUuid: string;
201
219
  }
202
220
  export interface SearchConversationCannedMessagesRequest {
203
221
  searchRequest: ConversationCannedMessagesSearch;
204
222
  }
223
+ export interface SearchPbxAvailablePhoneNumbersRequest {
224
+ country: string;
225
+ areaCode?: string;
226
+ contains?: string;
227
+ smsEnabled?: boolean;
228
+ voiceEnabled?: boolean;
229
+ type?: string;
230
+ limit?: number;
231
+ }
205
232
  export interface SmsUnsubscribeConversationRequest {
206
233
  conversationUuid: string;
207
234
  }
@@ -232,6 +259,10 @@ export interface UpdateConversationWebchatQueueStatusRequest {
232
259
  queueName: string;
233
260
  statusRequest: ConversationWebchatQueueStatusUpdateRequest;
234
261
  }
262
+ export interface UpdatePbxAddressRequest {
263
+ conversationPbxAddressUuid: string;
264
+ pbxAddress: ConversationPbxAddress;
265
+ }
235
266
  export interface UpdatePbxAgentRequest {
236
267
  conversationPbxAgentUuid: string;
237
268
  pbxAgent: ConversationPbxAgent;
@@ -349,6 +380,20 @@ export interface ConversationApiInterface {
349
380
  * Delete a conversation engagement
350
381
  */
351
382
  deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
383
+ /**
384
+ * Delete a pbx address
385
+ * @summary Delete pbx address
386
+ * @param {string} conversationPbxAddressUuid
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ * @memberof ConversationApiInterface
390
+ */
391
+ deletePbxAddressRaw(requestParameters: DeletePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
392
+ /**
393
+ * Delete a pbx address
394
+ * Delete pbx address
395
+ */
396
+ deletePbxAddress(requestParameters: DeletePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
352
397
  /**
353
398
  * Delete pbx agent Voicemail
354
399
  * @summary Delete Agent Voicemail
@@ -391,6 +436,20 @@ export interface ConversationApiInterface {
391
436
  * Delete pbx menu
392
437
  */
393
438
  deletePbxMenu(requestParameters: DeletePbxMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxMenuResponse>;
439
+ /**
440
+ * Delete a pbx phoneNumber. Only works if deletion_protected is false.
441
+ * @summary Delete pbx phoneNumber
442
+ * @param {string} conversationPbxPhoneNumberUuid
443
+ * @param {*} [options] Override http request option.
444
+ * @throws {RequiredError}
445
+ * @memberof ConversationApiInterface
446
+ */
447
+ deletePbxPhoneNumberRaw(requestParameters: DeletePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
448
+ /**
449
+ * Delete a pbx phoneNumber. Only works if deletion_protected is false.
450
+ * Delete pbx phoneNumber
451
+ */
452
+ deletePbxPhoneNumber(requestParameters: DeletePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
394
453
  /**
395
454
  * Delete a pbx queue
396
455
  * @summary Delete pbx queue
@@ -824,6 +883,33 @@ export interface ConversationApiInterface {
824
883
  * Get location data for engagement configuration
825
884
  */
826
885
  getLocationsForEngagement(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationLocationsResponse>;
886
+ /**
887
+ * Retrieve a pbx address
888
+ * @summary Get pbx address
889
+ * @param {string} conversationPbxAddressUuid
890
+ * @param {*} [options] Override http request option.
891
+ * @throws {RequiredError}
892
+ * @memberof ConversationApiInterface
893
+ */
894
+ getPbxAddressRaw(requestParameters: GetPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
895
+ /**
896
+ * Retrieve a pbx address
897
+ * Get pbx address
898
+ */
899
+ getPbxAddress(requestParameters: GetPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
900
+ /**
901
+ * Retrieve pbx addresses
902
+ * @summary Get pbx addresses
903
+ * @param {*} [options] Override http request option.
904
+ * @throws {RequiredError}
905
+ * @memberof ConversationApiInterface
906
+ */
907
+ getPbxAddressesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressesResponse>>;
908
+ /**
909
+ * Retrieve pbx addresses
910
+ * Get pbx addresses
911
+ */
912
+ getPbxAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressesResponse>;
827
913
  /**
828
914
  * Retrieve a pbx agent
829
915
  * @summary Get pbx agent
@@ -1208,6 +1294,20 @@ export interface ConversationApiInterface {
1208
1294
  * Insert a engagement
1209
1295
  */
1210
1296
  insertConversationEngagement(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
1297
+ /**
1298
+ * Insert a pbx address
1299
+ * @summary Insert pbx address
1300
+ * @param {ConversationPbxAddress} pbxAddress Pbx Address
1301
+ * @param {*} [options] Override http request option.
1302
+ * @throws {RequiredError}
1303
+ * @memberof ConversationApiInterface
1304
+ */
1305
+ insertPbxAddressRaw(requestParameters: InsertPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
1306
+ /**
1307
+ * Insert a pbx address
1308
+ * Insert pbx address
1309
+ */
1310
+ insertPbxAddress(requestParameters: InsertPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
1211
1311
  /**
1212
1312
  * Insert a pbx audio
1213
1313
  * @summary Insert pbx audio
@@ -1364,6 +1464,34 @@ export interface ConversationApiInterface {
1364
1464
  * Mark a conversation as read
1365
1465
  */
1366
1466
  markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1467
+ /**
1468
+ * Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
1469
+ * @summary Protect pbx phoneNumber from deletion
1470
+ * @param {string} conversationPbxPhoneNumberUuid
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ * @memberof ConversationApiInterface
1474
+ */
1475
+ protectPbxPhoneNumberRaw(requestParameters: ProtectPbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxPhoneNumberResponse>>;
1476
+ /**
1477
+ * Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
1478
+ * Protect pbx phoneNumber from deletion
1479
+ */
1480
+ protectPbxPhoneNumber(requestParameters: ProtectPbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxPhoneNumberResponse>;
1481
+ /**
1482
+ * Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
1483
+ * @summary Purchase pbx phone number
1484
+ * @param {ConversationPbxPhoneNumberPurchaseRequest} phoneNumberPurchaseRequest Phone number purchase request
1485
+ * @param {*} [options] Override http request option.
1486
+ * @throws {RequiredError}
1487
+ * @memberof ConversationApiInterface
1488
+ */
1489
+ purchasePbxPhoneNumberRaw(requestParameters: PurchasePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxPhoneNumberResponse>>;
1490
+ /**
1491
+ * Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
1492
+ * Purchase pbx phone number
1493
+ */
1494
+ purchasePbxPhoneNumber(requestParameters: PurchasePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxPhoneNumberResponse>;
1367
1495
  /**
1368
1496
  * reset statistics within the queue
1369
1497
  * @summary reset statistics within the queue
@@ -1392,6 +1520,26 @@ export interface ConversationApiInterface {
1392
1520
  * Search for canned messages by short_code
1393
1521
  */
1394
1522
  searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
1523
+ /**
1524
+ * Search for available phone numbers from Twilio that can be purchased
1525
+ * @summary Search for available phone numbers
1526
+ * @param {string} country ISO country code (e.g., US, CA, GB)
1527
+ * @param {string} [areaCode] Area code filter (e.g., 614)
1528
+ * @param {string} [contains] Pattern to match (e.g., 555, *PIZZA)
1529
+ * @param {boolean} [smsEnabled] Filter for SMS capability
1530
+ * @param {boolean} [voiceEnabled] Filter for voice capability
1531
+ * @param {string} [type] Phone number type
1532
+ * @param {number} [limit] Max results (default 20, max 100)
1533
+ * @param {*} [options] Override http request option.
1534
+ * @throws {RequiredError}
1535
+ * @memberof ConversationApiInterface
1536
+ */
1537
+ searchPbxAvailablePhoneNumbersRaw(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAvailablePhoneNumbersResponse>>;
1538
+ /**
1539
+ * Search for available phone numbers from Twilio that can be purchased
1540
+ * Search for available phone numbers
1541
+ */
1542
+ searchPbxAvailablePhoneNumbers(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAvailablePhoneNumbersResponse>;
1395
1543
  /**
1396
1544
  * Unsubscribe any SMS participants in this conversation
1397
1545
  * @summary Unsubscribe any SMS participants in this conversation
@@ -1510,6 +1658,21 @@ export interface ConversationApiInterface {
1510
1658
  * Update status within the queue
1511
1659
  */
1512
1660
  updateConversationWebchatQueueStatus(requestParameters: UpdateConversationWebchatQueueStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1661
+ /**
1662
+ * Update a pbx address
1663
+ * @summary Update pbx address
1664
+ * @param {string} conversationPbxAddressUuid
1665
+ * @param {ConversationPbxAddress} pbxAddress Pbx Address
1666
+ * @param {*} [options] Override http request option.
1667
+ * @throws {RequiredError}
1668
+ * @memberof ConversationApiInterface
1669
+ */
1670
+ updatePbxAddressRaw(requestParameters: UpdatePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
1671
+ /**
1672
+ * Update a pbx address
1673
+ * Update pbx address
1674
+ */
1675
+ updatePbxAddress(requestParameters: UpdatePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
1513
1676
  /**
1514
1677
  * Update a pbx agent
1515
1678
  * @summary Update pbx agent
@@ -1713,6 +1876,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1713
1876
  * Delete a conversation engagement
1714
1877
  */
1715
1878
  deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1879
+ /**
1880
+ * Delete a pbx address
1881
+ * Delete pbx address
1882
+ */
1883
+ deletePbxAddressRaw(requestParameters: DeletePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
1884
+ /**
1885
+ * Delete a pbx address
1886
+ * Delete pbx address
1887
+ */
1888
+ deletePbxAddress(requestParameters: DeletePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
1716
1889
  /**
1717
1890
  * Delete pbx agent Voicemail
1718
1891
  * Delete Agent Voicemail
@@ -1743,6 +1916,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1743
1916
  * Delete pbx menu
1744
1917
  */
1745
1918
  deletePbxMenu(requestParameters: DeletePbxMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxMenuResponse>;
1919
+ /**
1920
+ * Delete a pbx phoneNumber. Only works if deletion_protected is false.
1921
+ * Delete pbx phoneNumber
1922
+ */
1923
+ deletePbxPhoneNumberRaw(requestParameters: DeletePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1924
+ /**
1925
+ * Delete a pbx phoneNumber. Only works if deletion_protected is false.
1926
+ * Delete pbx phoneNumber
1927
+ */
1928
+ deletePbxPhoneNumber(requestParameters: DeletePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1746
1929
  /**
1747
1930
  * Delete a pbx queue
1748
1931
  * Delete pbx queue
@@ -2053,6 +2236,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2053
2236
  * Get location data for engagement configuration
2054
2237
  */
2055
2238
  getLocationsForEngagement(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationLocationsResponse>;
2239
+ /**
2240
+ * Retrieve a pbx address
2241
+ * Get pbx address
2242
+ */
2243
+ getPbxAddressRaw(requestParameters: GetPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
2244
+ /**
2245
+ * Retrieve a pbx address
2246
+ * Get pbx address
2247
+ */
2248
+ getPbxAddress(requestParameters: GetPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
2249
+ /**
2250
+ * Retrieve pbx addresses
2251
+ * Get pbx addresses
2252
+ */
2253
+ getPbxAddressesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressesResponse>>;
2254
+ /**
2255
+ * Retrieve pbx addresses
2256
+ * Get pbx addresses
2257
+ */
2258
+ getPbxAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressesResponse>;
2056
2259
  /**
2057
2260
  * Retrieve a pbx agent
2058
2261
  * Get pbx agent
@@ -2333,6 +2536,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2333
2536
  * Insert a engagement
2334
2537
  */
2335
2538
  insertConversationEngagement(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
2539
+ /**
2540
+ * Insert a pbx address
2541
+ * Insert pbx address
2542
+ */
2543
+ insertPbxAddressRaw(requestParameters: InsertPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
2544
+ /**
2545
+ * Insert a pbx address
2546
+ * Insert pbx address
2547
+ */
2548
+ insertPbxAddress(requestParameters: InsertPbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
2336
2549
  /**
2337
2550
  * Insert a pbx audio
2338
2551
  * Insert pbx audio
@@ -2443,6 +2656,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2443
2656
  * Mark a conversation as read
2444
2657
  */
2445
2658
  markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2659
+ /**
2660
+ * Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
2661
+ * Protect pbx phoneNumber from deletion
2662
+ */
2663
+ protectPbxPhoneNumberRaw(requestParameters: ProtectPbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxPhoneNumberResponse>>;
2664
+ /**
2665
+ * Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
2666
+ * Protect pbx phoneNumber from deletion
2667
+ */
2668
+ protectPbxPhoneNumber(requestParameters: ProtectPbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxPhoneNumberResponse>;
2669
+ /**
2670
+ * Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
2671
+ * Purchase pbx phone number
2672
+ */
2673
+ purchasePbxPhoneNumberRaw(requestParameters: PurchasePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxPhoneNumberResponse>>;
2674
+ /**
2675
+ * Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
2676
+ * Purchase pbx phone number
2677
+ */
2678
+ purchasePbxPhoneNumber(requestParameters: PurchasePbxPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxPhoneNumberResponse>;
2446
2679
  /**
2447
2680
  * reset statistics within the queue
2448
2681
  * reset statistics within the queue
@@ -2463,6 +2696,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2463
2696
  * Search for canned messages by short_code
2464
2697
  */
2465
2698
  searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
2699
+ /**
2700
+ * Search for available phone numbers from Twilio that can be purchased
2701
+ * Search for available phone numbers
2702
+ */
2703
+ searchPbxAvailablePhoneNumbersRaw(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAvailablePhoneNumbersResponse>>;
2704
+ /**
2705
+ * Search for available phone numbers from Twilio that can be purchased
2706
+ * Search for available phone numbers
2707
+ */
2708
+ searchPbxAvailablePhoneNumbers(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAvailablePhoneNumbersResponse>;
2466
2709
  /**
2467
2710
  * Unsubscribe any SMS participants in this conversation
2468
2711
  * Unsubscribe any SMS participants in this conversation
@@ -2543,6 +2786,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2543
2786
  * Update status within the queue
2544
2787
  */
2545
2788
  updateConversationWebchatQueueStatus(requestParameters: UpdateConversationWebchatQueueStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2789
+ /**
2790
+ * Update a pbx address
2791
+ * Update pbx address
2792
+ */
2793
+ updatePbxAddressRaw(requestParameters: UpdatePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxAddressResponse>>;
2794
+ /**
2795
+ * Update a pbx address
2796
+ * Update pbx address
2797
+ */
2798
+ updatePbxAddress(requestParameters: UpdatePbxAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAddressResponse>;
2546
2799
  /**
2547
2800
  * Update a pbx agent
2548
2801
  * Update pbx agent