ultracart_api 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 (21) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -2
  3. data/docs/ConversationApi.md +492 -0
  4. data/docs/ConversationPbxAddress.md +40 -0
  5. data/docs/ConversationPbxAddressResponse.md +26 -0
  6. data/docs/ConversationPbxAddressesResponse.md +18 -0
  7. data/docs/ConversationPbxAvailablePhoneNumber.md +34 -0
  8. data/docs/ConversationPbxAvailablePhoneNumbersResponse.md +26 -0
  9. data/docs/ConversationPbxPhoneNumber.md +2 -0
  10. data/docs/ConversationPbxPhoneNumberPurchaseRequest.md +26 -0
  11. data/lib/ultracart_api/api/conversation_api.rb +610 -0
  12. data/lib/ultracart_api/models/conversation_pbx_address.rb +480 -0
  13. data/lib/ultracart_api/models/conversation_pbx_address_response.rb +256 -0
  14. data/lib/ultracart_api/models/conversation_pbx_addresses_response.rb +221 -0
  15. data/lib/ultracart_api/models/conversation_pbx_available_phone_number.rb +409 -0
  16. data/lib/ultracart_api/models/conversation_pbx_available_phone_numbers_response.rb +258 -0
  17. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +11 -1
  18. data/lib/ultracart_api/models/conversation_pbx_phone_number_purchase_request.rb +359 -0
  19. data/lib/ultracart_api/version.rb +1 -1
  20. data/lib/ultracart_api.rb +6 -0
  21. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d27bd5cb39758d9e805ab98dbadf2f01cb45959a79b4f5c13c0d96093693127f
4
- data.tar.gz: e71c68b1aceaeaf3288e4d93c932c30343c86d9261c3f1449c1338b1e21f89be
3
+ metadata.gz: 595b3033ad472ccc0aa3d78aa1f6a70d651bfd8eba98e9be117be4472661a6b1
4
+ data.tar.gz: 8194ad91b9acfedc80fc3252b03b14634a67d163ca01cdf68c4aac84c8c7d549
5
5
  SHA512:
6
- metadata.gz: e4137267b8429515d63ea3a607902d89b480e3be6332cc647e7746c21f83f302f1860be4831cdda220e7ec5a38664d9355eae7c79db9d6ab38aeae6be083f979
7
- data.tar.gz: 105466e4e377a8e14dfc30eeccfaff5636b88d24eb2679a73de03761a0bf1f728c01c6be9fac43031c9f184cc6c66e762d4f2323b8ba7ccc52c06d2085b4aa78
6
+ metadata.gz: '0582649d3d7650856dda1b5abadf50c80763fe54f77618cbed053f0ec1b546e99833d256907715ec5134b0ed41d9423fa57a75500d9087af3cdd9d0bb1b9f129'
7
+ data.tar.gz: ed20b91310e7e0c24eba78318399b3b4421e1e965abaae0c2336a90e823730e90b40bb0ca2e2d899e5e8acf2ce5a12ced62698764284da883bafc14ad8dca8c7
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.40
10
+ - Package version: 4.1.41
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.40'
19
+ gem 'ultracart_api', '4.1.41'
20
20
  ```
21
21
 
22
22
  install:
@@ -134,9 +134,11 @@ Class | Method | HTTP request | Description
134
134
  *UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
135
135
  *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
136
136
  *UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
137
+ *UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
137
138
  *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
138
139
  *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
139
140
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
141
+ *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
140
142
  *UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
141
143
  *UltracartClient::ConversationApi* | [**delete_pbx_queue_voicemail**](docs/ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail
142
144
  *UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
@@ -168,6 +170,8 @@ Class | Method | HTTP request | Description
168
170
  *UltracartClient::ConversationApi* | [**get_conversations_autocomplete**](docs/ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
169
171
  *UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
170
172
  *UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
173
+ *UltracartClient::ConversationApi* | [**get_pbx_address**](docs/ConversationApi.md#get_pbx_address) | **GET** /conversation/pbx/address/{conversationPbxAddressUuid} | Get pbx address
174
+ *UltracartClient::ConversationApi* | [**get_pbx_addresses**](docs/ConversationApi.md#get_pbx_addresses) | **GET** /conversation/pbx/address | Get pbx addresses
171
175
  *UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
172
176
  *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
173
177
  *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
@@ -196,6 +200,7 @@ Class | Method | HTTP request | Description
196
200
  *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
197
201
  *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
198
202
  *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
203
+ *UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
199
204
  *UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
200
205
  *UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
201
206
  *UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
@@ -207,8 +212,11 @@ Class | Method | HTTP request | Description
207
212
  *UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
208
213
  *UltracartClient::ConversationApi* | [**listened_pbx_queue_voicemail**](docs/ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened | Listened Queue Voicemail
209
214
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
215
+ *UltracartClient::ConversationApi* | [**protect_pbx_phone_number**](docs/ConversationApi.md#protect_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect | Protect pbx phoneNumber from deletion
216
+ *UltracartClient::ConversationApi* | [**purchase_pbx_phone_number**](docs/ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number
210
217
  *UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
211
218
  *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
219
+ *UltracartClient::ConversationApi* | [**search_pbx_available_phone_numbers**](docs/ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
212
220
  *UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
213
221
  *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
214
222
  *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
@@ -217,6 +225,7 @@ Class | Method | HTTP request | Description
217
225
  *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
218
226
  *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
219
227
  *UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
228
+ *UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
220
229
  *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
221
230
  *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
222
231
  *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
@@ -805,6 +814,9 @@ Class | Method | HTTP request | Description
805
814
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
806
815
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
807
816
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
817
+ - [UltracartClient::ConversationPbxAddress](docs/ConversationPbxAddress.md)
818
+ - [UltracartClient::ConversationPbxAddressResponse](docs/ConversationPbxAddressResponse.md)
819
+ - [UltracartClient::ConversationPbxAddressesResponse](docs/ConversationPbxAddressesResponse.md)
808
820
  - [UltracartClient::ConversationPbxAgent](docs/ConversationPbxAgent.md)
809
821
  - [UltracartClient::ConversationPbxAgentResponse](docs/ConversationPbxAgentResponse.md)
810
822
  - [UltracartClient::ConversationPbxAgentsResponse](docs/ConversationPbxAgentsResponse.md)
@@ -814,6 +826,8 @@ Class | Method | HTTP request | Description
814
826
  - [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
815
827
  - [UltracartClient::ConversationPbxAudioUsageResponse](docs/ConversationPbxAudioUsageResponse.md)
816
828
  - [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
829
+ - [UltracartClient::ConversationPbxAvailablePhoneNumber](docs/ConversationPbxAvailablePhoneNumber.md)
830
+ - [UltracartClient::ConversationPbxAvailablePhoneNumbersResponse](docs/ConversationPbxAvailablePhoneNumbersResponse.md)
817
831
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
818
832
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
819
833
  - [UltracartClient::ConversationPbxMenu](docs/ConversationPbxMenu.md)
@@ -821,6 +835,7 @@ Class | Method | HTTP request | Description
821
835
  - [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
822
836
  - [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
823
837
  - [UltracartClient::ConversationPbxPhoneNumber](docs/ConversationPbxPhoneNumber.md)
838
+ - [UltracartClient::ConversationPbxPhoneNumberPurchaseRequest](docs/ConversationPbxPhoneNumberPurchaseRequest.md)
824
839
  - [UltracartClient::ConversationPbxPhoneNumberResponse](docs/ConversationPbxPhoneNumberResponse.md)
825
840
  - [UltracartClient::ConversationPbxPhoneNumbersResponse](docs/ConversationPbxPhoneNumbersResponse.md)
826
841
  - [UltracartClient::ConversationPbxQueue](docs/ConversationPbxQueue.md)
@@ -1606,6 +1621,7 @@ Not every change is committed to every SDK.
1606
1621
 
1607
1622
  | Version | Date | Comments |
1608
1623
  | --: | :-: | --- |
1624
+ | 4.1.41 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
1609
1625
  | 4.1.40 | 01/07/2026 | convseration - AI agent profile voice settings |
1610
1626
  | 4.1.39 | 12/31/2025 | conversations AI - queue AI settings |
1611
1627
  | 4.1.38 | 12/29/2025 | conversations - AI agent level capabilities |