ultracart_api 4.0.172 → 4.0.173

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff43a4bf81d01c001c8d3d65e9f7e808cee00caaa627b360b92f5575201134d0
-  data.tar.gz: cb51249dced632b59a67dc66b35fe46ea1172a027094905ed94d94499e692411
+  metadata.gz: 6ea01f2a6d105ed8719395ff927d2abdf39bfbdd1c7413309309c8bbf4668656
+  data.tar.gz: 7446cf6cd1a39aed5ed33412f63bba5a3d5df66f51e2305d76655a02099435e3
 SHA512:
-  metadata.gz: ade3fbcaf6f52cfdb44e079ee18668ee9796dc8b07a689a02305869853bed0063f318da0ed2f36d12b0d0fe29e75e83429a64037cb9dc12cd67ecde08f93e153
-  data.tar.gz: 3c0fc32599ba2eaad8edc2c270d1681517002c15a73f1b6759856bf8206a31106be0ba681f4749191a33ad9f08986b50fa27b353b4c9f8117a5f9c5d28f1f84c
+  metadata.gz: 1ff89fec85ef3ffc6067f6660f5764bea6e0c427336ebe51021125ad8a2b4f0db4f9527f00cac812f755aeca18cc4b23b444639a3b64e9a9057dcc571a670662
+  data.tar.gz: 50036ca86514a8c7f1d8055c3b2c75306b4c82da140d049a72e0a770210e9e94d36715f35f28b507d322c63e17806a7b76a2aae3df4897fbc906398f07189b75

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.172
+- Package version: 4.0.173
 - 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.172.gem
+gem install ./ultracart_api-4.0.173.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.172.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.173.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.172'
+    gem 'ultracart_api', '~> 4.0.173'
 
 ### Install from Git
 
@@ -728,6 +728,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponExistsResponse](docs/CouponExistsResponse.md)
  - [UltracartClient::CouponFreeItemAndShippingWithSubtotal](docs/CouponFreeItemAndShippingWithSubtotal.md)
  - [UltracartClient::CouponFreeItemWithItemPurchase](docs/CouponFreeItemWithItemPurchase.md)
+ - [UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping](docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md)
  - [UltracartClient::CouponFreeItemWithSubtotal](docs/CouponFreeItemWithSubtotal.md)
  - [UltracartClient::CouponFreeItemsWithItemPurchase](docs/CouponFreeItemsWithItemPurchase.md)
  - [UltracartClient::CouponFreeItemsWithMixMatchPurchase](docs/CouponFreeItemsWithMixMatchPurchase.md)
@@ -791,6 +792,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
  - [UltracartClient::CustomerPrivacy](docs/CustomerPrivacy.md)
+ - [UltracartClient::CustomerProperty](docs/CustomerProperty.md)
  - [UltracartClient::CustomerQuery](docs/CustomerQuery.md)
  - [UltracartClient::CustomerQuotesSummary](docs/CustomerQuotesSummary.md)
  - [UltracartClient::CustomerResponse](docs/CustomerResponse.md)
@@ -1368,6 +1370,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.173 | 08/31/2023 | new coupon - free item and free shipping with purchase |
 | 4.0.172 | 08/16/2023 | added validate_original_order query param to auto order update method |
 | 4.0.171 | 08/14/2023 | esp - add require_order_within_last to the settings object |
 | 4.0.170 | 08/14/2023 | esp - expose rate limiter values in settings object |

data/docs/Coupon.md

@@ -28,6 +28,7 @@
 | **expiration_dts** | **String** | Date/time when coupon expires | [optional] |
 | **free_item_and_shipping_with_subtotal** | [**CouponFreeItemAndShippingWithSubtotal**](CouponFreeItemAndShippingWithSubtotal.md) |  | [optional] |
 | **free_item_with_item_purchase** | [**CouponFreeItemWithItemPurchase**](CouponFreeItemWithItemPurchase.md) |  | [optional] |
+| **free_item_with_item_purchase_and_free_shipping** | [**CouponFreeItemWithItemPurchaseAndFreeShipping**](CouponFreeItemWithItemPurchaseAndFreeShipping.md) |  | [optional] |
 | **free_item_with_subtotal** | [**CouponFreeItemWithSubtotal**](CouponFreeItemWithSubtotal.md) |  | [optional] |
 | **free_items_with_item_purchase** | [**CouponFreeItemsWithItemPurchase**](CouponFreeItemsWithItemPurchase.md) |  | [optional] |
 | **free_items_with_mixmatch_purchase** | [**CouponFreeItemsWithMixMatchPurchase**](CouponFreeItemsWithMixMatchPurchase.md) |  | [optional] |
