ultracart_api 4.0.209 → 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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bf4bbb3e50d75d99e79d59263e08fdc9a5cafee1d534309493f2cbc06609552f
4
- data.tar.gz: 16b085c366a7c16b643df24121e4eb3864209362e89a7e51d0d44f4b370c4280
3
+ metadata.gz: da3a35ee00c39026870aa6536ddd4184cf84225c49b18295a629e480bc618ab3
4
+ data.tar.gz: e378095bc5441ef69ff32f15852b8317fe6773d54ba8f91b12c0821c18aca166
5
5
  SHA512:
6
- metadata.gz: 628e84b3cf1a43303f8b7bfbc66a85c67f62335598e14751a1269c40c475eeacad2bb21a52a489b1acde82ea6cf0382e72ff2e653402a274a1ea44167d7ffb21
7
- data.tar.gz: c1a629d28955e517201b4c715df4371c4be4ebc603494241576fcc5a5edf97a6b4b0425253685909e964e67429fce717de307e02552165f43908f36ea1418ca6
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.209
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.209.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.209.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.209'
36
+ gem 'ultracart_api', '~> 4.0.210'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -147,6 +147,7 @@ Class | Method | HTTP request | Description
147
147
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
148
148
  *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
149
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
150
151
  *UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
151
152
  *UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
152
153
  *UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
@@ -204,6 +205,7 @@ Class | Method | HTTP request | Description
204
205
  *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
205
206
  *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
206
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
207
209
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
208
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
209
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
@@ -310,6 +312,7 @@ Class | Method | HTTP request | Description
310
312
  *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
311
313
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
312
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
313
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
314
317
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
315
318
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
@@ -1504,6 +1507,7 @@ Not every change is committed to every SDK.
1504
1507
 
1505
1508
  | Version | Date | Comments |
1506
1509
  | --: | :-: | --- |
1510
+ | 4.0.210 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
1507
1511
  | 4.0.209 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
1508
1512
  | 4.0.208 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
1509
1513
  | 4.0.207 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
