ultracart_api 3.10.116 → 3.10.117

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5ebf4f4fd93d5468dbb299785fb634c32923a05327d30d25c34b89bda2804a9
-  data.tar.gz: 358578a0230e7fb2a52209a6b4dc84a533d5ffa326fbf52e4de41d387cd6f88a
+  metadata.gz: 71b0716875e7af220fb4cc7c7947a56bb79b94ca73912d5cb4e54db849dc1e2e
+  data.tar.gz: 94b60f5189f9cbe2732a1dbf3c2898166f65ba6c1d2b3635fc5d639f426ccc5a
 SHA512:
-  metadata.gz: 96d601a5618719b3de8d9e17dc27c53f8d53e00af414533374b9bfbc0dc4b6caccd6bfd77c1f82e2a926136b425e11beaeee995c5b87d931711ac58ab0d9c6dc
-  data.tar.gz: 62dfa3145b1abc79ca82053f0f8b53ef996ab25907584a8639e0fe9cd5b28937a9a288434ff3b0cd72e45d0e2d8f999496e3b468fcdb651ec837afd41d3906fc
+  metadata.gz: 3e7d176a0218045ae99510053bc81dc45ae0e33d8e95eaa24a10e2b802fbd1a245527ba5d62b02a05c92df0fd08cdfccda6e07b2ccd9dfbef9546e0f16a94e82
+  data.tar.gz: eab6d75bf58443eeface15ef99037e5728a0cb6483363b43a63dbc08054369140db677085a5870f213939a05129a19cb9719dc444afc0ab14e90421b5ca7b264

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.116
+- Package version: 3.10.117
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.116.gem
+gem install ./ultracart_api-3.10.117.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.116.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.117.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', '~> 3.10.116'
+    gem 'ultracart_api', '~> 3.10.117'
 
 ### Install from Git
 
@@ -1099,6 +1099,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)
@@ -1300,6 +1301,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 3.10.115 | 02/07/2023 | convo - new event for when a customer joins a queue |
 | 3.10.114 | 02/07/2023 | convo - new event for when a customer joins a queue |

data/docs/CartCheckout.md

@@ -5,12 +5,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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] 

data/docs/Order.md

@@ -38,5 +38,6 @@ Name | Type | Description | Notes
 **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] 
 
 

data/docs/OrderCheckout.md

@@ -6,12 +6,15 @@ Name | Type | Description | Notes
 **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] 

data/docs/OrderUtm.md

@@ -0,0 +1,31 @@
+# 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] 
+
+

data/docs/PricingTier.md

@@ -30,6 +30,7 @@ Name | Type | Description | Notes
 **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] 

data/lib/ultracart_api/models/cart_checkout.rb

@@ -20,6 +20,9 @@ module UltracartClient
     # Custom field 1
     attr_accessor :custom_field1
 
+    # Custom field 10
+    attr_accessor :custom_field10
+
     # Custom field 2
     attr_accessor :custom_field2
 
@@ -38,6 +41,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
 
@@ -61,12 +70,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',
@@ -81,12 +93,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',
@@ -112,6 +127,10 @@ module UltracartClient
         self.custom_field1 = attributes[:'custom_field1']
       end
 
+      if attributes.has_key?(:'custom_field10')
+        self.custom_field10 = attributes[:'custom_field10']
+      end
+
       if attributes.has_key?(:'custom_field2')
         self.custom_field2 = attributes[:'custom_field2']
       end
@@ -136,6 +155,14 @@ module UltracartClient
         self.custom_field7 = attributes[:'custom_field7']
       end
 
+      if attributes.has_key?(:'custom_field8')
+        self.custom_field8 = attributes[:'custom_field8']
+      end
+
+      if attributes.has_key?(:'custom_field9')
+        self.custom_field9 = attributes[:'custom_field9']
+      end
+
       if attributes.has_key?(:'ip_address')
         self.ip_address = attributes[:'ip_address']
       end
@@ -173,6 +200,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
@@ -197,6 +228,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
@@ -213,12 +252,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
@@ -244,6 +286,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)
@@ -304,6 +356,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)
@@ -331,12 +403,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 &&
@@ -354,7 +429,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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

@@ -98,6 +98,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
@@ -157,7 +160,8 @@ module UltracartClient
         :'shipping' => :'shipping',
         :'summary' => :'summary',
         :'tags' => :'Tags',