@@ -101,6 +102,7 @@ instance = UltracartClient::Coupon.new(
   expiration_dts: null,
   free_item_and_shipping_with_subtotal: null,
   free_item_with_item_purchase: null,
+  free_item_with_item_purchase_and_free_shipping: null,
   free_item_with_subtotal: null,
   free_items_with_item_purchase: null,
   free_items_with_mixmatch_purchase: null,

data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md

@@ -0,0 +1,24 @@
+# UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | **Array<String>** | A list of free items which will receive a discount if one of the required purchase items is purchased. | [optional] |
+| **limit** | **Integer** | The (optional) maximum quantity of discounted items.  Free shipping will apply to all units of the free item ids though. | [optional] |
+| **match_required_purchase_item_to_free_item** | **Boolean** | If true then the free item is matched 1:1 with the free item in the list. | [optional] |
+| **required_purchase_items** | **Array<String>** | Required items (at least one from the list) that must be purchased for coupon to be valid | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping.new(
+  items: null,
+  limit: null,
+  match_required_purchase_item_to_free_item: null,
+  required_purchase_items: null
+)
+```
+

data/docs/Customer.md

@@ -44,6 +44,7 @@
 | **password** | **String** | Password (may only be set, never read) | [optional] |
 | **pricing_tiers** | [**Array<CustomerPricingTier>**](CustomerPricingTier.md) | Pricing tiers for this customer | [optional] |
 | **privacy** | [**CustomerPrivacy**](CustomerPrivacy.md) |  | [optional] |
+| **properties** | [**Array<CustomerProperty>**](CustomerProperty.md) | Properties for this customer | [optional] |
 | **qb_class** | **String** | QuickBooks class to import this customer as | [optional] |
 | **qb_code** | **String** | QuickBooks name to import this customer as | [optional] |
 | **qb_tax_exemption_reason_code** | **Integer** | QuickBooks tax exemption reason code | [optional] |
@@ -113,6 +114,7 @@ instance = UltracartClient::Customer.new(
   password: null,
   pricing_tiers: null,
   privacy: null,
+  properties: null,
   qb_class: null,
   qb_code: null,
   qb_tax_exemption_reason_code: null,

data/docs/CustomerProperty.md

@@ -0,0 +1,22 @@
+# UltracartClient::CustomerProperty
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expiration_dts** | **String** | The date/time that the property expires and is deleted | [optional] |
+| **name** | **String** | Name | [optional] |
+| **value** | **String** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomerProperty.new(
+  expiration_dts: null,
+  name: null,
+  value: null
+)
+```
+

data/lib/ultracart_api/models/coupon.rb

@@ -71,6 +71,8 @@ module UltracartClient
 
     attr_accessor :free_item_with_item_purchase
 
+    attr_accessor :free_item_with_item_purchase_and_free_shipping
+
     attr_accessor :free_item_with_subtotal
 
     attr_accessor :free_items_with_item_purchase
@@ -215,6 +217,7 @@ module UltracartClient
         :'expiration_dts' => :'expiration_dts',
         :'free_item_and_shipping_with_subtotal' => :'free_item_and_shipping_with_subtotal',
         :'free_item_with_item_purchase' => :'free_item_with_item_purchase',
+        :'free_item_with_item_purchase_and_free_shipping' => :'free_item_with_item_purchase_and_free_shipping',
         :'free_item_with_subtotal' => :'free_item_with_subtotal',
         :'free_items_with_item_purchase' => :'free_items_with_item_purchase',
         :'free_items_with_mixmatch_purchase' => :'free_items_with_mixmatch_purchase',
@@ -292,6 +295,7 @@ module UltracartClient
         :'expiration_dts' => :'String',
         :'free_item_and_shipping_with_subtotal' => :'CouponFreeItemAndShippingWithSubtotal',
         :'free_item_with_item_purchase' => :'CouponFreeItemWithItemPurchase',
+        :'free_item_with_item_purchase_and_free_shipping' => :'CouponFreeItemWithItemPurchaseAndFreeShipping',
         :'free_item_with_subtotal' => :'CouponFreeItemWithSubtotal',
         :'free_items_with_item_purchase' => :'CouponFreeItemsWithItemPurchase',
         :'free_items_with_mixmatch_purchase' => :'CouponFreeItemsWithMixMatchPurchase',
@@ -454,6 +458,10 @@ module UltracartClient
         self.free_item_with_item_purchase = attributes[:'free_item_with_item_purchase']
       end
 
+      if attributes.key?(:'free_item_with_item_purchase_and_free_shipping')
+        self.free_item_with_item_purchase_and_free_shipping = attributes[:'free_item_with_item_purchase_and_free_shipping']
+      end
+
       if attributes.key?(:'free_item_with_subtotal')
         self.free_item_with_subtotal = attributes[:'free_item_with_subtotal']
       end
@@ -763,6 +771,7 @@ module UltracartClient
           expiration_dts == o.expiration_dts &&
           free_item_and_shipping_with_subtotal == o.free_item_and_shipping_with_subtotal &&
           free_item_with_item_purchase == o.free_item_with_item_purchase &&
+          free_item_with_item_purchase_and_free_shipping == o.free_item_with_item_purchase_and_free_shipping &&
           free_item_with_subtotal == o.free_item_with_subtotal &&
           free_items_with_item_purchase == o.free_items_with_item_purchase &&
           free_items_with_mixmatch_purchase == o.free_items_with_mixmatch_purchase &&
@@ -816,7 +825,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, amount_shipping_with_subtotal, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, hide_from_customer, merchant_code, merchant_notes, more_loyalty_cashback, more_loyalty_points, multiple_amounts_off_items, no_discount, percent_more_loyalty_cashback, percent_more_loyalty_points, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, skip_on_rebill, start_dts, super_coupon, tiered_amount_off_items, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, tiered_percent_off_subtotal_based_on_msrp, usable_by].hash
+      [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, amount_shipping_with_subtotal, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_item_purchase_and_free_shipping, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, hide_from_customer, merchant_code, merchant_notes, more_loyalty_cashback, more_loyalty_points, multiple_amounts_off_items, no_discount, percent_more_loyalty_cashback, percent_more_loyalty_points, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, skip_on_rebill, start_dts, super_coupon, tiered_amount_off_items, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, tiered_percent_off_subtotal_based_on_msrp, usable_by].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb

