ultracart_api 4.0.133 → 4.0.135

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7ce5db99a20be9f1c59921bdb909e2741046e8ab925256044a100abfdc7d0e5
-  data.tar.gz: f5524f8b7b56b4082335ea8b6a7b0786254eb7e460defc7438aea9f12aa10b1d
+  metadata.gz: 957070c75bab53ffcaec29cf1bea74ca2cfaa1b3e945d766662faa31d89155a9
+  data.tar.gz: f8c2d6d4d3ab71f1910c8b97c172b0407c305501e9ce1336924a4b4da60efafd
 SHA512:
-  metadata.gz: 62f6a8d8e5924d3ecc570b176e4190b0f9cb0c762c2ba874860f4a1cac0cae228a35090a4381a6aa4dc1881edd937b1c3fba6b89d931b30da00c3e1c2c5e1b2b
-  data.tar.gz: 2b527c19a338b82012e95c1f913c07af4fa7bb755a88eaa99a1d55e792eb0cc4d768025537ddf259d5b6fe164577f4ce90e255477eef62a91c58f875770a92d1
+  metadata.gz: 93eddbcce4641a622f687671fc6e290ba01681219421cd62df36fd77b5ffaabe3105123dedfa2c3418e4925116f825b06c3e179426b5a8086892258a251b31e8
+  data.tar.gz: 5eadc726d7dc3e19090cc04a73404aa256efa7eacbcc13cd7125e17cab61f42ed8db2d2269cf9ba3eeee894e9eaebd61ba5b40283cfdee162ccb9871adf56e90

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.133
+- Package version: 4.0.135
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.133.gem
+gem install ./ultracart_api-4.0.135.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.133.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.135.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.133'
+    gem 'ultracart_api', '~> 4.0.135'
 
 ### Install from Git
 
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *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
+*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
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 *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
  - [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
  - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
+ - [UltracartClient::OrderUtm](docs/OrderUtm.md)
  - [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
  - [UltracartClient::Permission](docs/Permission.md)
  - [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
@@ -1308,6 +1310,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
+| 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |
 | 4.0.131 | 02/07/2023 | convo - new event for when a customer joins a queue |

data/docs/CartCheckout.md

@@ -6,12 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **comments** | **String** | Comments from the customer.  Rarely used on the single page checkout. | [optional] |
 | **custom_field1** | **String** | Custom field 1 | [optional] |
+| **custom_field10** | **String** | Custom field 10 | [optional] |
 | **custom_field2** | **String** | Custom field 2 | [optional] |
 | **custom_field3** | **String** | Custom field 3 | [optional] |
 | **custom_field4** | **String** | Custom field 4 | [optional] |
 | **custom_field5** | **String** | Custom field 5 | [optional] |
 | **custom_field6** | **String** | Custom field 6 | [optional] |
 | **custom_field7** | **String** | Custom field 7 | [optional] |
+| **custom_field8** | **String** | Custom field 8 | [optional] |
+| **custom_field9** | **String** | Custom field 9 | [optional] |
 | **ip_address** | **String** | IP Address (read only unless non-browser key authenticated) | [optional] |
 | **return_code** | **String** | Return code assigned for send return email operation | [optional] |
 | **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'
 instance = UltracartClient::CartCheckout.new(
   comments: null,
   custom_field1: null,
+  custom_field10: null,
   custom_field2: null,
   custom_field3: null,
   custom_field4: null,
   custom_field5: null,
   custom_field6: null,
   custom_field7: null,
+  custom_field8: null,
+  custom_field9: null,
   ip_address: null,
   return_code: null,
   return_url: null,

data/docs/ConversationApi.md

@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
 | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
 | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
+| [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
 | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
 | [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile |
 | [**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
 - **Accept**: application/json
 
 
+## sms_unsubscribe_conversation
+
+> sms_unsubscribe_conversation(conversation_uuid)
+
+Unsubscribe any SMS participants in this conversation
+
+Unsubscribe any SMS participants in this conversation 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+begin
+  # Unsubscribe any SMS participants in this conversation
+  api_instance.sms_unsubscribe_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
+end
+```
+
+#### Using the sms_unsubscribe_conversation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> sms_unsubscribe_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Unsubscribe any SMS participants in this conversation
+  data, status_code, headers = api_instance.sms_unsubscribe_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->sms_unsubscribe_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## start_conversation
 
 > <ConversationStartResponse> start_conversation(start_request)

data/docs/Order.md

@@ -39,6 +39,7 @@
 | **summary** | [**OrderSummary**](OrderSummary.md) |  | [optional] |
 | **tags** | [**Array<OrderTag>**](OrderTag.md) | tags, available only through update, not through insert due to the nature of how tags are handled internally | [optional] |
 | **taxes** | [**OrderTaxes**](OrderTaxes.md) |  | [optional] |
+| **utms** | [**Array<OrderUtm>**](OrderUtm.md) | UTM clicks.  The zero index is the most recent (last) UTM click | [optional] |
 
 ## Example
 
@@ -80,7 +81,8 @@ instance = UltracartClient::Order.new(
   shipping: null,
   summary: null,
   tags: null,
-  taxes: null
+  taxes: null,
+  utms: null
 )
 ```
 

data/docs/OrderCheckout.md

@@ -7,12 +7,15 @@
 | **browser** | [**Browser**](Browser.md) |  | [optional] |
 | **comments** | **String** | Comments from the customer.  Rarely used on the single page checkout. | [optional] |
 | **custom_field1** | **String** | Custom field 1 | [optional] |
+| **custom_field10** | **String** | Custom field 10 | [optional] |
 | **custom_field2** | **String** | Custom field 2 | [optional] |
 | **custom_field3** | **String** | Custom field 3 | [optional] |
 | **custom_field4** | **String** | Custom field 4 | [optional] |
 | **custom_field5** | **String** | Custom field 5 | [optional] |
 | **custom_field6** | **String** | Custom field 6 | [optional] |
 | **custom_field7** | **String** | Custom field 7 | [optional] |
+| **custom_field8** | **String** | Custom field 8 | [optional] |
+| **custom_field9** | **String** | Custom field 9 | [optional] |
 | **customer_ip_address** | **String** | IP address of the customer when placing the order | [optional] |
 | **screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional] |
 | **screen_size** | **String** | Screen size small, medium or large | [optional] |
@@ -28,12 +31,15 @@ instance = UltracartClient::OrderCheckout.new(
   browser: null,
   comments: null,
   custom_field1: null,
+  custom_field10: null,
   custom_field2: null,
   custom_field3: null,
   custom_field4: null,
   custom_field5: null,
   custom_field6: null,
   custom_field7: null,
+  custom_field8: null,
+  custom_field9: null,
   customer_ip_address: null,
   screen_branding_theme_code: null,
   screen_size: null,

data/docs/OrderUtm.md

@@ -0,0 +1,64 @@
+# UltracartClient::OrderUtm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attribution_first_click_subtotal** | **Float** |  | [optional] |
+| **attribution_first_click_total** | **Float** |  | [optional] |
+| **attribution_last_click_subtotal** | **Float** |  | [optional] |
+| **attribution_last_click_total** | **Float** |  | [optional] |
+| **attribution_linear_subtotal** | **Float** |  | [optional] |
+| **attribution_linear_total** | **Float** |  | [optional] |
+| **attribution_position_based_subtotal** | **Float** |  | [optional] |
+| **attribution_position_based_total** | **Float** |  | [optional] |
+| **click_dts** | **String** | Date/time that the click happened | [optional] |
+| **facebook_ad_id** | **String** |  | [optional] |
+| **fbclid** | **String** |  | [optional] |
+| **gbraid** | **String** |  | [optional] |
+| **glcid** | **String** |  | [optional] |
+| **msclkid** | **String** |  | [optional] |
+| **ttclid** | **String** |  | [optional] |
+| **uc_message_id** | **String** |  | [optional] |
+| **utm_campaign** | **String** |  | [optional] |
+| **utm_content** | **String** |  | [optional] |
+| **utm_id** | **String** |  | [optional] |
+| **utm_medium** | **String** |  | [optional] |
+| **utm_source** | **String** |  | [optional] |
+| **utm_term** | **String** |  | [optional] |
+| **vmcid** | **String** |  | [optional] |
+| **wbraid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderUtm.new(
+  attribution_first_click_subtotal: null,
+  attribution_first_click_total: null,
+  attribution_last_click_subtotal: null,
+  attribution_last_click_total: null,
+  attribution_linear_subtotal: null,
+  attribution_linear_total: null,
+  attribution_position_based_subtotal: null,
+  attribution_position_based_total: null,
+  click_dts: null,
+  facebook_ad_id: null,
+  fbclid: null,
+  gbraid: null,
+  glcid: null,
+  msclkid: null,
+  ttclid: null,
+  uc_message_id: null,
+  utm_campaign: null,
+  utm_content: null,
+  utm_id: null,
+  utm_medium: null,
+  utm_source: null,
+  utm_term: null,
+  vmcid: null,
+  wbraid: null
+)
+```
+

data/docs/PricingTier.md

@@ -31,6 +31,7 @@
 | **not_valid_when_coupon_present** | **Boolean** | Not valid when coupon present | [optional] |
 | **pricing_tier_oid** | **Integer** | Pricing Tier Oid | [optional] |
 | **realtime_percentage_discount** | **Float** | Realtime percentage discount | [optional] |
+| **restrict_to_distribution_center_oid** | **Integer** | Restrict inventory to this distribution center oid | [optional] |
 | **signup_notification** | [**PricingTierNotification**](PricingTierNotification.md) |  | [optional] |
 | **suppress_buysafe** | **Boolean** | Suppress buySAFE (deprecated) | [optional] |
 | **suppress_mailing_list** | **Boolean** | Suppress mailing list | [optional] |
@@ -70,6 +71,7 @@ instance = UltracartClient::PricingTier.new(
   not_valid_when_coupon_present: null,
   pricing_tier_oid: null,
   realtime_percentage_discount: null,
+  restrict_to_distribution_center_oid: null,
   signup_notification: null,
   suppress_buysafe: null,
   suppress_mailing_list: null,

data/lib/ultracart_api/api/conversation_api.rb

@@ -1819,6 +1819,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Unsubscribe any SMS participants in this conversation
+    # Unsubscribe any SMS participants in this conversation 
+    # @param conversation_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def sms_unsubscribe_conversation(conversation_uuid, opts = {})
+      sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Unsubscribe any SMS participants in this conversation
+    # Unsubscribe any SMS participants in this conversation 
+    # @param conversation_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.sms_unsubscribe_conversation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Start a conversation
     # Start a new conversation 
     # @param start_request [ConversationStartRequest] Start request

data/lib/ultracart_api/models/cart_checkout.rb

@@ -21,6 +21,9 @@ module UltracartClient
     # Custom field 1
     attr_accessor :custom_field1
 
+    # Custom field 10
+    attr_accessor :custom_field10
+
     # Custom field 2
     attr_accessor :custom_field2
 
@@ -39,6 +42,12 @@ module UltracartClient
     # Custom field 7
     attr_accessor :custom_field7
 
+    # Custom field 8
+    attr_accessor :custom_field8
+
+    # Custom field 9
+    attr_accessor :custom_field9
+
     # IP Address (read only unless non-browser key authenticated)
     attr_accessor :ip_address
 
@@ -62,12 +71,15 @@ module UltracartClient
       {
         :'comments' => :'comments',
         :'custom_field1' => :'custom_field1',
+        :'custom_field10' => :'custom_field10',
         :'custom_field2' => :'custom_field2',
         :'custom_field3' => :'custom_field3',
         :'custom_field4' => :'custom_field4',
         :'custom_field5' => :'custom_field5',
         :'custom_field6' => :'custom_field6',
         :'custom_field7' => :'custom_field7',
+        :'custom_field8' => :'custom_field8',
+        :'custom_field9' => :'custom_field9',
         :'ip_address' => :'ip_address',
         :'return_code' => :'return_code',
         :'return_url' => :'return_url',
@@ -87,12 +99,15 @@ module UltracartClient
       {
         :'comments' => :'String',
         :'custom_field1' => :'String',
+        :'custom_field10' => :'String',
         :'custom_field2' => :'String',
         :'custom_field3' => :'String',
         :'custom_field4' => :'String',
         :'custom_field5' => :'String',
         :'custom_field6' => :'String',
         :'custom_field7' => :'String',
+        :'custom_field8' => :'String',
+        :'custom_field9' => :'String',
         :'ip_address' => :'String',
         :'return_code' => :'String',
         :'return_url' => :'String',
@@ -131,6 +146,10 @@ module UltracartClient
         self.custom_field1 = attributes[:'custom_field1']
       end
 
+      if attributes.key?(:'custom_field10')
+        self.custom_field10 = attributes[:'custom_field10']
+      end
+
       if attributes.key?(:'custom_field2')
         self.custom_field2 = attributes[:'custom_field2']
       end
@@ -155,6 +174,14 @@ module UltracartClient
         self.custom_field7 = attributes[:'custom_field7']
       end
 
+      if attributes.key?(:'custom_field8')
+        self.custom_field8 = attributes[:'custom_field8']
+      end
+
+      if attributes.key?(:'custom_field9')
+        self.custom_field9 = attributes[:'custom_field9']
+      end
+
       if attributes.key?(:'ip_address')
         self.ip_address = attributes[:'ip_address']
       end
@@ -192,6 +219,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "custom_field1", the character length must be smaller than or equal to 50.')
       end
 
+      if !@custom_field10.nil? && @custom_field10.to_s.length > 200
+        invalid_properties.push('invalid value for "custom_field10", the character length must be smaller than or equal to 200.')
+      end
+
       if !@custom_field2.nil? && @custom_field2.to_s.length > 50
         invalid_properties.push('invalid value for "custom_field2", the character length must be smaller than or equal to 50.')
       end
@@ -216,6 +247,14 @@ module UltracartClient
         invalid_properties.push('invalid value for "custom_field7", the character length must be smaller than or equal to 50.')
       end
 
+      if !@custom_field8.nil? && @custom_field8.to_s.length > 200
+        invalid_properties.push('invalid value for "custom_field8", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@custom_field9.nil? && @custom_field9.to_s.length > 200
+        invalid_properties.push('invalid value for "custom_field9", the character length must be smaller than or equal to 200.')
+      end
+
       if !@return_url.nil? && @return_url.to_s.length > 2048
         invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 2048.')
       end
@@ -232,12 +271,15 @@ module UltracartClient
     def valid?
       return false if !@comments.nil? && @comments.to_s.length > 2000
       return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
+      return false if !@custom_field10.nil? && @custom_field10.to_s.length > 200
       return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
       return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
       return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
       return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
       return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
       return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
+      return false if !@custom_field8.nil? && @custom_field8.to_s.length > 200
+      return false if !@custom_field9.nil? && @custom_field9.to_s.length > 200
       return false if !@return_url.nil? && @return_url.to_s.length > 2048
       return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       true
@@ -263,6 +305,16 @@ module UltracartClient
       @custom_field1 = custom_field1
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] custom_field10 Value to be assigned
+    def custom_field10=(custom_field10)
+      if !custom_field10.nil? && custom_field10.to_s.length > 200
+        fail ArgumentError, 'invalid value for "custom_field10", the character length must be smaller than or equal to 200.'
+      end
+
+      @custom_field10 = custom_field10
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] custom_field2 Value to be assigned
     def custom_field2=(custom_field2)
@@ -323,6 +375,26 @@ module UltracartClient
       @custom_field7 = custom_field7
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] custom_field8 Value to be assigned
+    def custom_field8=(custom_field8)
+      if !custom_field8.nil? && custom_field8.to_s.length > 200
+        fail ArgumentError, 'invalid value for "custom_field8", the character length must be smaller than or equal to 200.'
+      end
+
+      @custom_field8 = custom_field8
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] custom_field9 Value to be assigned
+    def custom_field9=(custom_field9)
+      if !custom_field9.nil? && custom_field9.to_s.length > 200
+        fail ArgumentError, 'invalid value for "custom_field9", the character length must be smaller than or equal to 200.'
+      end
+
+      @custom_field9 = custom_field9
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] return_url Value to be assigned
     def return_url=(return_url)
@@ -350,12 +422,15 @@ module UltracartClient
       self.class == o.class &&
           comments == o.comments &&
           custom_field1 == o.custom_field1 &&
+          custom_field10 == o.custom_field10 &&
           custom_field2 == o.custom_field2 &&
           custom_field3 == o.custom_field3 &&
           custom_field4 == o.custom_field4 &&
           custom_field5 == o.custom_field5 &&
           custom_field6 == o.custom_field6 &&
           custom_field7 == o.custom_field7 &&
+          custom_field8 == o.custom_field8 &&
+          custom_field9 == o.custom_field9 &&
           ip_address == o.ip_address &&
           return_code == o.return_code &&
           return_url == o.return_url &&
@@ -373,7 +448,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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
+      [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
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order.rb

@@ -99,6 +99,9 @@ module UltracartClient
 
     attr_accessor :taxes
 
+    # UTM clicks.  The zero index is the most recent (last) UTM click
+    attr_accessor :utms
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -158,7 +161,8 @@ module UltracartClient
         :'shipping' => :'shipping',
         :'summary' => :'summary',
         :'tags' => :'Tags',
-        :'taxes' => :'taxes'
+        :'taxes' => :'taxes',
+        :'utms' => :'utms'
       }
     end
 
@@ -204,7 +208,8 @@ module UltracartClient
         :'shipping' => :'OrderShipping',
         :'summary' => :'OrderSummary',
         :'tags' => :'Array<OrderTag>',
-        :'taxes' => :'OrderTaxes'
+        :'taxes' => :'OrderTaxes',
+        :'utms' => :'Array<OrderUtm>'
       }
     end
 
@@ -378,6 +383,12 @@ module UltracartClient
       if attributes.key?(:'taxes')
         self.taxes = attributes[:'taxes']
       end
+
+      if attributes.key?(:'utms')
+        if (value = attributes[:'utms']).is_a?(Array)
+          self.utms = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -474,7 +485,8 @@ module UltracartClient
           shipping == o.shipping &&
           summary == o.summary &&
           tags == o.tags &&
-          taxes == o.taxes
+          taxes == o.taxes &&
+          utms == o.utms
     end
 
     # @see the `==` method
@@ -486,7 +498,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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
+      [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
     end
 
     # Builds the object from hash