-        :'taxes' => :'taxes'
+        :'taxes' => :'taxes',
+        :'utms' => :'utms'
       }
     end
 
@@ -198,7 +202,8 @@ module UltracartClient
         :'shipping' => :'OrderShipping',
         :'summary' => :'OrderSummary',
         :'tags' => :'Array<OrderTag>',
-        :'taxes' => :'OrderTaxes'
+        :'taxes' => :'OrderTaxes',
+        :'utms' => :'Array<OrderUtm>'
       }
     end
 
@@ -359,6 +364,12 @@ module UltracartClient
       if attributes.has_key?(:'taxes')
         self.taxes = attributes[:'taxes']
       end
+
+      if attributes.has_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?
@@ -455,7 +466,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
@@ -467,7 +479,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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

data/lib/ultracart_api/models/order_checkout.rb

@@ -22,6 +22,9 @@ module UltracartClient
     # Custom field 1
     attr_accessor :custom_field1
 
+    # Custom field 10
+    attr_accessor :custom_field10
+
     # Custom field 2
     attr_accessor :custom_field2
 
@@ -40,6 +43,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 of the customer when placing the order
     attr_accessor :customer_ip_address
 
@@ -61,12 +70,15 @@ module UltracartClient
         :'browser' => :'browser',
         :'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',
         :'customer_ip_address' => :'customer_ip_address',
         :'screen_branding_theme_code' => :'screen_branding_theme_code',
         :'screen_size' => :'screen_size',
@@ -81,12 +93,15 @@ module UltracartClient
         :'browser' => :'Browser',
         :'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',
         :'customer_ip_address' => :'String',
         :'screen_branding_theme_code' => :'String',
         :'screen_size' => :'String',
@@ -115,6 +130,10 @@ module UltracartClient
         self.custom_field1 = attributes[:'custom_field1']
       end
 
+      if attributes.has_key?(:'custom_field10')
+        self.custom_field10 = attributes[:'custom_field10']
+      end
+
       if attributes.has_key?(:'custom_field2')
         self.custom_field2 = attributes[:'custom_field2']
       end
@@ -139,6 +158,14 @@ module UltracartClient
         self.custom_field7 = attributes[:'custom_field7']
       end
 
+      if attributes.has_key?(:'custom_field8')
+        self.custom_field8 = attributes[:'custom_field8']
+      end
+
+      if attributes.has_key?(:'custom_field9')
+        self.custom_field9 = attributes[:'custom_field9']
+      end
+
       if attributes.has_key?(:'customer_ip_address')
         self.customer_ip_address = attributes[:'customer_ip_address']
       end
@@ -168,6 +195,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
@@ -192,6 +223,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 !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
         invalid_properties.push('invalid value for "screen_branding_theme_code", the character length must be smaller than or equal to 10.')
       end
@@ -203,12 +242,15 @@ module UltracartClient
     # @return true if the model is valid
     def valid?
       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 !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       true
     end
@@ -223,6 +265,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)
@@ -283,6 +335,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] screen_branding_theme_code Value to be assigned
     def screen_branding_theme_code=(screen_branding_theme_code)
@@ -301,12 +373,15 @@ module UltracartClient
           browser == o.browser &&
           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 &&
           customer_ip_address == o.customer_ip_address &&
           screen_branding_theme_code == o.screen_branding_theme_code &&
           screen_size == o.screen_size &&
@@ -323,7 +398,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [browser, comments, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, customer_ip_address, screen_branding_theme_code, screen_size, storefront_host_name, upsell_path_code].hash
+      [browser, comments, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, customer_ip_address, screen_branding_theme_code, screen_size, storefront_host_name, upsell_path_code].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_utm.rb