@@ -0,0 +1,254 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class CouponFreeItemWithItemPurchaseAndFreeShipping
+    # A list of free items which will receive a discount if one of the required purchase items is purchased.
+    attr_accessor :items
+
+    # The (optional) maximum quantity of discounted items.  Free shipping will apply to all units of the free item ids though.
+    attr_accessor :limit
+
+    # If true then the free item is matched 1:1 with the free item in the list.
+    attr_accessor :match_required_purchase_item_to_free_item
+
+    # Required items (at least one from the list) that must be purchased for coupon to be valid
+    attr_accessor :required_purchase_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'items' => :'items',
+        :'limit' => :'limit',
+        :'match_required_purchase_item_to_free_item' => :'match_required_purchase_item_to_free_item',
+        :'required_purchase_items' => :'required_purchase_items'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'items' => :'Array<String>',
+        :'limit' => :'Integer',
+        :'match_required_purchase_item_to_free_item' => :'Boolean',
+        :'required_purchase_items' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'match_required_purchase_item_to_free_item')
+        self.match_required_purchase_item_to_free_item = attributes[:'match_required_purchase_item_to_free_item']
+      end
+
+      if attributes.key?(:'required_purchase_items')
+        if (value = attributes[:'required_purchase_items']).is_a?(Array)
+          self.required_purchase_items = value
+        end
+      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 &&
+          items == o.items &&
+          limit == o.limit &&
+          match_required_purchase_item_to_free_item == o.match_required_purchase_item_to_free_item &&
+          required_purchase_items == o.required_purchase_items
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [items, limit, match_required_purchase_item_to_free_item, required_purchase_items].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/customer.rb

@@ -130,6 +130,9 @@ module UltracartClient
 
     attr_accessor :privacy
 
+    # Properties for this customer
+    attr_accessor :properties
+
     # QuickBooks class to import this customer as
     attr_accessor :qb_class
 
@@ -236,6 +239,7 @@ module UltracartClient
         :'password' => :'password',
         :'pricing_tiers' => :'pricing_tiers',
         :'privacy' => :'privacy',
+        :'properties' => :'properties',
         :'qb_class' => :'qb_class',
         :'qb_code' => :'qb_code',
         :'qb_tax_exemption_reason_code' => :'qb_tax_exemption_reason_code',
@@ -309,6 +313,7 @@ module UltracartClient
         :'password' => :'String',
         :'pricing_tiers' => :'Array<CustomerPricingTier>',
         :'privacy' => :'CustomerPrivacy',