@@ -11,6 +11,7 @@
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] |
@@ -45,6 +46,7 @@ instance = UltracartClient::AutoOrderItem.new(
45
46
  arbitrary_unit_cost: null,
46
47
  arbitrary_unit_cost_remaining_orders: null,
47
48
  auto_order_item_oid: null,
49
+ calculated_next_shipment_dts: null,
48
50
  first_order_dts: null,
49
51
  frequency: null,
50
52
  future_schedules: null,
@@ -13,6 +13,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
13
13
  | [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu |
14
14
  | [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber |
15
15
  | [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue |
16
+ | [**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail |
16
17
  | [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
17
18
  | [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange |
18
19
  | [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox |
@@ -70,6 +71,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
70
71
  | [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
71
72
  | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
72
73
  | [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
74
+ | [**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened | Listened Queue Voicemail |
73
75
  | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
74
76
  | [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue |
75
77
  | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
@@ -725,6 +727,78 @@ end
725
727
  - **Accept**: application/json
726
728
 
727
729
 
730
+ ## delete_pbx_queue_voicemail
731
+
732
+ > delete_pbx_queue_voicemail(queue_uuid, recording_sid)
733
+
734
+ Delete Queue Voicemail
735
+
736
+ Delete pbx queue Voicemail
737
+
738
+ ### Examples
739
+
740
+ ```ruby
741
+ require 'time'
742
+ require 'ultracart_api'
743
+ require 'json'
744
+ require 'yaml'
745
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
746
+
747
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
748
+ # As such, this might not be the best way to use this object.
749
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
750
+
751
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
752
+ queue_uuid = 'queue_uuid_example' # String |
753
+ recording_sid = 'recording_sid_example' # String |
754
+
755
+ begin
756
+ # Delete Queue Voicemail
757
+ api_instance.delete_pbx_queue_voicemail(queue_uuid, recording_sid)
758
+ rescue UltracartClient::ApiError => e
759
+ puts "Error when calling ConversationApi->delete_pbx_queue_voicemail: #{e}"
760
+ end
761
+ ```
762
+
763
+ #### Using the delete_pbx_queue_voicemail_with_http_info variant
764
+
765
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
766
+
767
+ > <Array(nil, Integer, Hash)> delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
768
+
769
+ ```ruby
770
+ begin
771
+ # Delete Queue Voicemail
772
+ data, status_code, headers = api_instance.delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
773
+ p status_code # => 2xx
774
+ p headers # => { ... }
775
+ p data # => nil
776
+ rescue UltracartClient::ApiError => e
777
+ puts "Error when calling ConversationApi->delete_pbx_queue_voicemail_with_http_info: #{e}"
778
+ end
779
+ ```
780
+
781
+ ### Parameters
782
+
783
+ | Name | Type | Description | Notes |
784
+ | ---- | ---- | ----------- | ----- |
785
+ | **queue_uuid** | **String** | | |
786
+ | **recording_sid** | **String** | | |
787
+
788
+ ### Return type
789
+
790
+ nil (empty response body)
791
+
792
+ ### Authorization
793
+
794
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
795
+
796
+ ### HTTP request headers
797
+
798
+ - **Content-Type**: Not defined
799
+ - **Accept**: application/json
800
+
801
+
728
802
  ## delete_pbx_time_based
729
803
 
730
804
  > <ConversationPbxTimeBasedResponse> delete_pbx_time_based(conversation_pbx_time_based_uuid)
@@ -4735,6 +4809,78 @@ nil (empty response body)
4735
4809
  - **Accept**: application/json
4736
4810
 
4737
4811
 
4812
+ ## listened_pbx_queue_voicemail
4813
+
4814
+ > listened_pbx_queue_voicemail(queue_uuid, recording_sid)
4815
+
4816
+ Listened Queue Voicemail
4817
+
4818
+ Listened pbx queue Voicemail
4819
+
4820
+ ### Examples
4821
+
4822
+ ```ruby
4823
+ require 'time'
4824
+ require 'ultracart_api'
4825
+ require 'json'
4826
+ require 'yaml'
4827
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
4828
+
4829
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
4830
+ # As such, this might not be the best way to use this object.
4831
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
4832
+
4833
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
4834
+ queue_uuid = 'queue_uuid_example' # String |
4835
+ recording_sid = 'recording_sid_example' # String |
4836
+
4837
+ begin
4838
+ # Listened Queue Voicemail
4839
+ api_instance.listened_pbx_queue_voicemail(queue_uuid, recording_sid)
4840
+ rescue UltracartClient::ApiError => e
4841
+ puts "Error when calling ConversationApi->listened_pbx_queue_voicemail: #{e}"
4842
+ end
4843
+ ```
4844
+
4845
+ #### Using the listened_pbx_queue_voicemail_with_http_info variant
4846
+
4847
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
4848
+
4849
+ > <Array(nil, Integer, Hash)> listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
4850
+
4851
+ ```ruby
4852
+ begin
4853
+ # Listened Queue Voicemail
4854
+ data, status_code, headers = api_instance.listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
4855
+ p status_code # => 2xx
4856
+ p headers # => { ... }
4857
+ p data # => nil
4858
+ rescue UltracartClient::ApiError => e
4859
+ puts "Error when calling ConversationApi->listened_pbx_queue_voicemail_with_http_info: #{e}"
4860
+ end
4861
+ ```
4862
+
4863
+ ### Parameters
4864
+
4865
+ | Name | Type | Description | Notes |
4866
+ | ---- | ---- | ----------- | ----- |
4867
+ | **queue_uuid** | **String** | | |
4868
+ | **recording_sid** | **String** | | |
4869
+
4870
+ ### Return type
4871
+
4872
+ nil (empty response body)
4873
+
4874
+ ### Authorization
4875
+
4876
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4877
+
4878
+ ### HTTP request headers
4879
+
4880
+ - **Content-Type**: Not defined
4881
+ - **Accept**: application/json
4882
+
4883
+
4738
4884
  ## mark_read_conversation
4739
4885
 
4740
4886
  > mark_read_conversation(conversation_uuid)
data/docs/ItemApi.md CHANGED
@@ -20,6 +20,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
20
20
  | [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
21
21
  | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
22
22
  | [**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review |
23
+ | [**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute |
23
24
  | [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
24
25
  | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
25
26
  | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
@@ -1226,6 +1227,78 @@ end
1226
1227
  - **Accept**: application/json
1227
1228
 
1228
1229
 
1230
+ ## insert_update_item_content_attribute
1231
+
1232
+ > insert_update_item_content_attribute(merchant_item_oid, item_attribute)
1233
+
1234
+ Upsert an item content attribute
1235
+
1236
+ Update an item content attribute, creating it new if it does not yet exist.
1237
+
1238
+ ### Examples
1239
+
1240
+ ```ruby
1241
+ require 'time'
1242
+ require 'ultracart_api'
1243
+ require 'json'
1244
+ require 'yaml'
1245
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1246
+
1247
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1248
+ # As such, this might not be the best way to use this object.
1249
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1250
+
1251
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1252
+ merchant_item_oid = 56 # Integer | The item oid to modify.
1253
+ item_attribute = UltracartClient::ItemContentAttribute.new # ItemContentAttribute | Item content attribute to upsert
1254
+
1255
+ begin
1256
+ # Upsert an item content attribute
1257
+ api_instance.insert_update_item_content_attribute(merchant_item_oid, item_attribute)
1258
+ rescue UltracartClient::ApiError => e
1259
+ puts "Error when calling ItemApi->insert_update_item_content_attribute: #{e}"
1260
+ end
1261
+ ```
1262
+
1263
+ #### Using the insert_update_item_content_attribute_with_http_info variant
1264
+
1265
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1266
+
1267
+ > <Array(nil, Integer, Hash)> insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute)
1268
+
1269
+ ```ruby
1270
+ begin
1271
+ # Upsert an item content attribute
1272
+ data, status_code, headers = api_instance.insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute)
1273
+ p status_code # => 2xx
1274
+ p headers # => { ... }
1275
+ p data # => nil
1276
+ rescue UltracartClient::ApiError => e
1277
+ puts "Error when calling ItemApi->insert_update_item_content_attribute_with_http_info: #{e}"
1278
+ end
1279
+ ```
1280
+
1281
+ ### Parameters
1282
+
1283
+ | Name | Type | Description | Notes |
1284
+ | ---- | ---- | ----------- | ----- |
1285
+ | **merchant_item_oid** | **Integer** | The item oid to modify. | |
1286
+ | **item_attribute** | [**ItemContentAttribute**](ItemContentAttribute.md) | Item content attribute to upsert | |
1287
+
1288
+ ### Return type
1289
+
1290
+ nil (empty response body)
1291
+
1292
+ ### Authorization
1293
+
1294
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1295
+
1296
+ ### HTTP request headers
1297
+
1298
+ - **Content-Type**: application/json; charset=UTF-8
1299
+ - **Accept**: application/json
1300
+
1301
+
1229
1302
  ## update_digital_item
1230
1303
 
1231
1304
  > <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
data/docs/WorkflowTask.md CHANGED
@@ -16,14 +16,14 @@
16
16
  | **dependant_workflow_task_uuid** | **String** | Dependant Workflow Task UUID (must be completed before this task can be completed) | [optional] |
17
17
  | **due_dts** | **String** | Date/time that the workflow task is due | [optional] |
18
18
  | **expiration_dts** | **String** | Date/time that the workflow task will expire and be closed. This is set by system generated tasks. | [optional] |
19
- | **global_task_number** | **Integer** | Global task numer | [optional] |
19
+ | **global_task_number** | **Integer** | Global task number | [optional] |
20
20
  | **histories** | [**Array&lt;WorkflowTaskHistory&gt;**](WorkflowTaskHistory.md) | Array of history records for the task | [optional] |
21
21
  | **last_update_dts** | **String** | Date/time that the workflow task was last updated | [optional] |
22
22
  | **merchant_id** | **String** | Merchant ID | [optional] |
23
23
  | **notes** | [**Array&lt;WorkflowNote&gt;**](WorkflowNote.md) | Notes on the Workflow Task | [optional] |
24
24
  | **object_email** | **String** | Object is associated with customer email | [optional] |
25
25
  | **object_id** | **String** | Object ID | [optional] |
26
- | **object_task_number** | **Integer** | Object specific task numer | [optional] |
26
+ | **object_task_number** | **Integer** | Object specific task number | [optional] |
27
27
  | **object_type** | **String** | Object Type | [optional] |
28
28
  | **object_url** | **String** | Object URL | [optional] |
29
29
  | **priority** | **String** | Priority | [optional] |
@@ -4,8 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **assigned_to_group** | **String** | Assigned to group | [optional] |
7
8
  | **assigned_to_group_id** | **Integer** | Assigned to group ID | [optional] |
8
9
  | **assigned_to_me** | **Boolean** | Tasks are assigned to me either by direct user id or a group that the user is a member of | [optional] |
10
+ | **assigned_to_user** | **String** | Assigned to user | [optional] |
9
11
  | **assigned_to_user_id** | **Integer** | Assigned to user ID | [optional] |
10
12
  | **created_by** | [**WorkflowUser**](WorkflowUser.md) | | [optional] |
11
13
  | **created_dts_begin** | **String** | Date/time that the workflow task was created | [optional] |
@@ -29,8 +31,10 @@
29
31
  require 'ultracart_api'
30
32
 
31
33
  instance = UltracartClient::WorkflowTasksRequest.new(
34
+ assigned_to_group: null,
32
35
  assigned_to_group_id: null,
33
36
  assigned_to_me: null,
37
+ assigned_to_user: null,
34
38
  assigned_to_user_id: null,
35
39
  created_by: null,
36
40
  created_dts_begin: null,
@@ -608,6 +608,76 @@ module UltracartClient
608
608
  return data, status_code, headers
609
609
  end
610
610
 
611
+ # Delete Queue Voicemail
612
+ # Delete pbx queue Voicemail
613
+ # @param queue_uuid [String]
614
+ # @param recording_sid [String]
615
+ # @param [Hash] opts the optional parameters
616
+ # @return [nil]
617
+ def delete_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
618
+ delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
619
+ nil
620
+ end
621
+
622
+ # Delete Queue Voicemail
623
+ # Delete pbx queue Voicemail
624
+ # @param queue_uuid [String]
625
+ # @param recording_sid [String]
626
+ # @param [Hash] opts the optional parameters
627
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
628
+ def delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
629
+ if @api_client.config.debugging
630
+ @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_queue_voicemail ...'
631
+ end
632
+ # verify the required parameter 'queue_uuid' is set
633
+ if @api_client.config.client_side_validation && queue_uuid.nil?
634
+ fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.delete_pbx_queue_voicemail"
635
+ end
636
+ # verify the required parameter 'recording_sid' is set
637
+ if @api_client.config.client_side_validation && recording_sid.nil?
638
+ fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_queue_voicemail"
639
+ end
640
+ # resource path
641
+ local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s)).sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
642
+
643
+ # query parameters
644
+ query_params = opts[:query_params] || {}
645
+
646
+ # header parameters
647
+ header_params = opts[:header_params] || {}
648
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
649
+ # HTTP header 'Accept' (if needed)
650
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
651
+
652
+ # form parameters
653
+ form_params = opts[:form_params] || {}
654
+
655
+ # http body (model)
656
+ post_body = opts[:debug_body]
657
+
658
+ # return_type
659
+ return_type = opts[:debug_return_type]
660
+
661
+ # auth_names
662
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
663
+
664
+ new_options = opts.merge(
665
+ :operation => :"ConversationApi.delete_pbx_queue_voicemail",
666
+ :header_params => header_params,
667
+ :query_params => query_params,
668
+ :form_params => form_params,
669
+ :body => post_body,
670
+ :auth_names => auth_names,
671
+ :return_type => return_type
672
+ )
673
+
674
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
675
+ if @api_client.config.debugging
676
+ @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
677
+ end
678
+ return data, status_code, headers
679
+ end
680
+
611
681
  # Delete pbx timeBased
612
682
  # Delete a pbx timeBased
613
683
  # @param conversation_pbx_time_based_uuid [String]
@@ -4243,6 +4313,76 @@ module UltracartClient
4243
4313
  return data, status_code, headers
4244
4314
  end
4245
4315
 
4316
+ # Listened Queue Voicemail
4317
+ # Listened pbx queue Voicemail
4318
+ # @param queue_uuid [String]
4319
+ # @param recording_sid [String]
4320
+ # @param [Hash] opts the optional parameters
4321
+ # @return [nil]
4322
+ def listened_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
4323
+ listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
4324
+ nil
4325
+ end
4326
+
4327
+ # Listened Queue Voicemail
4328
+ # Listened pbx queue Voicemail
4329
+ # @param queue_uuid [String]
4330
+ # @param recording_sid [String]
4331
+ # @param [Hash] opts the optional parameters
4332
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
4333
+ def listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
4334
+ if @api_client.config.debugging
4335
+ @api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_queue_voicemail ...'
4336
+ end
4337
+ # verify the required parameter 'queue_uuid' is set
4338
+ if @api_client.config.client_side_validation && queue_uuid.nil?
4339
+ fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.listened_pbx_queue_voicemail"
4340
+ end
4341
+ # verify the required parameter 'recording_sid' is set
4342
+ if @api_client.config.client_side_validation && recording_sid.nil?
4343
+ fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
4344
+ end
4345
+ # resource path
4346
+ local_var_path = '/conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s)).sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
4347
+
4348
+ # query parameters
4349
+ query_params = opts[:query_params] || {}
4350
+
4351
+ # header parameters
4352
+ header_params = opts[:header_params] || {}
4353
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4354
+ # HTTP header 'Accept' (if needed)
4355
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4356
+
4357
+ # form parameters
4358
+ form_params = opts[:form_params] || {}
4359
+
4360
+ # http body (model)
4361
+ post_body = opts[:debug_body]
4362
+
4363
+ # return_type
4364
+ return_type = opts[:debug_return_type]
4365
+
4366
+ # auth_names
4367
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4368
+
4369
+ new_options = opts.merge(
4370
+ :operation => :"ConversationApi.listened_pbx_queue_voicemail",
4371
+ :header_params => header_params,
4372
+ :query_params => query_params,
4373
+ :form_params => form_params,
4374
+ :body => post_body,
4375
+ :auth_names => auth_names,
4376
+ :return_type => return_type
4377
+ )
4378
+
4379
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4380
+ if @api_client.config.debugging
4381
+ @api_client.config.logger.debug "API called: ConversationApi#listened_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4382
+ end
4383
+ return data, status_code, headers
4384
+ end
4385
+
4246
4386
  # Mark a conversation as read
4247
4387
  # Mark a conversation as read
4248
4388
  # @param conversation_uuid [String]
@@ -1146,6 +1146,81 @@ module UltracartClient
1146
1146
  return data, status_code, headers
1147
1147
  end
1148
1148
 
1149
+ # Upsert an item content attribute
1150
+ # Update an item content attribute, creating it new if it does not yet exist.
1151
+ # @param merchant_item_oid [Integer] The item oid to modify.
1152
+ # @param item_attribute [ItemContentAttribute] Item content attribute to upsert
1153
+ # @param [Hash] opts the optional parameters
1154
+ # @return [nil]
1155
+ def insert_update_item_content_attribute(merchant_item_oid, item_attribute, opts = {})
1156
+ insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute, opts)
1157
+ nil
1158
+ end
1159
+
1160
+ # Upsert an item content attribute
1161
+ # Update an item content attribute, creating it new if it does not yet exist.
1162
+ # @param merchant_item_oid [Integer] The item oid to modify.
1163
+ # @param item_attribute [ItemContentAttribute] Item content attribute to upsert
1164
+ # @param [Hash] opts the optional parameters
1165
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1166
+ def insert_update_item_content_attribute_with_http_info(merchant_item_oid, item_attribute, opts = {})
1167
+ if @api_client.config.debugging
1168
+ @api_client.config.logger.debug 'Calling API: ItemApi.insert_update_item_content_attribute ...'
1169
+ end
1170
+ # verify the required parameter 'merchant_item_oid' is set
1171
+ if @api_client.config.client_side_validation && merchant_item_oid.nil?
1172
+ fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.insert_update_item_content_attribute"
1173
+ end
1174
+ # verify the required parameter 'item_attribute' is set
1175
+ if @api_client.config.client_side_validation && item_attribute.nil?
1176
+ fail ArgumentError, "Missing the required parameter 'item_attribute' when calling ItemApi.insert_update_item_content_attribute"
1177
+ end
1178
+ # resource path
1179
+ local_var_path = '/item/items/{merchant_item_oid}/content/attributes'.sub('{' + 'merchant_item_oid' + '}', CGI.escape(merchant_item_oid.to_s))
1180
+
1181
+ # query parameters
1182
+ query_params = opts[:query_params] || {}
1183
+
1184
+ # header parameters
1185
+ header_params = opts[:header_params] || {}
1186
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1187
+ # HTTP header 'Accept' (if needed)
1188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1189
+ # HTTP header 'Content-Type'
1190
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1191
+ if !content_type.nil?
1192
+ header_params['Content-Type'] = content_type
1193
+ end
1194
+
1195
+ # form parameters
1196
+ form_params = opts[:form_params] || {}
1197
+
1198
+ # http body (model)
1199
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_attribute)
1200
+
1201
+ # return_type
1202
+ return_type = opts[:debug_return_type]
1203
+
1204
+ # auth_names
1205
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1206
+
1207
+ new_options = opts.merge(
1208
+ :operation => :"ItemApi.insert_update_item_content_attribute",
1209
+ :header_params => header_params,
1210
+ :query_params => query_params,
1211
+ :form_params => form_params,
1212
+ :body => post_body,
1213
+ :auth_names => auth_names,
1214
+ :return_type => return_type
1215
+ )
1216
+
1217
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1218
+ if @api_client.config.debugging
1219
+ @api_client.config.logger.debug "API called: ItemApi#insert_update_item_content_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1220
+ end
1221
+ return data, status_code, headers
1222
+ end
1223
+
1149
1224
  # Updates a file within the digital library
1150
1225
  # Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
1151
1226
  # @param digital_item_oid [Integer] The digital item oid to update.
@@ -36,6 +36,9 @@ module UltracartClient
36
36
  # Primary key of AutoOrderItem
37
37
  attr_accessor :auto_order_item_oid
38
38
 
39
+ # Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item
40
+ attr_accessor :calculated_next_shipment_dts
41
+
39
42
  # Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
40
43
  attr_accessor :first_order_dts
41
44
 
@@ -127,6 +130,7 @@ module UltracartClient
127
130
  :'arbitrary_unit_cost' => :'arbitrary_unit_cost',
128
131
  :'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
129
132
  :'auto_order_item_oid' => :'auto_order_item_oid',
133
+ :'calculated_next_shipment_dts' => :'calculated_next_shipment_dts',
130
134
  :'first_order_dts' => :'first_order_dts',
131
135
  :'frequency' => :'frequency',
132
136
  :'future_schedules' => :'future_schedules',
@@ -165,6 +169,7 @@ module UltracartClient
165
169
  :'arbitrary_unit_cost' => :'Float',
166
170
  :'arbitrary_unit_cost_remaining_orders' => :'Integer',
167
171
  :'auto_order_item_oid' => :'Integer',
172
+ :'calculated_next_shipment_dts' => :'String',
168
173
  :'first_order_dts' => :'String',
169
174
  :'frequency' => :'String',
170
175
  :'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
@@ -237,6 +242,10 @@ module UltracartClient
237
242
  self.auto_order_item_oid = attributes[:'auto_order_item_oid']
238
243
  end
239
244
 
245
+ if attributes.key?(:'calculated_next_shipment_dts')
246
+ self.calculated_next_shipment_dts = attributes[:'calculated_next_shipment_dts']
247
+ end
248
+
240
249
  if attributes.key?(:'first_order_dts')
241
250
  self.first_order_dts = attributes[:'first_order_dts']
242
251
  end
@@ -359,6 +368,7 @@ module UltracartClient
359
368
  arbitrary_unit_cost == o.arbitrary_unit_cost &&
360
369
  arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
361
370
  auto_order_item_oid == o.auto_order_item_oid &&
371
+ calculated_next_shipment_dts == o.calculated_next_shipment_dts &&
362
372
  first_order_dts == o.first_order_dts &&
363
373
  frequency == o.frequency &&
364
374
  future_schedules == o.future_schedules &&
@@ -390,7 +400,7 @@ module UltracartClient
390
400
  # Calculates hash code according to all attributes.
391
401
  # @return [Integer] Hash code
392
402
  def hash
393
- [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
403
+ [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, calculated_next_shipment_dts, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
394
404
  end
395
405
 
396
406
  # Builds the object from hash
@@ -50,7 +50,7 @@ module UltracartClient
50
50
  # Date/time that the workflow task will expire and be closed. This is set by system generated tasks.
51
51
  attr_accessor :expiration_dts
52
52
 
53
- # Global task numer
53
+ # Global task number
54
54
  attr_accessor :global_task_number
55
55
 
56
56
  # Array of history records for the task
@@ -71,7 +71,7 @@ module UltracartClient
71
71
  # Object ID
72
72
  attr_accessor :object_id
73
73
 
74
- # Object specific task numer
74
+ # Object specific task number
75
75
  attr_accessor :object_task_number
76
76
 
77
77
  # Object Type
@@ -15,12 +15,18 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class WorkflowTasksRequest
18
+ # Assigned to group
19
+ attr_accessor :assigned_to_group
20
+
18
21
  # Assigned to group ID
19
22
  attr_accessor :assigned_to_group_id
20
23
 
21
24
  # Tasks are assigned to me either by direct user id or a group that the user is a member of
22
25
  attr_accessor :assigned_to_me
23
26
 
27
+ # Assigned to user
28
+ attr_accessor :assigned_to_user
29
+
24
30
  # Assigned to user ID
25
31
  attr_accessor :assigned_to_user_id
26
32
 
@@ -93,8 +99,10 @@ module UltracartClient
93
99
  # Attribute mapping from ruby-style variable name to JSON key.
94
100
  def self.attribute_map
95
101
  {
102
+ :'assigned_to_group' => :'assigned_to_group',
96
103
  :'assigned_to_group_id' => :'assigned_to_group_id',
97
104
  :'assigned_to_me' => :'assigned_to_me',
105
+ :'assigned_to_user' => :'assigned_to_user',
98
106
  :'assigned_to_user_id' => :'assigned_to_user_id',
99
107
  :'created_by' => :'created_by',
100
108
  :'created_dts_begin' => :'created_dts_begin',
@@ -122,8 +130,10 @@ module UltracartClient
122
130
  # Attribute type mapping.
123
131
  def self.openapi_types
124
132
  {
133
+ :'assigned_to_group' => :'String',
125
134
  :'assigned_to_group_id' => :'Integer',
126
135
  :'assigned_to_me' => :'Boolean',
136
+ :'assigned_to_user' => :'String',
127
137
  :'assigned_to_user_id' => :'Integer',
128
138
  :'created_by' => :'WorkflowUser',
129
139
  :'created_dts_begin' => :'String',
@@ -164,6 +174,10 @@ module UltracartClient
164
174
  h[k.to_sym] = v
165
175
  }
166
176
 
177
+ if attributes.key?(:'assigned_to_group')
178
+ self.assigned_to_group = attributes[:'assigned_to_group']
179
+ end
180
+
167
181
  if attributes.key?(:'assigned_to_group_id')
168
182
  self.assigned_to_group_id = attributes[:'assigned_to_group_id']
169
183
  end
@@ -172,6 +186,10 @@ module UltracartClient
172
186
  self.assigned_to_me = attributes[:'assigned_to_me']
173
187
  end
174
188
 
189
+ if attributes.key?(:'assigned_to_user')
190
+ self.assigned_to_user = attributes[:'assigned_to_user']
191
+ end
192
+
175
193
  if attributes.key?(:'assigned_to_user_id')
176
194
  self.assigned_to_user_id = attributes[:'assigned_to_user_id']
177
195
  end
@@ -293,8 +311,10 @@ module UltracartClient
293
311
  def ==(o)
294
312
  return true if self.equal?(o)
295
313
  self.class == o.class &&
314
+ assigned_to_group == o.assigned_to_group &&
296
315
  assigned_to_group_id == o.assigned_to_group_id &&
297
316
  assigned_to_me == o.assigned_to_me &&
317
+ assigned_to_user == o.assigned_to_user &&
298
318
  assigned_to_user_id == o.assigned_to_user_id &&
299
319
  created_by == o.created_by &&
300
320
  created_dts_begin == o.created_dts_begin &&
@@ -322,7 +342,7 @@ module UltracartClient
322
342
  # Calculates hash code according to all attributes.
323
343
  # @return [Integer] Hash code
324
344
  def hash
325
- [assigned_to_group_id, assigned_to_me, assigned_to_user_id, created_by, created_dts_begin, created_dts_end, delay_until_dts_begin, delay_until_dts_end, due_dts_begin, due_dts_end, last_update_dts_begin, last_update_dts_end, object_email, object_type, priority, status, tags, unassigned].hash
345
+ [assigned_to_group, assigned_to_group_id, assigned_to_me, assigned_to_user, assigned_to_user_id, created_by, created_dts_begin, created_dts_end, delay_until_dts_begin, delay_until_dts_end, due_dts_begin, due_dts_end, last_update_dts_begin, last_update_dts_end, object_email, object_type, priority, status, tags, unassigned].hash
326
346
  end
327
347
 
328
348
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.0.209'
14
+ VERSION = '4.0.210'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.209
4
+ version: 4.0.210
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-01 00:00:00.000000000 Z
11
+ date: 2024-04-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus