ultracart_api 4.0.210 → 4.0.212
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 +4 -4
- data/README.md +11 -5
- data/docs/AutoOrderApi.md +78 -0
- data/docs/AutoOrderConsolidate.md +18 -0
- data/docs/ConversationAgentAuth.md +6 -0
- data/docs/ConversationApi.md +5 -5
- data/docs/ConversationPbxAudioUploadUrl.md +20 -0
- data/docs/ConversationPbxAudioUploadUrlResponse.md +26 -0
- data/docs/ConversationPbxCustomerSnapshotResponse.md +2 -2
- data/docs/ConversationPbxQueue.md +3 -1
- data/docs/EmailCommseqEmail.md +16 -0
- data/docs/ItemChargeback.md +2 -2
- data/docs/OrderRefundableResponse.md +2 -0
- data/lib/ultracart_api/api/auto_order_api.rb +78 -0
- data/lib/ultracart_api/api/conversation_api.rb +4 -4
- data/lib/ultracart_api/models/auto_order_consolidate.rb +221 -0
- data/lib/ultracart_api/models/conversation_agent_auth.rb +28 -1
- data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +228 -0
- data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +9 -7
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +14 -4
- data/lib/ultracart_api/models/email_commseq_email.rb +73 -1
- data/lib/ultracart_api/models/item_chargeback.rb +2 -2
- data/lib/ultracart_api/models/order_refundable_response.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -0
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5e7e712f4270c55ed9409d21270b33752d8ab0b833ddaf6be214b68d48fc34b9
|
4
|
+
data.tar.gz: 3064fb944241341c889088914f04c268f6d8e4d3b6df5cbafd9e00443b645267
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d07c348fb937c6e0ae64950ad79e9a25372a5b8dc7e4e8cc52fc3be67d755e52704fab99995286314fe19af52f712659ec0cdd1fcd07c97a26c4348bcac30778
|
7
|
+
data.tar.gz: 9b768fde871d5a5931858ee672448c074f36084874697868b2f5397216e11b96b8e3db14398062c8de589100347393f4bde9e241f40e9b75540ddb3e644d34e0
|
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.
|
10
|
+
- Package version: 4.0.212
|
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.
|
27
|
+
gem install ./ultracart_api-4.0.212.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.212.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.
|
36
|
+
gem 'ultracart_api', '~> 4.0.212'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
|
|
94
94
|
------------ | ------------- | ------------- | -------------
|
95
95
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
96
96
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
97
|
+
*UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
|
97
98
|
*UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
|
98
99
|
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
99
100
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
@@ -205,7 +206,7 @@ Class | Method | HTTP request | Description
|
|
205
206
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
206
207
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
207
208
|
*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/
|
209
|
+
*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
210
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
210
211
|
*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
212
|
*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
|
@@ -613,6 +614,7 @@ Class | Method | HTTP request | Description
|
|
613
614
|
- [UltracartClient::AutoOrder](docs/AutoOrder.md)
|
614
615
|
- [UltracartClient::AutoOrderAddonItem](docs/AutoOrderAddonItem.md)
|
615
616
|
- [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
|
617
|
+
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
616
618
|
- [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
|
617
619
|
- [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
|
618
620
|
- [UltracartClient::AutoOrderItemOption](docs/AutoOrderItemOption.md)
|
@@ -761,6 +763,8 @@ Class | Method | HTTP request | Description
|
|
761
763
|
- [UltracartClient::ConversationPbxAgentsResponse](docs/ConversationPbxAgentsResponse.md)
|
762
764
|
- [UltracartClient::ConversationPbxAudio](docs/ConversationPbxAudio.md)
|
763
765
|
- [UltracartClient::ConversationPbxAudioResponse](docs/ConversationPbxAudioResponse.md)
|
766
|
+
- [UltracartClient::ConversationPbxAudioUploadUrl](docs/ConversationPbxAudioUploadUrl.md)
|
767
|
+
- [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
|
764
768
|
- [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
|
765
769
|
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
766
770
|
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
@@ -1507,6 +1511,8 @@ Not every change is committed to every SDK.
|
|
1507
1511
|
|
1508
1512
|
| Version | Date | Comments |
|
1509
1513
|
| --: | :-: | --- |
|
1514
|
+
| 4.0.212 | 05/01/2024 | getConversationPbxAudioUploadUrl - fix the response obj def |
|
1515
|
+
| 4.0.211 | 04/24/2024 | esp - add fields for external generation on email |
|
1510
1516
|
| 4.0.210 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
|
1511
1517
|
| 4.0.209 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
|
1512
1518
|
| 4.0.208 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
|
data/docs/AutoOrderApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**consolidate_auto_orders**](AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders |
|
7
8
|
| [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id |
|
8
9
|
| [**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid |
|
9
10
|
| [**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code |
|
@@ -15,6 +16,83 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
15
16
|
| [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
|
16
17
|
|
17
18
|
|
19
|
+
## consolidate_auto_orders
|
20
|
+
|
21
|
+
> <AutoOrderResponse> consolidate_auto_orders(auto_order_oid, auto_order_consolidate, opts)
|
22
|
+
|
23
|
+
Consolidates multiple auto orders
|
24
|
+
|
25
|
+
Consolidates mutliple auto orders on the UltraCart account.
|
26
|
+
|
27
|
+
### Examples
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
require 'time'
|
31
|
+
require 'ultracart_api'
|
32
|
+
require 'json'
|
33
|
+
require 'yaml'
|
34
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
35
|
+
|
36
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
37
|
+
# As such, this might not be the best way to use this object.
|
38
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
39
|
+
|
40
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
41
|
+
auto_order_oid = 56 # Integer | The auto order oid to consolidate into.
|
42
|
+
auto_order_consolidate = UltracartClient::AutoOrderConsolidate.new # AutoOrderConsolidate | Auto orders to consolidate
|
43
|
+
opts = {
|
44
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
# Consolidates multiple auto orders
|
49
|
+
result = api_instance.consolidate_auto_orders(auto_order_oid, auto_order_consolidate, opts)
|
50
|
+
p result
|
51
|
+
rescue UltracartClient::ApiError => e
|
52
|
+
puts "Error when calling AutoOrderApi->consolidate_auto_orders: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the consolidate_auto_orders_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(<AutoOrderResponse>, Integer, Hash)> consolidate_auto_orders_with_http_info(auto_order_oid, auto_order_consolidate, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Consolidates multiple auto orders
|
65
|
+
data, status_code, headers = api_instance.consolidate_auto_orders_with_http_info(auto_order_oid, auto_order_consolidate, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => <AutoOrderResponse>
|
69
|
+
rescue UltracartClient::ApiError => e
|
70
|
+
puts "Error when calling AutoOrderApi->consolidate_auto_orders_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **auto_order_oid** | **Integer** | The auto order oid to consolidate into. | |
|
79
|
+
| **auto_order_consolidate** | [**AutoOrderConsolidate**](AutoOrderConsolidate.md) | Auto orders to consolidate | |
|
80
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: application/json; charset=UTF-8
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
18
96
|
## establish_auto_order_by_reference_order_id
|
19
97
|
|
20
98
|
> <AutoOrderResponse> establish_auto_order_by_reference_order_id(reference_order_id, opts)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::AutoOrderConsolidate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source_auto_order_oids** | **Array<Integer>** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::AutoOrderConsolidate.new(
|
15
|
+
source_auto_order_oids: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -8,7 +8,10 @@
|
|
8
8
|
| **conversation_participant_name** | **String** | | [optional] |
|
9
9
|
| **jwt** | **String** | | [optional] |
|
10
10
|
| **merchant_id** | **String** | | [optional] |
|
11
|
+
| **pbx_admin** | **Boolean** | | [optional] |
|
11
12
|
| **pbx_jwt** | **String** | | [optional] |
|
13
|
+
| **pbx_supervisor** | **Boolean** | | [optional] |
|
14
|
+
| **pbx_user** | **Boolean** | | [optional] |
|
12
15
|
| **pbx_voice_identity** | **String** | | [optional] |
|
13
16
|
| **pbx_voice_token** | **String** | | [optional] |
|
14
17
|
| **pbx_worker_token** | **String** | | [optional] |
|
@@ -25,7 +28,10 @@ instance = UltracartClient::ConversationAgentAuth.new(
|
|
25
28
|
conversation_participant_name: null,
|
26
29
|
jwt: null,
|
27
30
|
merchant_id: null,
|
31
|
+
pbx_admin: null,
|
28
32
|
pbx_jwt: null,
|
33
|
+
pbx_supervisor: null,
|
34
|
+
pbx_user: null,
|
29
35
|
pbx_voice_identity: null,
|
30
36
|
pbx_voice_token: null,
|
31
37
|
pbx_worker_token: null,
|
data/docs/ConversationApi.md
CHANGED
@@ -71,7 +71,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
71
71
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
72
72
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
73
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/
|
74
|
+
| [**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened | Listened Queue Voicemail |
|
75
75
|
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
76
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 |
|
77
77
|
| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
|
@@ -1854,7 +1854,7 @@ end
|
|
1854
1854
|
|
1855
1855
|
## get_conversation_pbx_audio_upload_url
|
1856
1856
|
|
1857
|
-
> <
|
1857
|
+
> <ConversationPbxAudioUploadUrlResponse> get_conversation_pbx_audio_upload_url(extension)
|
1858
1858
|
|
1859
1859
|
Get a pre-signed conversation multimedia upload URL
|
1860
1860
|
|
@@ -1889,7 +1889,7 @@ end
|
|
1889
1889
|
|
1890
1890
|
This returns an Array which contains the response data, status code and headers.
|
1891
1891
|
|
1892
|
-
> <Array(<
|
1892
|
+
> <Array(<ConversationPbxAudioUploadUrlResponse>, Integer, Hash)> get_conversation_pbx_audio_upload_url_with_http_info(extension)
|
1893
1893
|
|
1894
1894
|
```ruby
|
1895
1895
|
begin
|
@@ -1897,7 +1897,7 @@ begin
|
|
1897
1897
|
data, status_code, headers = api_instance.get_conversation_pbx_audio_upload_url_with_http_info(extension)
|
1898
1898
|
p status_code # => 2xx
|
1899
1899
|
p headers # => { ... }
|
1900
|
-
p data # => <
|
1900
|
+
p data # => <ConversationPbxAudioUploadUrlResponse>
|
1901
1901
|
rescue UltracartClient::ApiError => e
|
1902
1902
|
puts "Error when calling ConversationApi->get_conversation_pbx_audio_upload_url_with_http_info: #{e}"
|
1903
1903
|
end
|
@@ -1911,7 +1911,7 @@ end
|
|
1911
1911
|
|
1912
1912
|
### Return type
|
1913
1913
|
|
1914
|
-
[**
|
1914
|
+
[**ConversationPbxAudioUploadUrlResponse**](ConversationPbxAudioUploadUrlResponse.md)
|
1915
1915
|
|
1916
1916
|
### Authorization
|
1917
1917
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationPbxAudioUploadUrl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | | [optional] |
|
8
|
+
| **url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationPbxAudioUploadUrl.new(
|
16
|
+
key: null,
|
17
|
+
url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationPbxAudioUploadUrlResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_pbx_audio_upload_url** | [**ConversationPbxAudioUploadUrl**](ConversationPbxAudioUploadUrl.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationPbxAudioUploadUrlResponse.new(
|
19
|
+
conversation_pbx_audio_upload_url: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **auto_orders** | [**Array<AutoOrder>**](AutoOrder.md) | | [optional] |
|
8
|
-
| **
|
8
|
+
| **customers** | [**Array<Customer>**](Customer.md) | | [optional] |
|
9
9
|
| **error** | [**Error**](Error.md) | | [optional] |
|
10
10
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
11
11
|
| **orders** | [**Array<Order>**](Order.md) | | [optional] |
|
@@ -19,7 +19,7 @@ require 'ultracart_api'
|
|
19
19
|
|
20
20
|
instance = UltracartClient::ConversationPbxCustomerSnapshotResponse.new(
|
21
21
|
auto_orders: null,
|
22
|
-
|
22
|
+
customers: null,
|
23
23
|
error: null,
|
24
24
|
metadata: null,
|
25
25
|
orders: null,
|
@@ -24,6 +24,7 @@
|
|
24
24
|
| **voicemail** | **Boolean** | If true, this queue has a voicemail associated with it | [optional] |
|
25
25
|
| **wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional] |
|
26
26
|
| **wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional] |
|
27
|
+
| **wrap_up_seconds** | **Integer** | Wrap up time in seconds | [optional] |
|
27
28
|
|
28
29
|
## Example
|
29
30
|
|
@@ -50,7 +51,8 @@ instance = UltracartClient::ConversationPbxQueue.new(
|
|
50
51
|
twilio_workspace_queue_sid: null,
|
51
52
|
voicemail: null,
|
52
53
|
wait_critical_seconds: null,
|
53
|
-
wait_warning_seconds: null
|
54
|
+
wait_warning_seconds: null,
|
55
|
+
wrap_up_seconds: null
|
54
56
|
)
|
55
57
|
```
|
56
58
|
|
data/docs/EmailCommseqEmail.md
CHANGED
@@ -11,6 +11,14 @@
|
|
11
11
|
| **email_container_cjson** | **String** | Email container cjson | [optional] |
|
12
12
|
| **email_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional] |
|
13
13
|
| **email_template_vm_path** | **String** | Email template virtual path | [optional] |
|
14
|
+
| **external_generation** | **Boolean** | | [optional] |
|
15
|
+
| **external_generation_authentication** | **String** | | [optional] |
|
16
|
+
| **external_generation_basic_password** | **String** | | [optional] |
|
17
|
+
| **external_generation_basic_username** | **String** | | [optional] |
|
18
|
+
| **external_generation_header_name** | **String** | | [optional] |
|
19
|
+
| **external_generation_header_value** | **String** | | [optional] |
|
20
|
+
| **external_generation_id** | **String** | | [optional] |
|
21
|
+
| **external_generation_url** | **String** | | [optional] |
|
14
22
|
| **filter_profile_equation_json** | **String** | Filter profile equation json | [optional] |
|
15
23
|
| **individually_render** | **Boolean** | Individually render | [optional] |
|
16
24
|
| **library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated. | [optional] |
|
@@ -44,6 +52,14 @@ instance = UltracartClient::EmailCommseqEmail.new(
|
|
44
52
|
email_container_cjson: null,
|
45
53
|
email_container_cjson_last_modified_dts: null,
|
46
54
|
email_template_vm_path: null,
|
55
|
+
external_generation: null,
|
56
|
+
external_generation_authentication: null,
|
57
|
+
external_generation_basic_password: null,
|
58
|
+
external_generation_basic_username: null,
|
59
|
+
external_generation_header_name: null,
|
60
|
+
external_generation_header_value: null,
|
61
|
+
external_generation_id: null,
|
62
|
+
external_generation_url: null,
|
47
63
|
filter_profile_equation_json: null,
|
48
64
|
individually_render: null,
|
49
65
|
library_item_oid: null,
|
data/docs/ItemChargeback.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **addendums** | [**Array<ItemChargebackAddendum>**](ItemChargebackAddendum.md) | Addendums | [optional] |
|
8
|
-
| **adjustment_requests** | [**Array<ItemChargebackAdjustmentRequest>**](ItemChargebackAdjustmentRequest.md) | Adjustment requests | [optional] |
|
7
|
+
| **addendums** | [**Array<ItemChargebackAddendum>**](ItemChargebackAddendum.md) | Addendums (deprecated) | [optional] |
|
8
|
+
| **adjustment_requests** | [**Array<ItemChargebackAdjustmentRequest>**](ItemChargebackAdjustmentRequest.md) | Adjustment requests (deprecated) | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
13
13
|
| **order_level_refund_reason_required** | **Boolean** | True if the order level refund reason is required | [optional] |
|
14
14
|
| **order_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the order level. | [optional] |
|
15
|
+
| **order_level_reject_reason_required** | **Boolean** | True if the order level reject reason is required | [optional] |
|
15
16
|
| **order_level_reject_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reject codes available at the order level. | [optional] |
|
16
17
|
| **refundable** | **Boolean** | Whether the order is refundable or not. Null should be interpreted as false. | [optional] |
|
17
18
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
@@ -31,6 +32,7 @@ instance = UltracartClient::OrderRefundableResponse.new(
|
|
31
32
|
metadata: null,
|
32
33
|
order_level_refund_reason_required: null,
|
33
34
|
order_level_refund_reasons: null,
|
35
|
+
order_level_reject_reason_required: null,
|
34
36
|
order_level_reject_reasons: null,
|
35
37
|
refundable: null,
|
36
38
|
success: null,
|
@@ -32,6 +32,84 @@ module UltracartClient
|
|
32
32
|
UltracartClient::AutoOrderApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Consolidates multiple auto orders
|
36
|
+
# Consolidates mutliple auto orders on the UltraCart account.
|
37
|
+
# @param auto_order_oid [Integer] The auto order oid to consolidate into.
|
38
|
+
# @param auto_order_consolidate [AutoOrderConsolidate] Auto orders to consolidate
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
41
|
+
# @return [AutoOrderResponse]
|
42
|
+
def consolidate_auto_orders(auto_order_oid, auto_order_consolidate, opts = {})
|
43
|
+
data, _status_code, _headers = consolidate_auto_orders_with_http_info(auto_order_oid, auto_order_consolidate, opts)
|
44
|
+
data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Consolidates multiple auto orders
|
48
|
+
# Consolidates mutliple auto orders on the UltraCart account.
|
49
|
+
# @param auto_order_oid [Integer] The auto order oid to consolidate into.
|
50
|
+
# @param auto_order_consolidate [AutoOrderConsolidate] Auto orders to consolidate
|
51
|
+
# @param [Hash] opts the optional parameters
|
52
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
53
|
+
# @return [Array<(AutoOrderResponse, Integer, Hash)>] AutoOrderResponse data, response status code and response headers
|
54
|
+
def consolidate_auto_orders_with_http_info(auto_order_oid, auto_order_consolidate, opts = {})
|
55
|
+
if @api_client.config.debugging
|
56
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.consolidate_auto_orders ...'
|
57
|
+
end
|
58
|
+
# verify the required parameter 'auto_order_oid' is set
|
59
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
60
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.consolidate_auto_orders"
|
61
|
+
end
|
62
|
+
# verify the required parameter 'auto_order_consolidate' is set
|
63
|
+
if @api_client.config.client_side_validation && auto_order_consolidate.nil?
|
64
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_consolidate' when calling AutoOrderApi.consolidate_auto_orders"
|
65
|
+
end
|
66
|
+
# resource path
|
67
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/consolidate'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
|
68
|
+
|
69
|
+
# query parameters
|
70
|
+
query_params = opts[:query_params] || {}
|
71
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
72
|
+
|
73
|
+
# header parameters
|
74
|
+
header_params = opts[:header_params] || {}
|
75
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
76
|
+
# HTTP header 'Accept' (if needed)
|
77
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
78
|
+
# HTTP header 'Content-Type'
|
79
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
80
|
+
if !content_type.nil?
|
81
|
+
header_params['Content-Type'] = content_type
|
82
|
+
end
|
83
|
+
|
84
|
+
# form parameters
|
85
|
+
form_params = opts[:form_params] || {}
|
86
|
+
|
87
|
+
# http body (model)
|
88
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(auto_order_consolidate)
|
89
|
+
|
90
|
+
# return_type
|
91
|
+
return_type = opts[:debug_return_type] || 'AutoOrderResponse'
|
92
|
+
|
93
|
+
# auth_names
|
94
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
95
|
+
|
96
|
+
new_options = opts.merge(
|
97
|
+
:operation => :"AutoOrderApi.consolidate_auto_orders",
|
98
|
+
:header_params => header_params,
|
99
|
+
:query_params => query_params,
|
100
|
+
:form_params => form_params,
|
101
|
+
:body => post_body,
|
102
|
+
:auth_names => auth_names,
|
103
|
+
:return_type => return_type
|
104
|
+
)
|
105
|
+
|
106
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
107
|
+
if @api_client.config.debugging
|
108
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#consolidate_auto_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
109
|
+
end
|
110
|
+
return data, status_code, headers
|
111
|
+
end
|
112
|
+
|
35
113
|
# Establish an auto order by referencing a regular order id
|
36
114
|
# Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
|
37
115
|
# @param reference_order_id [String] The order id to attach this auto order to
|
@@ -1612,7 +1612,7 @@ module UltracartClient
|
|
1612
1612
|
# Get a pre-signed conversation multimedia upload URL
|
1613
1613
|
# @param extension [String]
|
1614
1614
|
# @param [Hash] opts the optional parameters
|
1615
|
-
# @return [
|
1615
|
+
# @return [ConversationPbxAudioUploadUrlResponse]
|
1616
1616
|
def get_conversation_pbx_audio_upload_url(extension, opts = {})
|
1617
1617
|
data, _status_code, _headers = get_conversation_pbx_audio_upload_url_with_http_info(extension, opts)
|
1618
1618
|
data
|
@@ -1622,7 +1622,7 @@ module UltracartClient
|
|
1622
1622
|
# Get a pre-signed conversation multimedia upload URL
|
1623
1623
|
# @param extension [String]
|
1624
1624
|
# @param [Hash] opts the optional parameters
|
1625
|
-
# @return [Array<(
|
1625
|
+
# @return [Array<(ConversationPbxAudioUploadUrlResponse, Integer, Hash)>] ConversationPbxAudioUploadUrlResponse data, response status code and response headers
|
1626
1626
|
def get_conversation_pbx_audio_upload_url_with_http_info(extension, opts = {})
|
1627
1627
|
if @api_client.config.debugging
|
1628
1628
|
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_audio_upload_url ...'
|
@@ -1650,7 +1650,7 @@ module UltracartClient
|
|
1650
1650
|
post_body = opts[:debug_body]
|
1651
1651
|
|
1652
1652
|
# return_type
|
1653
|
-
return_type = opts[:debug_return_type] || '
|
1653
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudioUploadUrlResponse'
|
1654
1654
|
|
1655
1655
|
# auth_names
|
1656
1656
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
@@ -4343,7 +4343,7 @@ module UltracartClient
|
|
4343
4343
|
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
|
4344
4344
|
end
|
4345
4345
|
# resource path
|
4346
|
-
local_var_path = '/conversation/pbx/{queue_uuid}/voicemails/
|
4346
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened'.sub('{' + 'queue_uuid' + '}', CGI.escape(queue_uuid.to_s)).sub('{' + 'recording_sid' + '}', CGI.escape(recording_sid.to_s))
|
4347
4347
|
|
4348
4348
|
# query parameters
|
4349
4349
|
query_params = opts[:query_params] || {}
|