+        :'properties' => :'Array<CustomerProperty>',
         :'qb_class' => :'String',
         :'qb_code' => :'String',
         :'qb_tax_exemption_reason_code' => :'Integer',
@@ -527,6 +532,12 @@ module UltracartClient
         self.privacy = attributes[:'privacy']
       end
 
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Array)
+          self.properties = value
+        end
+      end
+
       if attributes.key?(:'qb_class')
         self.qb_class = attributes[:'qb_class']
       end
@@ -847,6 +858,7 @@ module UltracartClient
           password == o.password &&
           pricing_tiers == o.pricing_tiers &&
           privacy == o.privacy &&
+          properties == o.properties &&
           qb_class == o.qb_class &&
           qb_code == o.qb_code &&
           qb_tax_exemption_reason_code == o.qb_tax_exemption_reason_code &&
@@ -880,7 +892,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, edi, email, exempt_shipping_handling_charge, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
+      [activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, edi, email, exempt_shipping_handling_charge, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, properties, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_property.rb

@@ -0,0 +1,270 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class CustomerProperty
+    # The date/time that the property expires and is deleted
+    attr_accessor :expiration_dts
+
+    # Name
+    attr_accessor :name
+
+    # Value
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiration_dts' => :'expiration_dts',
+        :'name' => :'name',
+        :'value' => :'value'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'expiration_dts' => :'String',
+        :'name' => :'String',
+        :'value' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CustomerProperty` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CustomerProperty`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@value.nil? && @value.to_s.length > 1500
+        invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 1500.')
+      end
+
+      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?
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@value.nil? && @value.to_s.length > 1500
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if !value.nil? && value.to_s.length > 1500
+        fail ArgumentError, 'invalid value for "value", the character length must be smaller than or equal to 1500.'
+      end
+
+      @value = value
+    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 &&
+          expiration_dts == o.expiration_dts &&
+          name == o.name &&
+          value == o.value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [expiration_dts, name, value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.172'
+  VERSION = '4.0.173'
 end

data/lib/ultracart_api.rb

@@ -228,6 +228,7 @@ require 'ultracart_api/models/coupon_editor_values'
 require 'ultracart_api/models/coupon_exists_response'
 require 'ultracart_api/models/coupon_free_item_and_shipping_with_subtotal'
 require 'ultracart_api/models/coupon_free_item_with_item_purchase'
+require 'ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping'
 require 'ultracart_api/models/coupon_free_item_with_subtotal'
 require 'ultracart_api/models/coupon_free_items_with_item_purchase'
 require 'ultracart_api/models/coupon_free_items_with_mix_match_purchase'
@@ -291,6 +292,7 @@ require 'ultracart_api/models/customer_merge_request'
 require 'ultracart_api/models/customer_orders_summary'
 require 'ultracart_api/models/customer_pricing_tier'
 require 'ultracart_api/models/customer_privacy'
+require 'ultracart_api/models/customer_property'
 require 'ultracart_api/models/customer_query'
 require 'ultracart_api/models/customer_quotes_summary'
 require 'ultracart_api/models/customer_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.172
+  version: 4.0.173
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -279,6 +279,7 @@ files:
 - docs/CouponExistsResponse.md
 - docs/CouponFreeItemAndShippingWithSubtotal.md
 - docs/CouponFreeItemWithItemPurchase.md
+- docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md
 - docs/CouponFreeItemWithSubtotal.md
 - docs/CouponFreeItemsWithItemPurchase.md
 - docs/CouponFreeItemsWithMixMatchPurchase.md
@@ -343,6 +344,7 @@ files:
 - docs/CustomerOrdersSummary.md
 - docs/CustomerPricingTier.md
 - docs/CustomerPrivacy.md
+- docs/CustomerProperty.md
 - docs/CustomerQuery.md
 - docs/CustomerQuotesSummary.md
 - docs/CustomerResponse.md
@@ -1095,6 +1097,7 @@ files:
 - lib/ultracart_api/models/coupon_exists_response.rb
 - lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb
 - lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb
+- lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb
 - lib/ultracart_api/models/coupon_free_item_with_subtotal.rb
 - lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb
 - lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb
@@ -1158,6 +1161,7 @@ files:
 - lib/ultracart_api/models/customer_orders_summary.rb
 - lib/ultracart_api/models/customer_pricing_tier.rb
 - lib/ultracart_api/models/customer_privacy.rb
+- lib/ultracart_api/models/customer_property.rb
 - lib/ultracart_api/models/customer_query.rb
 - lib/ultracart_api/models/customer_quotes_summary.rb
 - lib/ultracart_api/models/customer_response.rb