@@ -0,0 +1,392 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class OrderUtm
+    attr_accessor :attribution_first_click_subtotal
+
+    attr_accessor :attribution_first_click_total
+
+    attr_accessor :attribution_last_click_subtotal
+
+    attr_accessor :attribution_last_click_total
+
+    attr_accessor :attribution_linear_subtotal
+
+    attr_accessor :attribution_linear_total
+
+    attr_accessor :attribution_position_based_subtotal
+
+    attr_accessor :attribution_position_based_total
+
+    # Date/time that the click happened
+    attr_accessor :click_dts
+
+    attr_accessor :facebook_ad_id
+
+    attr_accessor :fbclid
+
+    attr_accessor :gbraid
+
+    attr_accessor :glcid
+
+    attr_accessor :msclkid
+
+    attr_accessor :ttclid
+
+    attr_accessor :uc_message_id
+
+    attr_accessor :utm_campaign
+
+    attr_accessor :utm_content
+
+    attr_accessor :utm_id
+
+    attr_accessor :utm_medium
+
+    attr_accessor :utm_source
+
+    attr_accessor :utm_term
+
+    attr_accessor :vmcid
+
+    attr_accessor :wbraid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attribution_first_click_subtotal' => :'attribution_first_click_subtotal',
+        :'attribution_first_click_total' => :'attribution_first_click_total',
+        :'attribution_last_click_subtotal' => :'attribution_last_click_subtotal',
+        :'attribution_last_click_total' => :'attribution_last_click_total',
+        :'attribution_linear_subtotal' => :'attribution_linear_subtotal',
+        :'attribution_linear_total' => :'attribution_linear_total',
+        :'attribution_position_based_subtotal' => :'attribution_position_based_subtotal',
+        :'attribution_position_based_total' => :'attribution_position_based_total',
+        :'click_dts' => :'click_dts',
+        :'facebook_ad_id' => :'facebook_ad_id',
+        :'fbclid' => :'fbclid',
+        :'gbraid' => :'gbraid',
+        :'glcid' => :'glcid',
+        :'msclkid' => :'msclkid',
+        :'ttclid' => :'ttclid',
+        :'uc_message_id' => :'uc_message_id',
+        :'utm_campaign' => :'utm_campaign',
+        :'utm_content' => :'utm_content',
+        :'utm_id' => :'utm_id',
+        :'utm_medium' => :'utm_medium',
+        :'utm_source' => :'utm_source',
+        :'utm_term' => :'utm_term',
+        :'vmcid' => :'vmcid',
+        :'wbraid' => :'wbraid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'attribution_first_click_subtotal' => :'Float',
+        :'attribution_first_click_total' => :'Float',
+        :'attribution_last_click_subtotal' => :'Float',
+        :'attribution_last_click_total' => :'Float',
+        :'attribution_linear_subtotal' => :'Float',
+        :'attribution_linear_total' => :'Float',
+        :'attribution_position_based_subtotal' => :'Float',
+        :'attribution_position_based_total' => :'Float',
+        :'click_dts' => :'String',
+        :'facebook_ad_id' => :'String',
+        :'fbclid' => :'String',
+        :'gbraid' => :'String',
+        :'glcid' => :'String',
+        :'msclkid' => :'String',
+        :'ttclid' => :'String',
+        :'uc_message_id' => :'String',
+        :'utm_campaign' => :'String',
+        :'utm_content' => :'String',
+        :'utm_id' => :'String',
+        :'utm_medium' => :'String',
+        :'utm_source' => :'String',
+        :'utm_term' => :'String',
+        :'vmcid' => :'String',
+        :'wbraid' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'attribution_first_click_subtotal')
+        self.attribution_first_click_subtotal = attributes[:'attribution_first_click_subtotal']
+      end
+
+      if attributes.has_key?(:'attribution_first_click_total')
+        self.attribution_first_click_total = attributes[:'attribution_first_click_total']
+      end
+
+      if attributes.has_key?(:'attribution_last_click_subtotal')
+        self.attribution_last_click_subtotal = attributes[:'attribution_last_click_subtotal']
+      end
+
+      if attributes.has_key?(:'attribution_last_click_total')
+        self.attribution_last_click_total = attributes[:'attribution_last_click_total']
+      end
+
+      if attributes.has_key?(:'attribution_linear_subtotal')
+        self.attribution_linear_subtotal = attributes[:'attribution_linear_subtotal']
+      end
+
+      if attributes.has_key?(:'attribution_linear_total')
+        self.attribution_linear_total = attributes[:'attribution_linear_total']
+      end
+
+      if attributes.has_key?(:'attribution_position_based_subtotal')
+        self.attribution_position_based_subtotal = attributes[:'attribution_position_based_subtotal']
+      end
+
+      if attributes.has_key?(:'attribution_position_based_total')
+        self.attribution_position_based_total = attributes[:'attribution_position_based_total']
+      end
+
+      if attributes.has_key?(:'click_dts')
+        self.click_dts = attributes[:'click_dts']
+      end
+
+      if attributes.has_key?(:'facebook_ad_id')
+        self.facebook_ad_id = attributes[:'facebook_ad_id']
+      end
+
+      if attributes.has_key?(:'fbclid')
+        self.fbclid = attributes[:'fbclid']
+      end
+
+      if attributes.has_key?(:'gbraid')
+        self.gbraid = attributes[:'gbraid']
+      end
+
+      if attributes.has_key?(:'glcid')
+        self.glcid = attributes[:'glcid']
+      end
+
+      if attributes.has_key?(:'msclkid')
+        self.msclkid = attributes[:'msclkid']
+      end
+
+      if attributes.has_key?(:'ttclid')
+        self.ttclid = attributes[:'ttclid']
+      end
+
+      if attributes.has_key?(:'uc_message_id')
+        self.uc_message_id = attributes[:'uc_message_id']
+      end
+
+      if attributes.has_key?(:'utm_campaign')
+        self.utm_campaign = attributes[:'utm_campaign']
+      end
+
+      if attributes.has_key?(:'utm_content')
+        self.utm_content = attributes[:'utm_content']
+      end
+
+      if attributes.has_key?(:'utm_id')
+        self.utm_id = attributes[:'utm_id']
+      end
+
+      if attributes.has_key?(:'utm_medium')
+        self.utm_medium = attributes[:'utm_medium']
+      end
+
+      if attributes.has_key?(:'utm_source')
+        self.utm_source = attributes[:'utm_source']
+      end
+
+      if attributes.has_key?(:'utm_term')
+        self.utm_term = attributes[:'utm_term']
+      end
+
+      if attributes.has_key?(:'vmcid')
+        self.vmcid = attributes[:'vmcid']
+      end
+
+      if attributes.has_key?(:'wbraid')
+        self.wbraid = attributes[:'wbraid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          attribution_first_click_subtotal == o.attribution_first_click_subtotal &&
+          attribution_first_click_total == o.attribution_first_click_total &&
+          attribution_last_click_subtotal == o.attribution_last_click_subtotal &&
+          attribution_last_click_total == o.attribution_last_click_total &&
+          attribution_linear_subtotal == o.attribution_linear_subtotal &&
+          attribution_linear_total == o.attribution_linear_total &&
+          attribution_position_based_subtotal == o.attribution_position_based_subtotal &&
+          attribution_position_based_total == o.attribution_position_based_total &&
+          click_dts == o.click_dts &&
+          facebook_ad_id == o.facebook_ad_id &&
+          fbclid == o.fbclid &&
+          gbraid == o.gbraid &&
+          glcid == o.glcid &&
+          msclkid == o.msclkid &&
+          ttclid == o.ttclid &&
+          uc_message_id == o.uc_message_id &&
+          utm_campaign == o.utm_campaign &&
+          utm_content == o.utm_content &&
+          utm_id == o.utm_id &&
+          utm_medium == o.utm_medium &&
+          utm_source == o.utm_source &&
+          utm_term == o.utm_term &&
+          vmcid == o.vmcid &&
+          wbraid == o.wbraid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [attribution_first_click_subtotal, attribution_first_click_total, attribution_last_click_subtotal, attribution_last_click_total, attribution_linear_subtotal, attribution_linear_total, attribution_position_based_subtotal, attribution_position_based_total, click_dts, facebook_ad_id, fbclid, gbraid, glcid, msclkid, ttclid, uc_message_id, utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_term, vmcid, wbraid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/pricing_tier.rb

@@ -94,6 +94,9 @@ module UltracartClient
     # Realtime percentage discount
     attr_accessor :realtime_percentage_discount
 
+    # Restrict inventory to this distribution center oid
+    attr_accessor :restrict_to_distribution_center_oid
+
     attr_accessor :signup_notification
 
     # Suppress buySAFE (deprecated)
@@ -138,6 +141,7 @@ module UltracartClient
         :'not_valid_when_coupon_present' => :'not_valid_when_coupon_present',
         :'pricing_tier_oid' => :'pricing_tier_oid',
         :'realtime_percentage_discount' => :'realtime_percentage_discount',
+        :'restrict_to_distribution_center_oid' => :'restrict_to_distribution_center_oid',
         :'signup_notification' => :'signup_notification',
         :'suppress_buysafe' => :'suppress_buysafe',
         :'suppress_mailing_list' => :'suppress_mailing_list',
@@ -176,6 +180,7 @@ module UltracartClient
         :'not_valid_when_coupon_present' => :'BOOLEAN',
         :'pricing_tier_oid' => :'Integer',
         :'realtime_percentage_discount' => :'Float',
+        :'restrict_to_distribution_center_oid' => :'Integer',
         :'signup_notification' => :'PricingTierNotification',
         :'suppress_buysafe' => :'BOOLEAN',
         :'suppress_mailing_list' => :'BOOLEAN',
@@ -300,6 +305,10 @@ module UltracartClient
         self.realtime_percentage_discount = attributes[:'realtime_percentage_discount']
       end
 
+      if attributes.has_key?(:'restrict_to_distribution_center_oid')
+        self.restrict_to_distribution_center_oid = attributes[:'restrict_to_distribution_center_oid']
+      end
+
       if attributes.has_key?(:'signup_notification')
         self.signup_notification = attributes[:'signup_notification']
       end
@@ -381,6 +390,7 @@ module UltracartClient
           not_valid_when_coupon_present == o.not_valid_when_coupon_present &&
           pricing_tier_oid == o.pricing_tier_oid &&
           realtime_percentage_discount == o.realtime_percentage_discount &&
+          restrict_to_distribution_center_oid == o.restrict_to_distribution_center_oid &&
           signup_notification == o.signup_notification &&
           suppress_buysafe == o.suppress_buysafe &&
           suppress_mailing_list == o.suppress_mailing_list &&
@@ -397,7 +407,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allow_3rd_party_billing, allow_cod, allow_purchase_order, allow_quote_request, approval_notification, auto_approve_cod, auto_approve_purchase_order, default_on_wholesale_signup, default_percentage_discount, default_shipping_method_oid, default_tier, display_on_wholesale_signup, exclude_from_free_promotion, exempt_loyalty_rewards, exempt_shipping_handling_charge, free_shipping, free_shipping_minimum, maximum_item_count, minimum_item_count, minimum_subtotal, name, no_coupons, no_free_shipping, no_realtime_charge, not_valid_when_coupon_present, pricing_tier_oid, realtime_percentage_discount, signup_notification, suppress_buysafe, suppress_mailing_list, tax_exempt, track_separately].hash
+      [allow_3rd_party_billing, allow_cod, allow_purchase_order, allow_quote_request, approval_notification, auto_approve_cod, auto_approve_purchase_order, default_on_wholesale_signup, default_percentage_discount, default_shipping_method_oid, default_tier, display_on_wholesale_signup, exclude_from_free_promotion, exempt_loyalty_rewards, exempt_shipping_handling_charge, free_shipping, free_shipping_minimum, maximum_item_count, minimum_item_count, minimum_subtotal, name, no_coupons, no_free_shipping, no_realtime_charge, not_valid_when_coupon_present, pricing_tier_oid, realtime_percentage_discount, restrict_to_distribution_center_oid, signup_notification, suppress_buysafe, suppress_mailing_list, tax_exempt, track_separately].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.116'
+  VERSION = '3.10.117'
 end

data/lib/ultracart_api.rb

@@ -624,6 +624,7 @@ require 'ultracart_api/models/order_token_response'
 require 'ultracart_api/models/order_tracking_number_detail'
 require 'ultracart_api/models/order_tracking_number_details'
 require 'ultracart_api/models/order_transactional_merchant_note'
+require 'ultracart_api/models/order_utm'
 require 'ultracart_api/models/orders_response'
 require 'ultracart_api/models/permission'
 require 'ultracart_api/models/point_of_sale_location'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.116
+  version: 3.10.117
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -842,6 +842,7 @@ files:
 - docs/OrderTrackingNumberDetail.md
 - docs/OrderTrackingNumberDetails.md
 - docs/OrderTransactionalMerchantNote.md
+- docs/OrderUtm.md
 - docs/OrdersResponse.md
 - docs/Permission.md
 - docs/PointOfSaleLocation.md
@@ -1609,6 +1610,7 @@ files:
 - lib/ultracart_api/models/order_tracking_number_detail.rb
 - lib/ultracart_api/models/order_tracking_number_details.rb
 - lib/ultracart_api/models/order_transactional_merchant_note.rb
+- lib/ultracart_api/models/order_utm.rb
 - lib/ultracart_api/models/orders_response.rb
 - lib/ultracart_api/models/permission.rb
 - lib/ultracart_api/models/point_of_sale_location.rb