ultracart_api 3.11.39 → 3.11.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 (23) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -4
  3. data/docs/ConversationAgentProfile.md +2 -0
  4. data/docs/ConversationApi.md +470 -0
  5. data/docs/ConversationPbxAddress.md +19 -0
  6. data/docs/ConversationPbxAddressResponse.md +12 -0
  7. data/docs/ConversationPbxAddressesResponse.md +8 -0
  8. data/docs/ConversationPbxAvailablePhoneNumber.md +16 -0
  9. data/docs/ConversationPbxAvailablePhoneNumbersResponse.md +12 -0
  10. data/docs/ConversationPbxPhoneNumber.md +1 -0
  11. data/docs/ConversationPbxPhoneNumberPurchaseRequest.md +12 -0
  12. data/lib/ultracart_api/api/conversation_api.rb +513 -0
  13. data/lib/ultracart_api/models/conversation_agent_profile.rb +33 -1
  14. data/lib/ultracart_api/models/conversation_pbx_address.rb +445 -0
  15. data/lib/ultracart_api/models/conversation_pbx_address_response.rb +221 -0
  16. data/lib/ultracart_api/models/conversation_pbx_addresses_response.rb +186 -0
  17. data/lib/ultracart_api/models/conversation_pbx_available_phone_number.rb +374 -0
  18. data/lib/ultracart_api/models/conversation_pbx_available_phone_numbers_response.rb +223 -0
  19. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +11 -1
  20. data/lib/ultracart_api/models/conversation_pbx_phone_number_purchase_request.rb +324 -0
  21. data/lib/ultracart_api/version.rb +1 -1
  22. data/lib/ultracart_api.rb +6 -0
  23. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3b51df7edd5a60ea05218a6ea4258f0a978a6f4843c83b85cf77c4999931ec87
4
- data.tar.gz: 22f6cc8524585a2a45d27430475a731dc9e0feddc1a36a0a83c45767ec1bbb2b
3
+ metadata.gz: eab775ce86ed52cdc69e2847cdc76a4717898f27886b45506c0ac297f5c3b032
4
+ data.tar.gz: 42c24db4838ff80287c98f8dafb25d500f3b6f5df49aee0da27d54161dad56fa
5
5
  SHA512:
6
- metadata.gz: f6d40b9f5c53ac62306a1ac582783969c734d9569264be8df239d0e1ab452e8183c219262f0ed34c5b318f97673815d11af725a36405590f4ed650843f3f7d13
7
- data.tar.gz: f1c3b468d5c10b1d95456458c57ba346d56c1a701b59254fbcad8a9eb78ec0e331a0bca88546bdab1f880178ddc8ccd13f4163ad78cdf1274a0ad995bdbf75c8
6
+ metadata.gz: 1d41ae30ea93ac7ba09ffc7368b7d014d5098153967c40095536be11fac57fd21f03507d6a3490ab098f7eae7f841e213218e2e34bbefe82365227cb4c249b81
7
+ data.tar.gz: 03e2446165277a143aeb4f04cb0b1035abfba24bcaeaa3e3f1d136ca426ff09441304a4ed841723ca63968469b5e45a7ba6a385157f39c1401555a16535cc0d6
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.11.39
10
+ - Package version: 3.11.41
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.11.39.gem
27
+ gem install ./ultracart_api-3.11.41.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.11.39.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.11.41.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.11.39'
35
+ gem 'ultracart_api', '~> 3.11.41'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -138,9 +138,11 @@ Class | Method | HTTP request | Description
138
138
  *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
139
139
  *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
140
140
  *UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
141
+ *UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
141
142
  *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
142
143
  *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
143
144
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
145
+ *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
144
146
  *UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
145
147
  *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
146
148
  *UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
@@ -172,6 +174,8 @@ Class | Method | HTTP request | Description
172
174
  *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
173
175
  *UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
174
176
  *UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
