ultracart_api 4.0.208 → 4.0.210

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 (34) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -4
  3. data/docs/AutoOrder.md +2 -0
  4. data/docs/AutoOrderItem.md +4 -0
  5. data/docs/ConversationApi.md +575 -0
  6. data/docs/ConversationPbxVoicemailMessage.md +42 -0
  7. data/docs/ConversationPbxVoicemailMessageResponse.md +26 -0
  8. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +26 -0
  9. data/docs/ConversationPbxVoicemailMessageSummary.md +36 -0
  10. data/docs/ItemApi.md +73 -0
  11. data/docs/WorkflowTask.md +2 -2
  12. data/docs/WorkflowTasksRequest.md +4 -0
  13. data/lib/ultracart_api/api/conversation_api.rb +524 -0
  14. data/lib/ultracart_api/api/item_api.rb +75 -0
  15. data/lib/ultracart_api/models/auto_order.rb +11 -1
  16. data/lib/ultracart_api/models/auto_order_item.rb +21 -1
  17. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +1 -1
  18. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +1 -1
  19. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +1 -1
  20. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +1 -1
  21. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +1 -1
  22. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +1 -1
  23. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
  24. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +1 -1
  25. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +1 -1
  26. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +374 -0
  27. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +256 -0
  28. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +258 -0
  29. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +344 -0
  30. data/lib/ultracart_api/models/workflow_task.rb +2 -2
  31. data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
  32. data/lib/ultracart_api/version.rb +1 -1
  33. data/lib/ultracart_api.rb +4 -0
  34. metadata +10 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0f75b47be794768d98f679b4155d0019e65e9f78dcd46a2112abbdaa942484a0
4
- data.tar.gz: 49ee89c7007ef3e5eeb6df94aca59280bd63ba6d8fc928f4b17e054456fc3aa1
3
+ metadata.gz: da3a35ee00c39026870aa6536ddd4184cf84225c49b18295a629e480bc618ab3
4
+ data.tar.gz: e378095bc5441ef69ff32f15852b8317fe6773d54ba8f91b12c0821c18aca166
5
5
  SHA512:
6
- metadata.gz: fab94bb1b7cd655140b7313e89e405c7135e30e5215512507e804ba9b171c9078a3db4a10193729323a91b81b69f35112a0dd48257928018d6771688962ee144
7
- data.tar.gz: 6b57e36d7a7fd555e9e9283ecf03ac3fbfcd40295c1ea26167516d8126de737119d010f2b7acbcadb32c2423a6b2d723a2111c15f1b6721e6b92249be717ef50
6
+ metadata.gz: 4070f5d3c14402624a41e9902ce3e23957c58368eea4f684aecf10787f106ec1957c405af4b88f6e1846446dc47ae8f8bdea8d3d48f7851b1f524d144e1e963a
7
+ data.tar.gz: 768cf1b893e271d107ca6af9ba871e5d9e5d061cdc84068d042b5dde36590293e3756d1834e7bad3137ad3770af9466e22146217fe84d1ef9a3aaf8ba014af59
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
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.0.208
10
+ - Package version: 4.0.210
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.208.gem
27
+ gem install ./ultracart_api-4.0.210.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.208.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.210.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.208'
36
+ gem 'ultracart_api', '~> 4.0.210'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -142,10 +142,12 @@ Class | Method | HTTP request | Description
142
142
  *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
143
143
  *UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
144
144
  *UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
145
+ *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
145
146
  *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
146
147
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
147
148
  *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
148
149
  *UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
150
+ *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
149
151
  *UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
150
152
  *UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
151
153
  *UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
@@ -170,6 +172,8 @@ Class | Method | HTTP request | Description
170
172
  *UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
171
173
  *UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
172
174
  *UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
175
+ *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
176
+ *UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
173
177
  *UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
174
178
  *UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
175
179
  *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
@@ -178,6 +182,8 @@ Class | Method | HTTP request | Description
178
182
  *UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
179
183
  *UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
180
184
  *UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
