ultracart_api 4.0.133 → 4.0.135
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -4
- data/docs/CartCheckout.md +6 -0
- data/docs/ConversationApi.md +71 -0
- data/docs/Order.md +3 -1
- data/docs/OrderCheckout.md +6 -0
- data/docs/OrderUtm.md +64 -0
- data/docs/PricingTier.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -0
- data/lib/ultracart_api/models/cart_checkout.rb +76 -1
- data/lib/ultracart_api/models/order.rb +16 -4
- data/lib/ultracart_api/models/order_checkout.rb +76 -1
- data/lib/ultracart_api/models/order_utm.rb +427 -0
- data/lib/ultracart_api/models/pricing_tier.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 957070c75bab53ffcaec29cf1bea74ca2cfaa1b3e945d766662faa31d89155a9
|
4
|
+
data.tar.gz: f8c2d6d4d3ab71f1910c8b97c172b0407c305501e9ce1336924a4b4da60efafd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 93eddbcce4641a622f687671fc6e290ba01681219421cd62df36fd77b5ffaabe3105123dedfa2c3418e4925116f825b06c3e179426b5a8086892258a251b31e8
|
7
|
+
data.tar.gz: 5eadc726d7dc3e19090cc04a73404aa256efa7eacbcc13cd7125e17cab61f42ed8db2d2269cf9ba3eeee894e9eaebd61ba5b40283cfdee162ccb9871adf56e90
|
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.135
|
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.135.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.135.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.135'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
165
165
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
166
166
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
167
167
|
*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
|
168
|
+
*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
168
169
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
169
170
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
170
171
|
*UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
@@ -1104,6 +1105,7 @@ Class | Method | HTTP request | Description
|
|
1104
1105
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
1105
1106
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
1106
1107
|
- [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
|
1108
|
+
- [UltracartClient::OrderUtm](docs/OrderUtm.md)
|
1107
1109
|
- [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
|
1108
1110
|
- [UltracartClient::Permission](docs/Permission.md)
|
1109
1111
|
- [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
|
@@ -1308,6 +1310,8 @@ Not every change is committed to every SDK.
|
|
1308
1310
|
|
1309
1311
|
| Version | Date | Comments |
|
1310
1312
|
| --: | :-: | --- |
|
1313
|
+
| 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
|
1314
|
+
| 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
|
1311
1315
|
| 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
|
1312
1316
|
| 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
1313
1317
|
| 4.0.131 | 02/07/2023 | convo - new event for when a customer joins a queue |
|
data/docs/CartCheckout.md
CHANGED
@@ -6,12 +6,15 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **comments** | **String** | Comments from the customer. Rarely used on the single page checkout. | [optional] |
|
8
8
|
| **custom_field1** | **String** | Custom field 1 | [optional] |
|
9
|
+
| **custom_field10** | **String** | Custom field 10 | [optional] |
|
9
10
|
| **custom_field2** | **String** | Custom field 2 | [optional] |
|
10
11
|
| **custom_field3** | **String** | Custom field 3 | [optional] |
|
11
12
|
| **custom_field4** | **String** | Custom field 4 | [optional] |
|
12
13
|
| **custom_field5** | **String** | Custom field 5 | [optional] |
|
13
14
|
| **custom_field6** | **String** | Custom field 6 | [optional] |
|
14
15
|
| **custom_field7** | **String** | Custom field 7 | [optional] |
|
16
|
+
| **custom_field8** | **String** | Custom field 8 | [optional] |
|
17
|
+
| **custom_field9** | **String** | Custom field 9 | [optional] |
|
15
18
|
| **ip_address** | **String** | IP Address (read only unless non-browser key authenticated) | [optional] |
|
16
19
|
| **return_code** | **String** | Return code assigned for send return email operation | [optional] |
|
17
20
|
| **return_url** | **String** | The URL to redirect the customer to when they return from an abandon cart email. Must be https protocol. | [optional] |
|
@@ -27,12 +30,15 @@ require 'ultracart_api'
|
|
27
30
|
instance = UltracartClient::CartCheckout.new(
|
28
31
|
comments: null,
|
29
32
|
custom_field1: null,
|
33
|
+
custom_field10: null,
|
30
34
|
custom_field2: null,
|
31
35
|
custom_field3: null,
|
32
36
|
custom_field4: null,
|
33
37
|
custom_field5: null,
|
34
38
|
custom_field6: null,
|
35
39
|
custom_field7: null,
|
40
|
+
custom_field8: null,
|
41
|
+
custom_field9: null,
|
36
42
|
ip_address: null,
|
37
43
|
return_code: null,
|
38
44
|
return_url: null,
|
data/docs/ConversationApi.md
CHANGED
@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
32
32
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
33
33
|
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
34
34
|
| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
|
35
|
+
| [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
|
35
36
|
| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
|
36
37
|
| [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile |
|
37
38
|
| [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message |
|
@@ -2013,6 +2014,76 @@ end
|
|
2013
2014
|
- **Accept**: application/json
|
2014
2015
|
|
2015
2016
|
|
2017
|
+
## sms_unsubscribe_conversation
|
2018
|
+
|
2019
|
+
> sms_unsubscribe_conversation(conversation_uuid)
|
2020
|
+
|
2021
|
+
Unsubscribe any SMS participants in this conversation
|
2022
|
+
|
2023
|
+
Unsubscribe any SMS participants in this conversation
|
2024
|
+
|
2025
|
+
### Examples
|
2026
|
+
|
2027
|
+
```ruby
|
2028
|
+
require 'time'
|
2029
|
+
require 'ultracart_api'
|
2030
|
+
require 'json'
|
2031
|
+
require 'yaml'
|
2032
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2033
|
+
|
2034
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2035
|
+
# As such, this might not be the best way to use this object.
|
2036
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2037
|
+
|
2038
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2039
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
2040
|
+
|
2041
|
+
begin
|
2042
|
+
# Unsubscribe any SMS participants in this conversation
|
2043
|
+
api_instance.sms_unsubscribe_conversation(conversation_uuid)
|
2044
|
+
rescue UltracartClient::ApiError => e
|
2045
|
+
puts "Error when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
|
2046
|
+
end
|
2047
|
+
```
|
2048
|
+
|
2049
|
+
#### Using the sms_unsubscribe_conversation_with_http_info variant
|
2050
|
+
|
2051
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2052
|
+
|
2053
|
+
> <Array(nil, Integer, Hash)> sms_unsubscribe_conversation_with_http_info(conversation_uuid)
|
2054
|
+
|
2055
|
+
```ruby
|
2056
|
+
begin
|
2057
|
+
# Unsubscribe any SMS participants in this conversation
|
2058
|
+
data, status_code, headers = api_instance.sms_unsubscribe_conversation_with_http_info(conversation_uuid)
|
2059
|
+
p status_code # => 2xx
|
2060
|
+
p headers # => { ... }
|
2061
|
+
p data # => nil
|
2062
|
+
rescue UltracartClient::ApiError => e
|
2063
|
+
puts "Error when calling ConversationApi->sms_unsubscribe_conversation_with_http_info: #{e}"
|
2064
|
+
end
|
2065
|
+
```
|
2066
|
+
|
2067
|
+
### Parameters
|
2068
|
+
|
2069
|
+
| Name | Type | Description | Notes |
|
2070
|
+
| ---- | ---- | ----------- | ----- |
|
2071
|
+
| **conversation_uuid** | **String** | | |
|
2072
|
+
|
2073
|
+
### Return type
|
2074
|
+
|
2075
|
+
nil (empty response body)
|
2076
|
+
|
2077
|
+
### Authorization
|
2078
|
+
|
2079
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2080
|
+
|
2081
|
+
### HTTP request headers
|
2082
|
+
|
2083
|
+
- **Content-Type**: Not defined
|
2084
|
+
- **Accept**: application/json
|
2085
|
+
|
2086
|
+
|
2016
2087
|
## start_conversation
|
2017
2088
|
|
2018
2089
|
> <ConversationStartResponse> start_conversation(start_request)
|
data/docs/Order.md
CHANGED
@@ -39,6 +39,7 @@
|
|
39
39
|
| **summary** | [**OrderSummary**](OrderSummary.md) | | [optional] |
|
40
40
|
| **tags** | [**Array<OrderTag>**](OrderTag.md) | tags, available only through update, not through insert due to the nature of how tags are handled internally | [optional] |
|
41
41
|
| **taxes** | [**OrderTaxes**](OrderTaxes.md) | | [optional] |
|
42
|
+
| **utms** | [**Array<OrderUtm>**](OrderUtm.md) | UTM clicks. The zero index is the most recent (last) UTM click | [optional] |
|
42
43
|
|
43
44
|
## Example
|
44
45
|
|
@@ -80,7 +81,8 @@ instance = UltracartClient::Order.new(
|
|
80
81
|
shipping: null,
|
81
82
|
summary: null,
|
82
83
|
tags: null,
|
83
|
-
taxes: null
|
84
|
+
taxes: null,
|
85
|
+
utms: null
|
84
86
|
)
|
85
87
|
```
|
86
88
|
|
data/docs/OrderCheckout.md
CHANGED
@@ -7,12 +7,15 @@
|
|
7
7
|
| **browser** | [**Browser**](Browser.md) | | [optional] |
|
8
8
|
| **comments** | **String** | Comments from the customer. Rarely used on the single page checkout. | [optional] |
|
9
9
|
| **custom_field1** | **String** | Custom field 1 | [optional] |
|
10
|
+
| **custom_field10** | **String** | Custom field 10 | [optional] |
|
10
11
|
| **custom_field2** | **String** | Custom field 2 | [optional] |
|
11
12
|
| **custom_field3** | **String** | Custom field 3 | [optional] |
|
12
13
|
| **custom_field4** | **String** | Custom field 4 | [optional] |
|
13
14
|
| **custom_field5** | **String** | Custom field 5 | [optional] |
|
14
15
|
| **custom_field6** | **String** | Custom field 6 | [optional] |
|
15
16
|
| **custom_field7** | **String** | Custom field 7 | [optional] |
|
17
|
+
| **custom_field8** | **String** | Custom field 8 | [optional] |
|
18
|
+
| **custom_field9** | **String** | Custom field 9 | [optional] |
|
16
19
|
| **customer_ip_address** | **String** | IP address of the customer when placing the order | [optional] |
|
17
20
|
| **screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional] |
|
18
21
|
| **screen_size** | **String** | Screen size small, medium or large | [optional] |
|
@@ -28,12 +31,15 @@ instance = UltracartClient::OrderCheckout.new(
|
|
28
31
|
browser: null,
|
29
32
|
comments: null,
|
30
33
|
custom_field1: null,
|
34
|
+
custom_field10: null,
|
31
35
|
custom_field2: null,
|
32
36
|
custom_field3: null,
|
33
37
|
custom_field4: null,
|
34
38
|
custom_field5: null,
|
35
39
|
custom_field6: null,
|
36
40
|
custom_field7: null,
|
41
|
+
custom_field8: null,
|
42
|
+
custom_field9: null,
|
37
43
|
customer_ip_address: null,
|
38
44
|
screen_branding_theme_code: null,
|
39
45
|
screen_size: null,
|
data/docs/OrderUtm.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# UltracartClient::OrderUtm
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **attribution_first_click_subtotal** | **Float** | | [optional] |
|
8
|
+
| **attribution_first_click_total** | **Float** | | [optional] |
|
9
|
+
| **attribution_last_click_subtotal** | **Float** | | [optional] |
|
10
|
+
| **attribution_last_click_total** | **Float** | | [optional] |
|
11
|
+
| **attribution_linear_subtotal** | **Float** | | [optional] |
|
12
|
+
| **attribution_linear_total** | **Float** | | [optional] |
|
13
|
+
| **attribution_position_based_subtotal** | **Float** | | [optional] |
|
14
|
+
| **attribution_position_based_total** | **Float** | | [optional] |
|
15
|
+
| **click_dts** | **String** | Date/time that the click happened | [optional] |
|
16
|
+
| **facebook_ad_id** | **String** | | [optional] |
|
17
|
+
| **fbclid** | **String** | | [optional] |
|
18
|
+
| **gbraid** | **String** | | [optional] |
|
19
|
+
| **glcid** | **String** | | [optional] |
|
20
|
+
| **msclkid** | **String** | | [optional] |
|
21
|
+
| **ttclid** | **String** | | [optional] |
|
22
|
+
| **uc_message_id** | **String** | | [optional] |
|
23
|
+
| **utm_campaign** | **String** | | [optional] |
|
24
|
+
| **utm_content** | **String** | | [optional] |
|
25
|
+
| **utm_id** | **String** | | [optional] |
|
26
|
+
| **utm_medium** | **String** | | [optional] |
|
27
|
+
| **utm_source** | **String** | | [optional] |
|
28
|
+
| **utm_term** | **String** | | [optional] |
|
29
|
+
| **vmcid** | **String** | | [optional] |
|
30
|
+
| **wbraid** | **String** | | [optional] |
|
31
|
+
|
32
|
+
## Example
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
require 'ultracart_api'
|
36
|
+
|
37
|
+
instance = UltracartClient::OrderUtm.new(
|
38
|
+
attribution_first_click_subtotal: null,
|
39
|
+
attribution_first_click_total: null,
|
40
|
+
attribution_last_click_subtotal: null,
|
41
|
+
attribution_last_click_total: null,
|
42
|
+
attribution_linear_subtotal: null,
|
43
|
+
attribution_linear_total: null,
|
44
|
+
attribution_position_based_subtotal: null,
|
45
|
+
attribution_position_based_total: null,
|
46
|
+
click_dts: null,
|
47
|
+
facebook_ad_id: null,
|
48
|
+
fbclid: null,
|
49
|
+
gbraid: null,
|
50
|
+
glcid: null,
|
51
|
+
msclkid: null,
|
52
|
+
ttclid: null,
|
53
|
+
uc_message_id: null,
|
54
|
+
utm_campaign: null,
|
55
|
+
utm_content: null,
|
56
|
+
utm_id: null,
|
57
|
+
utm_medium: null,
|
58
|
+
utm_source: null,
|
59
|
+
utm_term: null,
|
60
|
+
vmcid: null,
|
61
|
+
wbraid: null
|
62
|
+
)
|
63
|
+
```
|
64
|
+
|
data/docs/PricingTier.md
CHANGED
@@ -31,6 +31,7 @@
|
|
31
31
|
| **not_valid_when_coupon_present** | **Boolean** | Not valid when coupon present | [optional] |
|
32
32
|
| **pricing_tier_oid** | **Integer** | Pricing Tier Oid | [optional] |
|
33
33
|
| **realtime_percentage_discount** | **Float** | Realtime percentage discount | [optional] |
|
34
|
+
| **restrict_to_distribution_center_oid** | **Integer** | Restrict inventory to this distribution center oid | [optional] |
|
34
35
|
| **signup_notification** | [**PricingTierNotification**](PricingTierNotification.md) | | [optional] |
|
35
36
|
| **suppress_buysafe** | **Boolean** | Suppress buySAFE (deprecated) | [optional] |
|
36
37
|
| **suppress_mailing_list** | **Boolean** | Suppress mailing list | [optional] |
|
@@ -70,6 +71,7 @@ instance = UltracartClient::PricingTier.new(
|
|
70
71
|
not_valid_when_coupon_present: null,
|
71
72
|
pricing_tier_oid: null,
|
72
73
|
realtime_percentage_discount: null,
|
74
|
+
restrict_to_distribution_center_oid: null,
|
73
75
|
signup_notification: null,
|
74
76
|
suppress_buysafe: null,
|
75
77
|
suppress_mailing_list: null,
|
@@ -1819,6 +1819,70 @@ module UltracartClient
|
|
1819
1819
|
return data, status_code, headers
|
1820
1820
|
end
|
1821
1821
|
|
1822
|
+
# Unsubscribe any SMS participants in this conversation
|
1823
|
+
# Unsubscribe any SMS participants in this conversation
|
1824
|
+
# @param conversation_uuid [String]
|
1825
|
+
# @param [Hash] opts the optional parameters
|
1826
|
+
# @return [nil]
|
1827
|
+
def sms_unsubscribe_conversation(conversation_uuid, opts = {})
|
1828
|
+
sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
|
1829
|
+
nil
|
1830
|
+
end
|
1831
|
+
|
1832
|
+
# Unsubscribe any SMS participants in this conversation
|
1833
|
+
# Unsubscribe any SMS participants in this conversation
|
1834
|
+
# @param conversation_uuid [String]
|
1835
|
+
# @param [Hash] opts the optional parameters
|
1836
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1837
|
+
def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
|
1838
|
+
if @api_client.config.debugging
|
1839
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
|
1840
|
+
end
|
1841
|
+
# verify the required parameter 'conversation_uuid' is set
|
1842
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
1843
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
|
1844
|
+
end
|
1845
|
+
# resource path
|
1846
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
|
1847
|
+
|
1848
|
+
# query parameters
|
1849
|
+
query_params = opts[:query_params] || {}
|
1850
|
+
|
1851
|
+
# header parameters
|
1852
|
+
header_params = opts[:header_params] || {}
|
1853
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1854
|
+
# HTTP header 'Accept' (if needed)
|
1855
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1856
|
+
|
1857
|
+
# form parameters
|
1858
|
+
form_params = opts[:form_params] || {}
|
1859
|
+
|
1860
|
+
# http body (model)
|
1861
|
+
post_body = opts[:debug_body]
|
1862
|
+
|
1863
|
+
# return_type
|
1864
|
+
return_type = opts[:debug_return_type]
|
1865
|
+
|
1866
|
+
# auth_names
|
1867
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1868
|
+
|
1869
|
+
new_options = opts.merge(
|
1870
|
+
:operation => :"ConversationApi.sms_unsubscribe_conversation",
|
1871
|
+
:header_params => header_params,
|
1872
|
+
:query_params => query_params,
|
1873
|
+
:form_params => form_params,
|
1874
|
+
:body => post_body,
|
1875
|
+
:auth_names => auth_names,
|
1876
|
+
:return_type => return_type
|
1877
|
+
)
|
1878
|
+
|
1879
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1880
|
+
if @api_client.config.debugging
|
1881
|
+
@api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1882
|
+
end
|
1883
|
+
return data, status_code, headers
|
1884
|
+
end
|
1885
|
+
|
1822
1886
|
# Start a conversation
|
1823
1887
|
# Start a new conversation
|
1824
1888
|
# @param start_request [ConversationStartRequest] Start request
|
@@ -21,6 +21,9 @@ module UltracartClient
|
|
21
21
|
# Custom field 1
|
22
22
|
attr_accessor :custom_field1
|
23
23
|
|
24
|
+
# Custom field 10
|
25
|
+
attr_accessor :custom_field10
|
26
|
+
|
24
27
|
# Custom field 2
|
25
28
|
attr_accessor :custom_field2
|
26
29
|
|
@@ -39,6 +42,12 @@ module UltracartClient
|
|
39
42
|
# Custom field 7
|
40
43
|
attr_accessor :custom_field7
|
41
44
|
|
45
|
+
# Custom field 8
|
46
|
+
attr_accessor :custom_field8
|
47
|
+
|
48
|
+
# Custom field 9
|
49
|
+
attr_accessor :custom_field9
|
50
|
+
|
42
51
|
# IP Address (read only unless non-browser key authenticated)
|
43
52
|
attr_accessor :ip_address
|
44
53
|
|
@@ -62,12 +71,15 @@ module UltracartClient
|
|
62
71
|
{
|
63
72
|
:'comments' => :'comments',
|
64
73
|
:'custom_field1' => :'custom_field1',
|
74
|
+
:'custom_field10' => :'custom_field10',
|
65
75
|
:'custom_field2' => :'custom_field2',
|
66
76
|
:'custom_field3' => :'custom_field3',
|
67
77
|
:'custom_field4' => :'custom_field4',
|
68
78
|
:'custom_field5' => :'custom_field5',
|
69
79
|
:'custom_field6' => :'custom_field6',
|
70
80
|
:'custom_field7' => :'custom_field7',
|
81
|
+
:'custom_field8' => :'custom_field8',
|
82
|
+
:'custom_field9' => :'custom_field9',
|
71
83
|
:'ip_address' => :'ip_address',
|
72
84
|
:'return_code' => :'return_code',
|
73
85
|
:'return_url' => :'return_url',
|
@@ -87,12 +99,15 @@ module UltracartClient
|
|
87
99
|
{
|
88
100
|
:'comments' => :'String',
|
89
101
|
:'custom_field1' => :'String',
|
102
|
+
:'custom_field10' => :'String',
|
90
103
|
:'custom_field2' => :'String',
|
91
104
|
:'custom_field3' => :'String',
|
92
105
|
:'custom_field4' => :'String',
|
93
106
|
:'custom_field5' => :'String',
|
94
107
|
:'custom_field6' => :'String',
|
95
108
|
:'custom_field7' => :'String',
|
109
|
+
:'custom_field8' => :'String',
|
110
|
+
:'custom_field9' => :'String',
|
96
111
|
:'ip_address' => :'String',
|
97
112
|
:'return_code' => :'String',
|
98
113
|
:'return_url' => :'String',
|
@@ -131,6 +146,10 @@ module UltracartClient
|
|
131
146
|
self.custom_field1 = attributes[:'custom_field1']
|
132
147
|
end
|
133
148
|
|
149
|
+
if attributes.key?(:'custom_field10')
|
150
|
+
self.custom_field10 = attributes[:'custom_field10']
|
151
|
+
end
|
152
|
+
|
134
153
|
if attributes.key?(:'custom_field2')
|
135
154
|
self.custom_field2 = attributes[:'custom_field2']
|
136
155
|
end
|
@@ -155,6 +174,14 @@ module UltracartClient
|
|
155
174
|
self.custom_field7 = attributes[:'custom_field7']
|
156
175
|
end
|
157
176
|
|
177
|
+
if attributes.key?(:'custom_field8')
|
178
|
+
self.custom_field8 = attributes[:'custom_field8']
|
179
|
+
end
|
180
|
+
|
181
|
+
if attributes.key?(:'custom_field9')
|
182
|
+
self.custom_field9 = attributes[:'custom_field9']
|
183
|
+
end
|
184
|
+
|
158
185
|
if attributes.key?(:'ip_address')
|
159
186
|
self.ip_address = attributes[:'ip_address']
|
160
187
|
end
|
@@ -192,6 +219,10 @@ module UltracartClient
|
|
192
219
|
invalid_properties.push('invalid value for "custom_field1", the character length must be smaller than or equal to 50.')
|
193
220
|
end
|
194
221
|
|
222
|
+
if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
223
|
+
invalid_properties.push('invalid value for "custom_field10", the character length must be smaller than or equal to 200.')
|
224
|
+
end
|
225
|
+
|
195
226
|
if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
196
227
|
invalid_properties.push('invalid value for "custom_field2", the character length must be smaller than or equal to 50.')
|
197
228
|
end
|
@@ -216,6 +247,14 @@ module UltracartClient
|
|
216
247
|
invalid_properties.push('invalid value for "custom_field7", the character length must be smaller than or equal to 50.')
|
217
248
|
end
|
218
249
|
|
250
|
+
if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
251
|
+
invalid_properties.push('invalid value for "custom_field8", the character length must be smaller than or equal to 200.')
|
252
|
+
end
|
253
|
+
|
254
|
+
if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
255
|
+
invalid_properties.push('invalid value for "custom_field9", the character length must be smaller than or equal to 200.')
|
256
|
+
end
|
257
|
+
|
219
258
|
if !@return_url.nil? && @return_url.to_s.length > 2048
|
220
259
|
invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 2048.')
|
221
260
|
end
|
@@ -232,12 +271,15 @@ module UltracartClient
|
|
232
271
|
def valid?
|
233
272
|
return false if !@comments.nil? && @comments.to_s.length > 2000
|
234
273
|
return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
|
274
|
+
return false if !@custom_field10.nil? && @custom_field10.to_s.length > 200
|
235
275
|
return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
|
236
276
|
return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
|
237
277
|
return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
|
238
278
|
return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
|
239
279
|
return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
|
240
280
|
return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
|
281
|
+
return false if !@custom_field8.nil? && @custom_field8.to_s.length > 200
|
282
|
+
return false if !@custom_field9.nil? && @custom_field9.to_s.length > 200
|
241
283
|
return false if !@return_url.nil? && @return_url.to_s.length > 2048
|
242
284
|
return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
|
243
285
|
true
|
@@ -263,6 +305,16 @@ module UltracartClient
|
|
263
305
|
@custom_field1 = custom_field1
|
264
306
|
end
|
265
307
|
|
308
|
+
# Custom attribute writer method with validation
|
309
|
+
# @param [Object] custom_field10 Value to be assigned
|
310
|
+
def custom_field10=(custom_field10)
|
311
|
+
if !custom_field10.nil? && custom_field10.to_s.length > 200
|
312
|
+
fail ArgumentError, 'invalid value for "custom_field10", the character length must be smaller than or equal to 200.'
|
313
|
+
end
|
314
|
+
|
315
|
+
@custom_field10 = custom_field10
|
316
|
+
end
|
317
|
+
|
266
318
|
# Custom attribute writer method with validation
|
267
319
|
# @param [Object] custom_field2 Value to be assigned
|
268
320
|
def custom_field2=(custom_field2)
|
@@ -323,6 +375,26 @@ module UltracartClient
|
|
323
375
|
@custom_field7 = custom_field7
|
324
376
|
end
|
325
377
|
|
378
|
+
# Custom attribute writer method with validation
|
379
|
+
# @param [Object] custom_field8 Value to be assigned
|
380
|
+
def custom_field8=(custom_field8)
|
381
|
+
if !custom_field8.nil? && custom_field8.to_s.length > 200
|
382
|
+
fail ArgumentError, 'invalid value for "custom_field8", the character length must be smaller than or equal to 200.'
|
383
|
+
end
|
384
|
+
|
385
|
+
@custom_field8 = custom_field8
|
386
|
+
end
|
387
|
+
|
388
|
+
# Custom attribute writer method with validation
|
389
|
+
# @param [Object] custom_field9 Value to be assigned
|
390
|
+
def custom_field9=(custom_field9)
|
391
|
+
if !custom_field9.nil? && custom_field9.to_s.length > 200
|
392
|
+
fail ArgumentError, 'invalid value for "custom_field9", the character length must be smaller than or equal to 200.'
|
393
|
+
end
|
394
|
+
|
395
|
+
@custom_field9 = custom_field9
|
396
|
+
end
|
397
|
+
|
326
398
|
# Custom attribute writer method with validation
|
327
399
|
# @param [Object] return_url Value to be assigned
|
328
400
|
def return_url=(return_url)
|
@@ -350,12 +422,15 @@ module UltracartClient
|
|
350
422
|
self.class == o.class &&
|
351
423
|
comments == o.comments &&
|
352
424
|
custom_field1 == o.custom_field1 &&
|
425
|
+
custom_field10 == o.custom_field10 &&
|
353
426
|
custom_field2 == o.custom_field2 &&
|
354
427
|
custom_field3 == o.custom_field3 &&
|
355
428
|
custom_field4 == o.custom_field4 &&
|
356
429
|
custom_field5 == o.custom_field5 &&
|
357
430
|
custom_field6 == o.custom_field6 &&
|
358
431
|
custom_field7 == o.custom_field7 &&
|
432
|
+
custom_field8 == o.custom_field8 &&
|
433
|
+
custom_field9 == o.custom_field9 &&
|
359
434
|
ip_address == o.ip_address &&
|
360
435
|
return_code == o.return_code &&
|
361
436
|
return_url == o.return_url &&
|
@@ -373,7 +448,7 @@ module UltracartClient
|
|
373
448
|
# Calculates hash code according to all attributes.
|
374
449
|
# @return [Integer] Hash code
|
375
450
|
def hash
|
376
|
-
[comments, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, ip_address, return_code, return_url, screen_branding_theme_code, storefront_host_name, user_agent].hash
|
451
|
+
[comments, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, ip_address, return_code, return_url, screen_branding_theme_code, storefront_host_name, user_agent].hash
|
377
452
|
end
|
378
453
|
|
379
454
|
# Builds the object from hash
|
@@ -99,6 +99,9 @@ module UltracartClient
|
|
99
99
|
|
100
100
|
attr_accessor :taxes
|
101
101
|
|
102
|
+
# UTM clicks. The zero index is the most recent (last) UTM click
|
103
|
+
attr_accessor :utms
|
104
|
+
|
102
105
|
class EnumAttributeValidator
|
103
106
|
attr_reader :datatype
|
104
107
|
attr_reader :allowable_values
|
@@ -158,7 +161,8 @@ module UltracartClient
|
|
158
161
|
:'shipping' => :'shipping',
|
159
162
|
:'summary' => :'summary',
|
160
163
|
:'tags' => :'Tags',
|
161
|
-
:'taxes' => :'taxes'
|
164
|
+
:'taxes' => :'taxes',
|
165
|
+
:'utms' => :'utms'
|
162
166
|
}
|
163
167
|
end
|
164
168
|
|
@@ -204,7 +208,8 @@ module UltracartClient
|
|
204
208
|
:'shipping' => :'OrderShipping',
|
205
209
|
:'summary' => :'OrderSummary',
|
206
210
|
:'tags' => :'Array<OrderTag>',
|
207
|
-
:'taxes' => :'OrderTaxes'
|
211
|
+
:'taxes' => :'OrderTaxes',
|
212
|
+
:'utms' => :'Array<OrderUtm>'
|
208
213
|
}
|
209
214
|
end
|
210
215
|
|
@@ -378,6 +383,12 @@ module UltracartClient
|
|
378
383
|
if attributes.key?(:'taxes')
|
379
384
|
self.taxes = attributes[:'taxes']
|
380
385
|
end
|
386
|
+
|
387
|
+
if attributes.key?(:'utms')
|
388
|
+
if (value = attributes[:'utms']).is_a?(Array)
|
389
|
+
self.utms = value
|
390
|
+
end
|
391
|
+
end
|
381
392
|
end
|
382
393
|
|
383
394
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -474,7 +485,8 @@ module UltracartClient
|
|
474
485
|
shipping == o.shipping &&
|
475
486
|
summary == o.summary &&
|
476
487
|
tags == o.tags &&
|
477
|
-
taxes == o.taxes
|
488
|
+
taxes == o.taxes &&
|
489
|
+
utms == o.utms
|
478
490
|
end
|
479
491
|
|
480
492
|
# @see the `==` method
|
@@ -486,7 +498,7 @@ module UltracartClient
|
|
486
498
|
# Calculates hash code according to all attributes.
|
487
499
|
# @return [Integer] Hash code
|
488
500
|
def hash
|
489
|
-
[affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes].hash
|
501
|
+
[affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes, utms].hash
|
490
502
|
end
|
491
503
|
|
492
504
|
# Builds the object from hash
|