ultracart_api 3.10.193 → 3.10.195
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -5
- data/docs/AutoOrderApi.md +58 -0
- data/docs/AutoOrderConsolidate.md +8 -0
- data/docs/ConversationAgentAuth.md +3 -0
- data/docs/ConversationApi.md +3 -3
- data/docs/ConversationPbxAudioUploadUrl.md +9 -0
- data/docs/ConversationPbxAudioUploadUrlResponse.md +12 -0
- data/docs/ConversationPbxCustomerSnapshotResponse.md +1 -1
- data/docs/ConversationPbxQueue.md +1 -0
- data/docs/EmailCommseqEmail.md +8 -0
- data/docs/ItemChargeback.md +2 -2
- data/docs/OrderRefundableResponse.md +1 -0
- data/lib/ultracart_api/api/auto_order_api.rb +64 -0
- data/lib/ultracart_api/api/conversation_api.rb +4 -4
- data/lib/ultracart_api/models/auto_order_consolidate.rb +186 -0
- data/lib/ultracart_api/models/conversation_agent_auth.rb +28 -1
- data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +193 -0
- data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +221 -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: 180f19e98db8a2b18892bc467f44178c2aa4874fb0257b74892c7a130771e4c4
|
4
|
+
data.tar.gz: 3204ba2a2cc0123e6ffb51e836af104c91dcee98fc518cb4f31ec00bc10876ca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b719e09c3bd22fa9fd2f6bc45b38b04d801bd97625fa05a62ae503573763bb4ef96efbf5d6939eb84dd786c77ade21089142fb70580212182376e6dfc591bc1a
|
7
|
+
data.tar.gz: c4ed5680fff632fb7e68fee8ea2dd986f15951780498e455318549aa5a98437f2047bd1a1e02febb127f657825cc33c5fe551699920b28d3b1082ba87f5c8daf
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.195
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.195.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.195.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.195'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -88,6 +88,7 @@ Class | Method | HTTP request | Description
|
|
88
88
|
------------ | ------------- | ------------- | -------------
|
89
89
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
90
90
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
91
|
+
*UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
|
91
92
|
*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
|
92
93
|
*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
|
93
94
|
*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
|
@@ -199,7 +200,7 @@ Class | Method | HTTP request | Description
|
|
199
200
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
200
201
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
201
202
|
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
202
|
-
*UltracartClient::ConversationApi* | [**listened_pbx_queue_voicemail**](docs/ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/
|
203
|
+
*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
|
203
204
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
204
205
|
*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
|
205
206
|
*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
|
@@ -607,6 +608,7 @@ Class | Method | HTTP request | Description
|
|
607
608
|
- [UltracartClient::AutoOrder](docs/AutoOrder.md)
|
608
609
|
- [UltracartClient::AutoOrderAddonItem](docs/AutoOrderAddonItem.md)
|
609
610
|
- [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
|
611
|
+
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
610
612
|
- [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
|
611
613
|
- [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
|
612
614
|
- [UltracartClient::AutoOrderItemOption](docs/AutoOrderItemOption.md)
|
@@ -756,6 +758,8 @@ Class | Method | HTTP request | Description
|
|
756
758
|
- [UltracartClient::ConversationPbxAgentsResponse](docs/ConversationPbxAgentsResponse.md)
|
757
759
|
- [UltracartClient::ConversationPbxAudio](docs/ConversationPbxAudio.md)
|
758
760
|
- [UltracartClient::ConversationPbxAudioResponse](docs/ConversationPbxAudioResponse.md)
|
761
|
+
- [UltracartClient::ConversationPbxAudioUploadUrl](docs/ConversationPbxAudioUploadUrl.md)
|
762
|
+
- [UltracartClient::ConversationPbxAudioUploadUrlResponse](docs/ConversationPbxAudioUploadUrlResponse.md)
|
759
763
|
- [UltracartClient::ConversationPbxAudiosResponse](docs/ConversationPbxAudiosResponse.md)
|
760
764
|
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
761
765
|
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
@@ -1499,6 +1503,8 @@ Not every change is committed to every SDK.
|
|
1499
1503
|
|
1500
1504
|
| Version | Date | Comments |
|
1501
1505
|
| --: | :-: | --- |
|
1506
|
+
| 3.10.195 | 05/01/2024 | getConversationPbxAudioUploadUrl - fix the response obj def |
|
1507
|
+
| 3.10.194 | 04/24/2024 | esp - add fields for external generation on email |
|
1502
1508
|
| 3.10.193 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
|
1503
1509
|
| 3.10.192 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
|
1504
1510
|
| 3.10.191 | 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,63 @@ Method | HTTP request | Description
|
|
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
|
+
> AutoOrderResponse consolidate_auto_orders(auto_order_consolidate, auto_order_oid, opts)
|
21
|
+
|
22
|
+
Consolidates multiple auto orders
|
23
|
+
|
24
|
+
Consolidates mutliple auto orders on the UltraCart account.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'ultracart_api'
|
30
|
+
|
31
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
32
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
33
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
34
|
+
|
35
|
+
|
36
|
+
auto_order_consolidate = UltracartClient::AutoOrderConsolidate.new # AutoOrderConsolidate | Auto orders to consolidate
|
37
|
+
|
38
|
+
auto_order_oid = 56 # Integer | The auto order oid to consolidate into.
|
39
|
+
|
40
|
+
opts = {
|
41
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
#Consolidates multiple auto orders
|
46
|
+
result = api_instance.consolidate_auto_orders(auto_order_consolidate, auto_order_oid, opts)
|
47
|
+
p result
|
48
|
+
rescue UltracartClient::ApiError => e
|
49
|
+
puts "Exception when calling AutoOrderApi->consolidate_auto_orders: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**auto_order_consolidate** | [**AutoOrderConsolidate**](AutoOrderConsolidate.md)| Auto orders to consolidate |
|
58
|
+
**auto_order_oid** | **Integer**| The auto order oid to consolidate into. |
|
59
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: application/json; charset=UTF-8
|
72
|
+
- **Accept**: application/json
|
73
|
+
|
74
|
+
|
75
|
+
|
18
76
|
# **establish_auto_order_by_reference_order_id**
|
19
77
|
> AutoOrderResponse establish_auto_order_by_reference_order_id(reference_order_id, opts)
|
20
78
|
|
@@ -7,7 +7,10 @@ Name | Type | Description | Notes
|
|
7
7
|
**conversation_participant_name** | **String** | | [optional]
|
8
8
|
**jwt** | **String** | | [optional]
|
9
9
|
**merchant_id** | **String** | | [optional]
|
10
|
+
**pbx_admin** | **BOOLEAN** | | [optional]
|
10
11
|
**pbx_jwt** | **String** | | [optional]
|
12
|
+
**pbx_supervisor** | **BOOLEAN** | | [optional]
|
13
|
+
**pbx_user** | **BOOLEAN** | | [optional]
|
11
14
|
**pbx_voice_identity** | **String** | | [optional]
|
12
15
|
**pbx_voice_token** | **String** | | [optional]
|
13
16
|
**pbx_worker_token** | **String** | | [optional]
|
data/docs/ConversationApi.md
CHANGED
@@ -71,7 +71,7 @@ Method | HTTP request | Description
|
|
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
|
@@ -1316,7 +1316,7 @@ Name | Type | Description | Notes
|
|
1316
1316
|
|
1317
1317
|
|
1318
1318
|
# **get_conversation_pbx_audio_upload_url**
|
1319
|
-
>
|
1319
|
+
> ConversationPbxAudioUploadUrlResponse get_conversation_pbx_audio_upload_url(extension)
|
1320
1320
|
|
1321
1321
|
Get a pre-signed conversation multimedia upload URL
|
1322
1322
|
|
@@ -1352,7 +1352,7 @@ Name | Type | Description | Notes
|
|
1352
1352
|
|
1353
1353
|
### Return type
|
1354
1354
|
|
1355
|
-
[**
|
1355
|
+
[**ConversationPbxAudioUploadUrlResponse**](ConversationPbxAudioUploadUrlResponse.md)
|
1356
1356
|
|
1357
1357
|
### Authorization
|
1358
1358
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationPbxAudioUploadUrlResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_pbx_audio_upload_url** | [**ConversationPbxAudioUploadUrl**](ConversationPbxAudioUploadUrl.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**auto_orders** | [**Array<AutoOrder>**](AutoOrder.md) | | [optional]
|
7
|
-
**
|
7
|
+
**customers** | [**Array<Customer>**](Customer.md) | | [optional]
|
8
8
|
**error** | [**Error**](Error.md) | | [optional]
|
9
9
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
10
10
|
**orders** | [**Array<Order>**](Order.md) | | [optional]
|
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
|
|
23
23
|
**voicemail** | **BOOLEAN** | If true, this queue has a voicemail associated with it | [optional]
|
24
24
|
**wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional]
|
25
25
|
**wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional]
|
26
|
+
**wrap_up_seconds** | **Integer** | Wrap up time in seconds | [optional]
|
26
27
|
|
27
28
|
|
data/docs/EmailCommseqEmail.md
CHANGED
@@ -10,6 +10,14 @@ Name | Type | Description | Notes
|
|
10
10
|
**email_container_cjson** | **String** | Email container cjson | [optional]
|
11
11
|
**email_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional]
|
12
12
|
**email_template_vm_path** | **String** | Email template virtual path | [optional]
|
13
|
+
**external_generation** | **BOOLEAN** | | [optional]
|
14
|
+
**external_generation_authentication** | **String** | | [optional]
|
15
|
+
**external_generation_basic_password** | **String** | | [optional]
|
16
|
+
**external_generation_basic_username** | **String** | | [optional]
|
17
|
+
**external_generation_header_name** | **String** | | [optional]
|
18
|
+
**external_generation_header_value** | **String** | | [optional]
|
19
|
+
**external_generation_id** | **String** | | [optional]
|
20
|
+
**external_generation_url** | **String** | | [optional]
|
13
21
|
**filter_profile_equation_json** | **String** | Filter profile equation json | [optional]
|
14
22
|
**individually_render** | **BOOLEAN** | Individually render | [optional]
|
15
23
|
**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]
|
data/docs/ItemChargeback.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**addendums** | [**Array<ItemChargebackAddendum>**](ItemChargebackAddendum.md) | Addendums | [optional]
|
7
|
-
**adjustment_requests** | [**Array<ItemChargebackAdjustmentRequest>**](ItemChargebackAdjustmentRequest.md) | Adjustment requests | [optional]
|
6
|
+
**addendums** | [**Array<ItemChargebackAddendum>**](ItemChargebackAddendum.md) | Addendums (deprecated) | [optional]
|
7
|
+
**adjustment_requests** | [**Array<ItemChargebackAdjustmentRequest>**](ItemChargebackAdjustmentRequest.md) | Adjustment requests (deprecated) | [optional]
|
8
8
|
|
9
9
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
12
12
|
**order_level_refund_reason_required** | **BOOLEAN** | True if the order level refund reason is required | [optional]
|
13
13
|
**order_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the order level. | [optional]
|
14
|
+
**order_level_reject_reason_required** | **BOOLEAN** | True if the order level reject reason is required | [optional]
|
14
15
|
**order_level_reject_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reject codes available at the order level. | [optional]
|
15
16
|
**refundable** | **BOOLEAN** | Whether the order is refundable or not. Null should be interpreted as false. | [optional]
|
16
17
|
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
@@ -32,6 +32,70 @@ 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_consolidate Auto orders to consolidate
|
38
|
+
# @param auto_order_oid The auto order oid to consolidate into.
|
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_consolidate, auto_order_oid, opts = {})
|
43
|
+
data, _status_code, _headers = consolidate_auto_orders_with_http_info(auto_order_consolidate, auto_order_oid, opts)
|
44
|
+
data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Consolidates multiple auto orders
|
48
|
+
# Consolidates mutliple auto orders on the UltraCart account.
|
49
|
+
# @param auto_order_consolidate Auto orders to consolidate
|
50
|
+
# @param auto_order_oid The auto order oid to consolidate into.
|
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, Fixnum, Hash)>] AutoOrderResponse data, response status code and response headers
|
54
|
+
def consolidate_auto_orders_with_http_info(auto_order_consolidate, auto_order_oid, 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_consolidate' is set
|
59
|
+
if @api_client.config.client_side_validation && auto_order_consolidate.nil?
|
60
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_consolidate' when calling AutoOrderApi.consolidate_auto_orders"
|
61
|
+
end
|
62
|
+
# verify the required parameter 'auto_order_oid' is set
|
63
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
64
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' 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' + '}', auto_order_oid.to_s)
|
68
|
+
|
69
|
+
# query parameters
|
70
|
+
query_params = {}
|
71
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
72
|
+
|
73
|
+
# header parameters
|
74
|
+
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
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
80
|
+
|
81
|
+
# form parameters
|
82
|
+
form_params = {}
|
83
|
+
|
84
|
+
# http body (model)
|
85
|
+
post_body = @api_client.object_to_http_body(auto_order_consolidate)
|
86
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
87
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
88
|
+
:header_params => header_params,
|
89
|
+
:query_params => query_params,
|
90
|
+
:form_params => form_params,
|
91
|
+
:body => post_body,
|
92
|
+
:auth_names => auth_names,
|
93
|
+
:return_type => 'AutoOrderResponse')
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#consolidate_auto_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
96
|
+
end
|
97
|
+
return data, status_code, headers
|
98
|
+
end
|
35
99
|
# Establish an auto order by referencing a regular order id
|
36
100
|
# 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
101
|
# @param reference_order_id The order id to attach this auto order to
|
@@ -1381,7 +1381,7 @@ module UltracartClient
|
|
1381
1381
|
# Get a pre-signed conversation multimedia upload URL
|
1382
1382
|
# @param extension
|
1383
1383
|
# @param [Hash] opts the optional parameters
|
1384
|
-
# @return [
|
1384
|
+
# @return [ConversationPbxAudioUploadUrlResponse]
|
1385
1385
|
def get_conversation_pbx_audio_upload_url(extension, opts = {})
|
1386
1386
|
data, _status_code, _headers = get_conversation_pbx_audio_upload_url_with_http_info(extension, opts)
|
1387
1387
|
data
|
@@ -1391,7 +1391,7 @@ module UltracartClient
|
|
1391
1391
|
# Get a pre-signed conversation multimedia upload URL
|
1392
1392
|
# @param extension
|
1393
1393
|
# @param [Hash] opts the optional parameters
|
1394
|
-
# @return [Array<(
|
1394
|
+
# @return [Array<(ConversationPbxAudioUploadUrlResponse, Fixnum, Hash)>] ConversationPbxAudioUploadUrlResponse data, response status code and response headers
|
1395
1395
|
def get_conversation_pbx_audio_upload_url_with_http_info(extension, opts = {})
|
1396
1396
|
if @api_client.config.debugging
|
1397
1397
|
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_audio_upload_url ...'
|
@@ -1426,7 +1426,7 @@ module UltracartClient
|
|
1426
1426
|
:form_params => form_params,
|
1427
1427
|
:body => post_body,
|
1428
1428
|
:auth_names => auth_names,
|
1429
|
-
:return_type => '
|
1429
|
+
:return_type => 'ConversationPbxAudioUploadUrlResponse')
|
1430
1430
|
if @api_client.config.debugging
|
1431
1431
|
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_pbx_audio_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1432
1432
|
end
|
@@ -3656,7 +3656,7 @@ module UltracartClient
|
|
3656
3656
|
fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
|
3657
3657
|
end
|
3658
3658
|
# resource path
|
3659
|
-
local_var_path = '/conversation/pbx/{queue_uuid}/voicemails/
|
3659
|
+
local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
|
3660
3660
|
|
3661
3661
|
# query parameters
|
3662
3662
|
query_params = {}
|
@@ -0,0 +1,186 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class AutoOrderConsolidate
|
17
|
+
attr_accessor :source_auto_order_oids
|
18
|
+
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
20
|
+
def self.attribute_map
|
21
|
+
{
|
22
|
+
:'source_auto_order_oids' => :'source_auto_order_oids'
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
# Attribute type mapping.
|
27
|
+
def self.swagger_types
|
28
|
+
{
|
29
|
+
:'source_auto_order_oids' => :'Array<Integer>'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Initializes the object
|
34
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
35
|
+
def initialize(attributes = {})
|
36
|
+
return unless attributes.is_a?(Hash)
|
37
|
+
|
38
|
+
# convert string to symbol for hash key
|
39
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
40
|
+
|
41
|
+
if attributes.has_key?(:'source_auto_order_oids')
|
42
|
+
if (value = attributes[:'source_auto_order_oids']).is_a?(Array)
|
43
|
+
self.source_auto_order_oids = value
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
49
|
+
# @return Array for valid properties with the reasons
|
50
|
+
def list_invalid_properties
|
51
|
+
invalid_properties = Array.new
|
52
|
+
invalid_properties
|
53
|
+
end
|
54
|
+
|
55
|
+
# Check to see if the all the properties in the model are valid
|
56
|
+
# @return true if the model is valid
|
57
|
+
def valid?
|
58
|
+
true
|
59
|
+
end
|
60
|
+
|
61
|
+
# Checks equality by comparing each attribute.
|
62
|
+
# @param [Object] Object to be compared
|
63
|
+
def ==(o)
|
64
|
+
return true if self.equal?(o)
|
65
|
+
self.class == o.class &&
|
66
|
+
source_auto_order_oids == o.source_auto_order_oids
|
67
|
+
end
|
68
|
+
|
69
|
+
# @see the `==` method
|
70
|
+
# @param [Object] Object to be compared
|
71
|
+
def eql?(o)
|
72
|
+
self == o
|
73
|
+
end
|
74
|
+
|
75
|
+
# Calculates hash code according to all attributes.
|
76
|
+
# @return [Fixnum] Hash code
|
77
|
+
def hash
|
78
|
+
[source_auto_order_oids].hash
|
79
|
+
end
|
80
|
+
|
81
|
+
# Builds the object from hash
|
82
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
83
|
+
# @return [Object] Returns the model itself
|
84
|
+
def build_from_hash(attributes)
|
85
|
+
return nil unless attributes.is_a?(Hash)
|
86
|
+
self.class.swagger_types.each_pair do |key, type|
|
87
|
+
if type =~ /\AArray<(.*)>/i
|
88
|
+
# check to ensure the input is an array given that the attribute
|
89
|
+
# is documented as an array but the input is not
|
90
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
91
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
92
|
+
end
|
93
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
94
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
95
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
96
|
+
end
|
97
|
+
|
98
|
+
self
|
99
|
+
end
|
100
|
+
|
101
|
+
# Deserializes the data based on type
|
102
|
+
# @param string type Data type
|
103
|
+
# @param string value Value to be deserialized
|
104
|
+
# @return [Object] Deserialized data
|
105
|
+
def _deserialize(type, value)
|
106
|
+
case type.to_sym
|
107
|
+
when :DateTime
|
108
|
+
DateTime.parse(value)
|
109
|
+
when :Date
|
110
|
+
Date.parse(value)
|
111
|
+
when :String
|
112
|
+
value.to_s
|
113
|
+
when :Integer
|
114
|
+
value.to_i
|
115
|
+
when :Float
|
116
|
+
value.to_f
|
117
|
+
when :BOOLEAN
|
118
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
119
|
+
true
|
120
|
+
else
|
121
|
+
false
|
122
|
+
end
|
123
|
+
when :Object
|
124
|
+
# generic object (usually a Hash), return directly
|
125
|
+
value
|
126
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
127
|
+
inner_type = Regexp.last_match[:inner_type]
|
128
|
+
value.map { |v| _deserialize(inner_type, v) }
|
129
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
130
|
+
k_type = Regexp.last_match[:k_type]
|
131
|
+
v_type = Regexp.last_match[:v_type]
|
132
|
+
{}.tap do |hash|
|
133
|
+
value.each do |k, v|
|
134
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
135
|
+
end
|
136
|
+
end
|
137
|
+
else # model
|
138
|
+
temp_model = UltracartClient.const_get(type).new
|
139
|
+
temp_model.build_from_hash(value)
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Returns the string representation of the object
|
144
|
+
# @return [String] String presentation of the object
|
145
|
+
def to_s
|
146
|
+
to_hash.to_s
|
147
|
+
end
|
148
|
+
|
149
|
+
# to_body is an alias to to_hash (backward compatibility)
|
150
|
+
# @return [Hash] Returns the object in the form of hash
|
151
|
+
def to_body
|
152
|
+
to_hash
|
153
|
+
end
|
154
|
+
|
155
|
+
# Returns the object in the form of hash
|
156
|
+
# @return [Hash] Returns the object in the form of hash
|
157
|
+
def to_hash
|
158
|
+
hash = {}
|
159
|
+
self.class.attribute_map.each_pair do |attr, param|
|
160
|
+
value = self.send(attr)
|
161
|
+
next if value.nil?
|
162
|
+
hash[param] = _to_hash(value)
|
163
|
+
end
|
164
|
+
hash
|
165
|
+
end
|
166
|
+
|
167
|
+
# Outputs non-array value in the form of hash
|
168
|
+
# For object, use to_hash. Otherwise, just return the value
|
169
|
+
# @param [Object] value Any valid value
|
170
|
+
# @return [Hash] Returns the value in the form of hash
|
171
|
+
def _to_hash(value)
|
172
|
+
if value.is_a?(Array)
|
173
|
+
value.compact.map { |v| _to_hash(v) }
|
174
|
+
elsif value.is_a?(Hash)
|
175
|
+
{}.tap do |hash|
|
176
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
177
|
+
end
|
178
|
+
elsif value.respond_to? :to_hash
|
179
|
+
value.to_hash
|
180
|
+
else
|
181
|
+
value
|
182
|
+
end
|
183
|
+
end
|
184
|
+
|
185
|
+
end
|
186
|
+
end
|
@@ -22,8 +22,14 @@ module UltracartClient
|
|
22
22
|
|
23
23
|
attr_accessor :merchant_id
|
24
24
|
|
25
|
+
attr_accessor :pbx_admin
|
26
|
+
|
25
27
|
attr_accessor :pbx_jwt
|
26
28
|
|
29
|
+
attr_accessor :pbx_supervisor
|
30
|
+
|
31
|
+
attr_accessor :pbx_user
|
32
|
+
|
27
33
|
attr_accessor :pbx_voice_identity
|
28
34
|
|
29
35
|
attr_accessor :pbx_voice_token
|
@@ -41,7 +47,10 @@ module UltracartClient
|
|
41
47
|
:'conversation_participant_name' => :'conversation_participant_name',
|
42
48
|
:'jwt' => :'jwt',
|
43
49
|
:'merchant_id' => :'merchant_id',
|
50
|
+
:'pbx_admin' => :'pbx_admin',
|
44
51
|
:'pbx_jwt' => :'pbx_jwt',
|
52
|
+
:'pbx_supervisor' => :'pbx_supervisor',
|
53
|
+
:'pbx_user' => :'pbx_user',
|
45
54
|
:'pbx_voice_identity' => :'pbx_voice_identity',
|
46
55
|
:'pbx_voice_token' => :'pbx_voice_token',
|
47
56
|
:'pbx_worker_token' => :'pbx_worker_token',
|
@@ -57,7 +66,10 @@ module UltracartClient
|
|
57
66
|
:'conversation_participant_name' => :'String',
|
58
67
|
:'jwt' => :'String',
|
59
68
|
:'merchant_id' => :'String',
|
69
|
+
:'pbx_admin' => :'BOOLEAN',
|
60
70
|
:'pbx_jwt' => :'String',
|
71
|
+
:'pbx_supervisor' => :'BOOLEAN',
|
72
|
+
:'pbx_user' => :'BOOLEAN',
|
61
73
|
:'pbx_voice_identity' => :'String',
|
62
74
|
:'pbx_voice_token' => :'String',
|
63
75
|
:'pbx_worker_token' => :'String',
|
@@ -90,10 +102,22 @@ module UltracartClient
|
|
90
102
|
self.merchant_id = attributes[:'merchant_id']
|
91
103
|
end
|
92
104
|
|
105
|
+
if attributes.has_key?(:'pbx_admin')
|
106
|
+
self.pbx_admin = attributes[:'pbx_admin']
|
107
|
+
end
|
108
|
+
|
93
109
|
if attributes.has_key?(:'pbx_jwt')
|
94
110
|
self.pbx_jwt = attributes[:'pbx_jwt']
|
95
111
|
end
|
96
112
|
|
113
|
+
if attributes.has_key?(:'pbx_supervisor')
|
114
|
+
self.pbx_supervisor = attributes[:'pbx_supervisor']
|
115
|
+
end
|
116
|
+
|
117
|
+
if attributes.has_key?(:'pbx_user')
|
118
|
+
self.pbx_user = attributes[:'pbx_user']
|
119
|
+
end
|
120
|
+
|
97
121
|
if attributes.has_key?(:'pbx_voice_identity')
|
98
122
|
self.pbx_voice_identity = attributes[:'pbx_voice_identity']
|
99
123
|
end
|
@@ -139,7 +163,10 @@ module UltracartClient
|
|
139
163
|
conversation_participant_name == o.conversation_participant_name &&
|
140
164
|
jwt == o.jwt &&
|
141
165
|
merchant_id == o.merchant_id &&
|
166
|
+
pbx_admin == o.pbx_admin &&
|
142
167
|
pbx_jwt == o.pbx_jwt &&
|
168
|
+
pbx_supervisor == o.pbx_supervisor &&
|
169
|
+
pbx_user == o.pbx_user &&
|
143
170
|
pbx_voice_identity == o.pbx_voice_identity &&
|
144
171
|
pbx_voice_token == o.pbx_voice_token &&
|
145
172
|
pbx_worker_token == o.pbx_worker_token &&
|
@@ -156,7 +183,7 @@ module UltracartClient
|
|
156
183
|
# Calculates hash code according to all attributes.
|
157
184
|
# @return [Fixnum] Hash code
|
158
185
|
def hash
|
159
|
-
[conversation_participant_arn, conversation_participant_name, jwt, merchant_id, pbx_jwt, pbx_voice_identity, pbx_voice_token, pbx_worker_token, twilio_accounts, websocket_url].hash
|
186
|
+
[conversation_participant_arn, conversation_participant_name, jwt, merchant_id, pbx_admin, pbx_jwt, pbx_supervisor, pbx_user, pbx_voice_identity, pbx_voice_token, pbx_worker_token, twilio_accounts, websocket_url].hash
|
160
187
|
end
|
161
188
|
|
162
189
|
# Builds the object from hash
|