185
+ *UltracartClient::ConversationApi* | [**get_pbx_queue_voicemail**](docs/ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail
186
+ *UltracartClient::ConversationApi* | [**get_pbx_queue_voicemails**](docs/ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
181
187
  *UltracartClient::ConversationApi* | [**get_pbx_queues**](docs/ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
182
188
  *UltracartClient::ConversationApi* | [**get_pbx_time_based**](docs/ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
183
189
  *UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
@@ -198,6 +204,8 @@ Class | Method | HTTP request | Description
198
204
  *UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
199
205
  *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
200
206
  *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
207
+ *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
+ *UltracartClient::ConversationApi* | [**listened_pbx_queue_voicemail**](docs/ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened | Listened Queue Voicemail
201
209
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
202
210
  *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
203
211
  *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
@@ -304,6 +312,7 @@ Class | Method | HTTP request | Description
304
312
  *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
305
313
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
306
314
  *UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
315
+ *UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
307
316
  *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
308
317
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
309
318
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
@@ -778,6 +787,10 @@ Class | Method | HTTP request | Description
778
787
  - [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
779
788
  - [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
780
789
  - [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
790
+ - [UltracartClient::ConversationPbxVoicemailMessage](docs/ConversationPbxVoicemailMessage.md)
791
+ - [UltracartClient::ConversationPbxVoicemailMessageResponse](docs/ConversationPbxVoicemailMessageResponse.md)
792
+ - [UltracartClient::ConversationPbxVoicemailMessageSummariesResponse](docs/ConversationPbxVoicemailMessageSummariesResponse.md)
793
+ - [UltracartClient::ConversationPbxVoicemailMessageSummary](docs/ConversationPbxVoicemailMessageSummary.md)
781
794
  - [UltracartClient::ConversationPermissions](docs/ConversationPermissions.md)
782
795
  - [UltracartClient::ConversationPermissionsResponse](docs/ConversationPermissionsResponse.md)
783
796
  - [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
@@ -1494,6 +1507,8 @@ Not every change is committed to every SDK.
1494
1507
 
1495
1508
  | Version | Date | Comments |
1496
1509
  | --: | :-: | --- |
1510
+ | 4.0.210 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
1511
+ | 4.0.209 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
1497
1512
  | 4.0.208 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
1498
1513
  | 4.0.207 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
1499
1514
  | 4.0.206 | 03/25/2024 | added sales_rep_code to Channel partner order |
data/docs/AutoOrder.md CHANGED
@@ -21,6 +21,7 @@
21
21
  | **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] |
22
22
  | **logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional] |
23
23
  | **management** | [**AutoOrderManagement**](AutoOrderManagement.md) | | [optional] |
24
+ | **merchant_id** | **String** | UltraCart merchant ID owning this order | [optional] |
24
25
  | **next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional] |
25
26
  | **original_order** | [**Order**](Order.md) | | [optional] |
26
27
  | **original_order_id** | **String** | The original order id that this auto order is associated with. | [optional] |
@@ -52,6 +53,7 @@ instance = UltracartClient::AutoOrder.new(
52
53
  items: null,
53
54
  logs: null,
54
55
  management: null,
56
+ merchant_id: null,
55
57
  next_attempt: null,
56
58
  original_order: null,
57
59
  original_order_id: null,
data/docs/AutoOrderItem.md CHANGED
@@ -11,11 +11,13 @@
11
11
  | **arbitrary_unit_cost** | **Float** | Arbitrary unit cost that rebills of this item should occur at | [optional] |
12
12
  | **arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional] |
13
13
  | **auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional] |
14
+ | **calculated_next_shipment_dts** | **String** | Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item | [optional] |
14
15
  | **first_order_dts** | **String** | Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet. | [optional] |
15
16
  | **frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional] |
16
17
  | **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
17
18
  | **last_order_dts** | **String** | Date/time of the last order of this item | [optional] |
18
19
  | **life_time_value** | **Float** | The life time value of this item including the original purchase | [optional] |
20
+ | **next_item_id** | **String** | Calculated next item id | [optional] |
19
21
  | **next_preshipment_notice_dts** | **String** | The date/time of when the next pre-shipment notice should be sent | [optional] |
20
22
  | **next_shipment_dts** | **String** | Date/time that this item is scheduled to rebill | [optional] |
21
23
  | **no_order_after_dts** | **String** | Date/time after which no additional rebills of this item should occur | [optional] |
@@ -44,11 +46,13 @@ instance = UltracartClient::AutoOrderItem.new(
44
46
  arbitrary_unit_cost: null,
45
47
  arbitrary_unit_cost_remaining_orders: null,
46
48
  auto_order_item_oid: null,
49
+ calculated_next_shipment_dts: null,
47
50
  first_order_dts: null,
48
51
  frequency: null,
49
52
  future_schedules: null,
50
53
  last_order_dts: null,
51
54
  life_time_value: null,
55
+ next_item_id: null,
52
56
  next_preshipment_notice_dts: null,
53
57
  next_shipment_dts: null,
54
58
  no_order_after_dts: null,