177
+ *UltracartClient::ConversationApi* | [**get_pbx_address**](docs/ConversationApi.md#get_pbx_address) | **GET** /conversation/pbx/address/{conversationPbxAddressUuid} | Get pbx address
178
+ *UltracartClient::ConversationApi* | [**get_pbx_addresses**](docs/ConversationApi.md#get_pbx_addresses) | **GET** /conversation/pbx/address | Get pbx addresses
175
179
  *UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
176
180
  *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
177
181
  *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
@@ -200,6 +204,7 @@ Class | Method | HTTP request | Description
200
204
  *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
201
205
  *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
202
206
  *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
207
+ *UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
203
208
  *UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
204
209
  *UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
205
210
  *UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
@@ -211,8 +216,11 @@ Class | Method | HTTP request | Description
211
216
  *UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
212
217
  *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
213
218
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
219
+ *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
220
+ *UltracartClient::ConversationApi* | [**purchase_pbx_phone_number**](docs/ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number
214
221
  *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
215
222
  *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
223
+ *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
216
224
  *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
217
225
  *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
218
226
  *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
@@ -221,6 +229,7 @@ Class | Method | HTTP request | Description
221
229
  *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
222
230
  *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
223
231
  *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
232
+ *UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
224
233
  *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
225
234
  *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
226
235
  *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
@@ -810,6 +819,9 @@ Class | Method | HTTP request | Description
810
819
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
811
820
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
812
821
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
822
+ - [UltracartClient::ConversationPbxAddress](docs/ConversationPbxAddress.md)
823
+ - [UltracartClient::ConversationPbxAddressResponse](docs/ConversationPbxAddressResponse.md)
824
+ - [UltracartClient::ConversationPbxAddressesResponse](docs/ConversationPbxAddressesResponse.md)
813
825
  - [UltracartClient::ConversationPbxAgent](docs/ConversationPbxAgent.md)
814
826
  - [UltracartClient::ConversationPbxAgentResponse](docs/ConversationPbxAgentResponse.md)
815
827
  - [UltracartClient::ConversationPbxAgentsResponse](docs/ConversationPbxAgentsResponse.md)
@@ -819,6 +831,8 @@ Class | Method | HTTP request | Description
819
831
  - [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
820
832
  - [UltracartClient::ConversationPbxAudioUsageResponse](docs/ConversationPbxAudioUsageResponse.md)
821
833
  - [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
834
+ - [UltracartClient::ConversationPbxAvailablePhoneNumber](docs/ConversationPbxAvailablePhoneNumber.md)
835
+ - [UltracartClient::ConversationPbxAvailablePhoneNumbersResponse](docs/ConversationPbxAvailablePhoneNumbersResponse.md)
822
836
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
823
837
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
824
838
  - [UltracartClient::ConversationPbxMenu](docs/ConversationPbxMenu.md)
@@ -826,6 +840,7 @@ Class | Method | HTTP request | Description
826
840
  - [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
827
841
  - [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
828
842
  - [UltracartClient::ConversationPbxPhoneNumber](docs/ConversationPbxPhoneNumber.md)
843
+ - [UltracartClient::ConversationPbxPhoneNumberPurchaseRequest](docs/ConversationPbxPhoneNumberPurchaseRequest.md)
829
844
  - [UltracartClient::ConversationPbxPhoneNumberResponse](docs/ConversationPbxPhoneNumberResponse.md)
830
845
  - [UltracartClient::ConversationPbxPhoneNumbersResponse](docs/ConversationPbxPhoneNumbersResponse.md)
831
846
  - [UltracartClient::ConversationPbxQueue](docs/ConversationPbxQueue.md)
@@ -1608,6 +1623,8 @@ Not every change is committed to every SDK.
1608
1623
 
1609
1624
  | Version | Date | Comments |
1610
1625
  | --: | :-: | --- |
1626
+ | 3.11.41 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
1627
+ | 3.11.40 | 01/07/2026 | convseration - AI agent profile voice settings |
1611
1628
  | 3.11.39 | 12/31/2025 | conversations AI - queue AI settings |
1612
1629
  | 3.11.38 | 12/29/2025 | conversations - AI agent level capabilities |
1613
1630
  | 3.11.37 | 12/29/2025 | conversations - pbx agent AI flag |
data/docs/ConversationAgentProfile.md CHANGED
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
9
9
  **ai_persona** | **String** | Persona of this AI agent | [optional]
10
10
  **ai_sms_instructions** | **String** | Additional instructions for this AI when handle SMS messages | [optional]
11
11
  **ai_ticket_instructions** | **String** | Additional instructions for this AI when handling ticket draft replies | [optional]
12
+ **ai_voice_instructions** | **String** | Additional voice instructions for this AI when handling voice calls | [optional]
13
+ **ai_voice_personality** | **String** | Which AI voice personality to use when handling the call. | [optional]
12
14
  **chat_limit** | **Integer** | The number of engagement chats that can be pushed on them at any given time. | [optional]
13
15
  **default_language_iso_code** | **String** | The default language the agent is chatting in | [optional]
14
16
  **default_status** | **String** | Default status when the agent loads conversations app. | [optional]