ultracart_api 4.0.35.rc → 4.0.38.rc
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 -4
- data/docs/AutoOrderItem.md +4 -0
- data/docs/ConversationAgentAuth.md +28 -0
- data/docs/ConversationAgentAuthResponse.md +10 -6
- data/docs/ConversationApi.md +75 -4
- data/docs/ConversationMessage.md +3 -1
- data/docs/ConversationMessageTransportStatus.md +20 -0
- data/docs/ConversationResponse.md +26 -0
- data/docs/ConversationStartResponse.md +2 -4
- data/docs/EmailCommseqPostcard.md +1 -1
- data/lib/ultracart_api/api/conversation_api.rb +67 -3
- data/lib/ultracart_api/models/auto_order_item.rb +21 -1
- data/lib/ultracart_api/models/conversation_agent_auth.rb +266 -0
- data/lib/ultracart_api/models/conversation_agent_auth_response.rb +38 -19
- data/lib/ultracart_api/models/conversation_message.rb +15 -4
- data/lib/ultracart_api/models/conversation_message_transport_status.rb +228 -0
- data/lib/ultracart_api/models/conversation_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_start_response.rb +7 -16
- data/lib/ultracart_api/models/email_commseq_postcard.rb +1 -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: 4f66d20704c5bb1cc75610371df8890543da872135b00e872ae000d6a1c932a4
|
4
|
+
data.tar.gz: 730a9a5582042d832feebac3e619a6352d328b0c5d7d88aedcf4f2dfc01ad4ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 12969f6465f641fa8c24186a103eae395317cd0e46c7b0dcb248163cbb8dcfc8e09fbf6dde4a1744f7eb03e21383e1290622e8ddbf748eb3a3dad2b21fae79d2
|
7
|
+
data.tar.gz: e8cadff3f645622c757ce6e43cab002b32c23f22a5c8692f28f59d56aa5315eb7b1e0e3c65a2c989724408f4777e0b2b001bdf63a52eec5f43f8c575596e69ad
|
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.38.rc
|
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.38.rc.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.38.rc.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.38.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -133,6 +133,7 @@ Class | Method | HTTP request | Description
|
|
133
133
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
134
134
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
135
135
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
136
|
+
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
136
137
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
137
138
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
138
139
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
@@ -561,9 +562,12 @@ Class | Method | HTTP request | Description
|
|
561
562
|
- [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
|
562
563
|
- [UltracartClient::CityStateZip](docs/CityStateZip.md)
|
563
564
|
- [UltracartClient::Conversation](docs/Conversation.md)
|
565
|
+
- [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
|
564
566
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
565
567
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
568
|
+
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
566
569
|
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
570
|
+
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
567
571
|
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
568
572
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
569
573
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
@@ -1158,6 +1162,9 @@ Not every change is committed to every SDK.
|
|
1158
1162
|
|
1159
1163
|
| Version | Date | Comments |
|
1160
1164
|
| --: | :-: | --- |
|
1165
|
+
| 4.0.38-RC | 07/21/2022 | conversation bugfix for poor response objects |
|
1166
|
+
| 4.0.37-RC | 07/20/2022 | conversation participant name added |
|
1167
|
+
| 4.0.36-RC | 07/18/2022 | twilio dev |
|
1161
1168
|
| 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
|
1162
1169
|
| 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
|
1163
1170
|
| 4.0.33-RC | 07/05/2022 | docs update |
|
data/docs/AutoOrderItem.md
CHANGED
@@ -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
|
+
| **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] |
|
14
15
|
| **frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional] |
|
15
16
|
| **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
|
16
17
|
| **last_order_dts** | **String** | Date/time of the last order of this item | [optional] |
|
@@ -22,6 +23,7 @@
|
|
22
23
|
| **options** | [**Array<AutoOrderItemOption>**](AutoOrderItemOption.md) | Options associated with this item | [optional] |
|
23
24
|
| **original_item_id** | **String** | The original item id purchased. This item controls scheduling. If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date. | [optional] |
|
24
25
|
| **original_quantity** | **Float** | The original quantity purchased | [optional] |
|
26
|
+
| **paused** | **Boolean** | True if paused. This field is an object instead of a primitive for backwards compatibility. | [optional] |
|
25
27
|
| **paypal_payer_id** | **String** | The PayPal Payer ID tied to this item | [optional] |
|
26
28
|
| **paypal_recurring_payment_profile_id** | **String** | The PayPal Profile ID tied to this item | [optional] |
|
27
29
|
| **preshipment_notice_sent** | **Boolean** | True if the preshipment notice associated with the next rebill has been sent | [optional] |
|
@@ -42,6 +44,7 @@ instance = UltracartClient::AutoOrderItem.new(
|
|
42
44
|
arbitrary_unit_cost: null,
|
43
45
|
arbitrary_unit_cost_remaining_orders: null,
|
44
46
|
auto_order_item_oid: null,
|
47
|
+
first_order_dts: null,
|
45
48
|
frequency: null,
|
46
49
|
future_schedules: null,
|
47
50
|
last_order_dts: null,
|
@@ -53,6 +56,7 @@ instance = UltracartClient::AutoOrderItem.new(
|
|
53
56
|
options: null,
|
54
57
|
original_item_id: null,
|
55
58
|
original_quantity: null,
|
59
|
+
paused: null,
|
56
60
|
paypal_payer_id: null,
|
57
61
|
paypal_recurring_payment_profile_id: null,
|
58
62
|
preshipment_notice_sent: null,
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# UltracartClient::ConversationAgentAuth
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_participant_arn** | **String** | | [optional] |
|
8
|
+
| **conversation_participant_name** | **String** | | [optional] |
|
9
|
+
| **jwt** | **String** | | [optional] |
|
10
|
+
| **merchant_id** | **String** | | [optional] |
|
11
|
+
| **twilio_phone_numbers** | **Array<String>** | | [optional] |
|
12
|
+
| **websocket_url** | **String** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ultracart_api'
|
18
|
+
|
19
|
+
instance = UltracartClient::ConversationAgentAuth.new(
|
20
|
+
conversation_participant_arn: null,
|
21
|
+
conversation_participant_name: null,
|
22
|
+
jwt: null,
|
23
|
+
merchant_id: null,
|
24
|
+
twilio_phone_numbers: null,
|
25
|
+
websocket_url: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -4,9 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **
|
7
|
+
| **agent_auth** | [**ConversationAgentAuth**](ConversationAgentAuth.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] |
|
10
12
|
|
11
13
|
## Example
|
12
14
|
|
@@ -14,9 +16,11 @@
|
|
14
16
|
require 'ultracart_api'
|
15
17
|
|
16
18
|
instance = UltracartClient::ConversationAgentAuthResponse.new(
|
17
|
-
|
18
|
-
|
19
|
-
|
19
|
+
agent_auth: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
20
24
|
)
|
21
25
|
```
|
22
26
|
|
data/docs/ConversationApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization |
|
8
8
|
| [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
|
9
|
+
| [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
|
9
10
|
| [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
|
10
11
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
11
12
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
@@ -82,7 +83,7 @@ This endpoint does not need any parameter.
|
|
82
83
|
|
83
84
|
## get_conversation
|
84
85
|
|
85
|
-
> <
|
86
|
+
> <ConversationResponse> get_conversation(conversation_uuid)
|
86
87
|
|
87
88
|
Retrieve a conversation
|
88
89
|
|
@@ -117,7 +118,7 @@ end
|
|
117
118
|
|
118
119
|
This returns an Array which contains the response data, status code and headers.
|
119
120
|
|
120
|
-
> <Array(<
|
121
|
+
> <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
|
121
122
|
|
122
123
|
```ruby
|
123
124
|
begin
|
@@ -125,7 +126,7 @@ begin
|
|
125
126
|
data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
|
126
127
|
p status_code # => 2xx
|
127
128
|
p headers # => { ... }
|
128
|
-
p data # => <
|
129
|
+
p data # => <ConversationResponse>
|
129
130
|
rescue UltracartClient::ApiError => e
|
130
131
|
puts "Error when calling ConversationApi->get_conversation_with_http_info: #{e}"
|
131
132
|
end
|
@@ -139,7 +140,77 @@ end
|
|
139
140
|
|
140
141
|
### Return type
|
141
142
|
|
142
|
-
[**
|
143
|
+
[**ConversationResponse**](ConversationResponse.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: Not defined
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
154
|
+
|
155
|
+
## get_conversation_multimedia_upload_url
|
156
|
+
|
157
|
+
> get_conversation_multimedia_upload_url(extension)
|
158
|
+
|
159
|
+
Get a presigned conersation multimedia upload URL
|
160
|
+
|
161
|
+
Get a presigned conersation multimedia upload URL
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'ultracart_api'
|
168
|
+
require 'json'
|
169
|
+
require 'yaml'
|
170
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
171
|
+
|
172
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
173
|
+
# As such, this might not be the best way to use this object.
|
174
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
175
|
+
|
176
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
177
|
+
extension = 'extension_example' # String |
|
178
|
+
|
179
|
+
begin
|
180
|
+
# Get a presigned conersation multimedia upload URL
|
181
|
+
api_instance.get_conversation_multimedia_upload_url(extension)
|
182
|
+
rescue UltracartClient::ApiError => e
|
183
|
+
puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
|
184
|
+
end
|
185
|
+
```
|
186
|
+
|
187
|
+
#### Using the get_conversation_multimedia_upload_url_with_http_info variant
|
188
|
+
|
189
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
190
|
+
|
191
|
+
> <Array(nil, Integer, Hash)> get_conversation_multimedia_upload_url_with_http_info(extension)
|
192
|
+
|
193
|
+
```ruby
|
194
|
+
begin
|
195
|
+
# Get a presigned conersation multimedia upload URL
|
196
|
+
data, status_code, headers = api_instance.get_conversation_multimedia_upload_url_with_http_info(extension)
|
197
|
+
p status_code # => 2xx
|
198
|
+
p headers # => { ... }
|
199
|
+
p data # => nil
|
200
|
+
rescue UltracartClient::ApiError => e
|
201
|
+
puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url_with_http_info: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
### Parameters
|
206
|
+
|
207
|
+
| Name | Type | Description | Notes |
|
208
|
+
| ---- | ---- | ----------- | ----- |
|
209
|
+
| **extension** | **String** | | |
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
nil (empty response body)
|
143
214
|
|
144
215
|
### Authorization
|
145
216
|
|
data/docs/ConversationMessage.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **body** | **String** | | [optional] |
|
10
10
|
| **media_urls** | **Array<String>** | | [optional] |
|
11
11
|
| **message_dts** | **String** | Message date/time | [optional] |
|
12
|
+
| **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) | | [optional] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = UltracartClient::ConversationMessage.new(
|
|
20
21
|
author_conversation_participant_name: null,
|
21
22
|
body: null,
|
22
23
|
media_urls: null,
|
23
|
-
message_dts: null
|
24
|
+
message_dts: null,
|
25
|
+
transport_statuses: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationMessageTransportStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_participant_arn** | **String** | | [optional] |
|
8
|
+
| **status** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationMessageTransportStatus.new(
|
16
|
+
conversation_participant_arn: null,
|
17
|
+
status: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation** | [**Conversation**](Conversation.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::ConversationResponse.new(
|
19
|
+
conversation: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -4,8 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **conversation_uuid** | **String** | | [optional] |
|
7
|
+
| **conversation** | [**Conversation**](Conversation.md) | | [optional] |
|
9
8
|
|
10
9
|
## Example
|
11
10
|
|
@@ -13,8 +12,7 @@
|
|
13
12
|
require 'ultracart_api'
|
14
13
|
|
15
14
|
instance = UltracartClient::ConversationStartResponse.new(
|
16
|
-
|
17
|
-
conversation_uuid: null
|
15
|
+
conversation: null
|
18
16
|
)
|
19
17
|
```
|
20
18
|
|
@@ -14,7 +14,7 @@
|
|
14
14
|
| **postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional] |
|
15
15
|
| **postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional] |
|
16
16
|
| **postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional] |
|
17
|
-
| **screenshot_back_url** | **String** | URL to screenshot of the
|
17
|
+
| **screenshot_back_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
|
18
18
|
| **screenshot_front_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
|
19
19
|
| **storefront_oid** | **Integer** | Storefront oid | [optional] |
|
20
20
|
|
@@ -94,7 +94,7 @@ module UltracartClient
|
|
94
94
|
# Retrieve a conversation including the participants and messages
|
95
95
|
# @param conversation_uuid [String]
|
96
96
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @return [
|
97
|
+
# @return [ConversationResponse]
|
98
98
|
def get_conversation(conversation_uuid, opts = {})
|
99
99
|
data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
|
100
100
|
data
|
@@ -104,7 +104,7 @@ module UltracartClient
|
|
104
104
|
# Retrieve a conversation including the participants and messages
|
105
105
|
# @param conversation_uuid [String]
|
106
106
|
# @param [Hash] opts the optional parameters
|
107
|
-
# @return [Array<(
|
107
|
+
# @return [Array<(ConversationResponse, Integer, Hash)>] ConversationResponse data, response status code and response headers
|
108
108
|
def get_conversation_with_http_info(conversation_uuid, opts = {})
|
109
109
|
if @api_client.config.debugging
|
110
110
|
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
|
@@ -132,7 +132,7 @@ module UltracartClient
|
|
132
132
|
post_body = opts[:debug_body]
|
133
133
|
|
134
134
|
# return_type
|
135
|
-
return_type = opts[:debug_return_type] || '
|
135
|
+
return_type = opts[:debug_return_type] || 'ConversationResponse'
|
136
136
|
|
137
137
|
# auth_names
|
138
138
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
@@ -154,6 +154,70 @@ module UltracartClient
|
|
154
154
|
return data, status_code, headers
|
155
155
|
end
|
156
156
|
|
157
|
+
# Get a presigned conersation multimedia upload URL
|
158
|
+
# Get a presigned conersation multimedia upload URL
|
159
|
+
# @param extension [String]
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @return [nil]
|
162
|
+
def get_conversation_multimedia_upload_url(extension, opts = {})
|
163
|
+
get_conversation_multimedia_upload_url_with_http_info(extension, opts)
|
164
|
+
nil
|
165
|
+
end
|
166
|
+
|
167
|
+
# Get a presigned conersation multimedia upload URL
|
168
|
+
# Get a presigned conersation multimedia upload URL
|
169
|
+
# @param extension [String]
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
172
|
+
def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
|
173
|
+
if @api_client.config.debugging
|
174
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
|
175
|
+
end
|
176
|
+
# verify the required parameter 'extension' is set
|
177
|
+
if @api_client.config.client_side_validation && extension.nil?
|
178
|
+
fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
|
179
|
+
end
|
180
|
+
# resource path
|
181
|
+
local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', CGI.escape(extension.to_s))
|
182
|
+
|
183
|
+
# query parameters
|
184
|
+
query_params = opts[:query_params] || {}
|
185
|
+
|
186
|
+
# header parameters
|
187
|
+
header_params = opts[:header_params] || {}
|
188
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
191
|
+
|
192
|
+
# form parameters
|
193
|
+
form_params = opts[:form_params] || {}
|
194
|
+
|
195
|
+
# http body (model)
|
196
|
+
post_body = opts[:debug_body]
|
197
|
+
|
198
|
+
# return_type
|
199
|
+
return_type = opts[:debug_return_type]
|
200
|
+
|
201
|
+
# auth_names
|
202
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
203
|
+
|
204
|
+
new_options = opts.merge(
|
205
|
+
:operation => :"ConversationApi.get_conversation_multimedia_upload_url",
|
206
|
+
:header_params => header_params,
|
207
|
+
:query_params => query_params,
|
208
|
+
:form_params => form_params,
|
209
|
+
:body => post_body,
|
210
|
+
:auth_names => auth_names,
|
211
|
+
:return_type => return_type
|
212
|
+
)
|
213
|
+
|
214
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
215
|
+
if @api_client.config.debugging
|
216
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
217
|
+
end
|
218
|
+
return data, status_code, headers
|
219
|
+
end
|
220
|
+
|
157
221
|
# Retrieve a list of conversation summaries newest to oldest
|
158
222
|
# Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
|
159
223
|
# @param [Hash] opts the optional parameters
|
@@ -36,6 +36,9 @@ module UltracartClient
|
|
36
36
|
# Primary key of AutoOrderItem
|
37
37
|
attr_accessor :auto_order_item_oid
|
38
38
|
|
39
|
+
# Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
|
40
|
+
attr_accessor :first_order_dts
|
41
|
+
|
39
42
|
# Frequency of the rebill if not a fixed schedule
|
40
43
|
attr_accessor :frequency
|
41
44
|
|
@@ -69,6 +72,9 @@ module UltracartClient
|
|
69
72
|
# The original quantity purchased
|
70
73
|
attr_accessor :original_quantity
|
71
74
|
|
75
|
+
# True if paused. This field is an object instead of a primitive for backwards compatibility.
|
76
|
+
attr_accessor :paused
|
77
|
+
|
72
78
|
# The PayPal Payer ID tied to this item
|
73
79
|
attr_accessor :paypal_payer_id
|
74
80
|
|
@@ -118,6 +124,7 @@ module UltracartClient
|
|
118
124
|
:'arbitrary_unit_cost' => :'arbitrary_unit_cost',
|
119
125
|
:'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
|
120
126
|
:'auto_order_item_oid' => :'auto_order_item_oid',
|
127
|
+
:'first_order_dts' => :'first_order_dts',
|
121
128
|
:'frequency' => :'frequency',
|
122
129
|
:'future_schedules' => :'future_schedules',
|
123
130
|
:'last_order_dts' => :'last_order_dts',
|
@@ -129,6 +136,7 @@ module UltracartClient
|
|
129
136
|
:'options' => :'options',
|
130
137
|
:'original_item_id' => :'original_item_id',
|
131
138
|
:'original_quantity' => :'original_quantity',
|
139
|
+
:'paused' => :'paused',
|
132
140
|
:'paypal_payer_id' => :'paypal_payer_id',
|
133
141
|
:'paypal_recurring_payment_profile_id' => :'paypal_recurring_payment_profile_id',
|
134
142
|
:'preshipment_notice_sent' => :'preshipment_notice_sent',
|
@@ -153,6 +161,7 @@ module UltracartClient
|
|
153
161
|
:'arbitrary_unit_cost' => :'Float',
|
154
162
|
:'arbitrary_unit_cost_remaining_orders' => :'Integer',
|
155
163
|
:'auto_order_item_oid' => :'Integer',
|
164
|
+
:'first_order_dts' => :'String',
|
156
165
|
:'frequency' => :'String',
|
157
166
|
:'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
|
158
167
|
:'last_order_dts' => :'String',
|
@@ -164,6 +173,7 @@ module UltracartClient
|
|
164
173
|
:'options' => :'Array<AutoOrderItemOption>',
|
165
174
|
:'original_item_id' => :'String',
|
166
175
|
:'original_quantity' => :'Float',
|
176
|
+
:'paused' => :'Boolean',
|
167
177
|
:'paypal_payer_id' => :'String',
|
168
178
|
:'paypal_recurring_payment_profile_id' => :'String',
|
169
179
|
:'preshipment_notice_sent' => :'Boolean',
|
@@ -222,6 +232,10 @@ module UltracartClient
|
|
222
232
|
self.auto_order_item_oid = attributes[:'auto_order_item_oid']
|
223
233
|
end
|
224
234
|
|
235
|
+
if attributes.key?(:'first_order_dts')
|
236
|
+
self.first_order_dts = attributes[:'first_order_dts']
|
237
|
+
end
|
238
|
+
|
225
239
|
if attributes.key?(:'frequency')
|
226
240
|
self.frequency = attributes[:'frequency']
|
227
241
|
end
|
@@ -270,6 +284,10 @@ module UltracartClient
|
|
270
284
|
self.original_quantity = attributes[:'original_quantity']
|
271
285
|
end
|
272
286
|
|
287
|
+
if attributes.key?(:'paused')
|
288
|
+
self.paused = attributes[:'paused']
|
289
|
+
end
|
290
|
+
|
273
291
|
if attributes.key?(:'paypal_payer_id')
|
274
292
|
self.paypal_payer_id = attributes[:'paypal_payer_id']
|
275
293
|
end
|
@@ -332,6 +350,7 @@ module UltracartClient
|
|
332
350
|
arbitrary_unit_cost == o.arbitrary_unit_cost &&
|
333
351
|
arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
|
334
352
|
auto_order_item_oid == o.auto_order_item_oid &&
|
353
|
+
first_order_dts == o.first_order_dts &&
|
335
354
|
frequency == o.frequency &&
|
336
355
|
future_schedules == o.future_schedules &&
|
337
356
|
last_order_dts == o.last_order_dts &&
|
@@ -343,6 +362,7 @@ module UltracartClient
|
|
343
362
|
options == o.options &&
|
344
363
|
original_item_id == o.original_item_id &&
|
345
364
|
original_quantity == o.original_quantity &&
|
365
|
+
paused == o.paused &&
|
346
366
|
paypal_payer_id == o.paypal_payer_id &&
|
347
367
|
paypal_recurring_payment_profile_id == o.paypal_recurring_payment_profile_id &&
|
348
368
|
preshipment_notice_sent == o.preshipment_notice_sent &&
|
@@ -360,7 +380,7 @@ module UltracartClient
|
|
360
380
|
# Calculates hash code according to all attributes.
|
361
381
|
# @return [Integer] Hash code
|
362
382
|
def hash
|
363
|
-
[arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
|
383
|
+
[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_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
|
364
384
|
end
|
365
385
|
|
366
386
|
# Builds the object from hash
|