ultracart_api 4.1.97 → 4.1.98

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713e1c8d45bf621b2beb0af2a5f2cca5ad01b5e795c9ec44ba18144ecbadf65d
-  data.tar.gz: 06ab9e7eeeed38e86531b06b460cfe891c323613467aff6a7e79348660a48d44
+  metadata.gz: 5d16fc9086ba10e99c5f7d108ef3d87718de83a82ff33936b7c7a2b1bc9e4f7b
+  data.tar.gz: 5023254127cd0016835b4a18768ce5f87bf79459413c9b219c6d7071df1f2c3b
 SHA512:
-  metadata.gz: b8f837b96fde9815b8104b28b10b2b0e7019f54959fb1e5eb3f3bd0190ee4eab5ce81ef6f58bf7fb124a86bb077403caab63669ba2e07b68b9c626abcd9fe613
-  data.tar.gz: 66485a5d84cfb2646bc4ceaee71965a54a2894007fa88b4e8897c83faeb511f0d544341f9f653e771aac2ba838e98bc86407ac7428345b50ec768c3ced7eaa5b
+  metadata.gz: c7a92f38ba33f63d9d8181607d8c11cce9e78b92cdae238c5e48ad33e98bf1baeeff2612a06a15ff377f74d49a9a944d3aa85a484abcf3cff24b809c1f409919
+  data.tar.gz: 76fe42c6ba9869960f889ea36166ae123463f33939db590d47b468c614f48285abca2e46046675c8aa0c6951648a85bd7bcad43603cecb3a82910af1403af575

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.97
+- Package version: 4.1.98
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.97'
+gem 'ultracart_api', '4.1.98'
 ```
 
 install:
@@ -1007,6 +1007,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Country](docs/Country.md)
  - [UltracartClient::Coupon](docs/Coupon.md)
  - [UltracartClient::CouponAmountOffItems](docs/CouponAmountOffItems.md)
+ - [UltracartClient::CouponAmountOffItemsAndFreeShipping](docs/CouponAmountOffItemsAndFreeShipping.md)
  - [UltracartClient::CouponAmountOffShipping](docs/CouponAmountOffShipping.md)
  - [UltracartClient::CouponAmountOffShippingWithItemsPurchase](docs/CouponAmountOffShippingWithItemsPurchase.md)
  - [UltracartClient::CouponAmountOffSubtotal](docs/CouponAmountOffSubtotal.md)
@@ -1774,6 +1775,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
 | 4.1.97 | 06/03/2026 | fraud api alpha version |
 | 4.1.96 | 06/03/2026 | fraud api alpha build |
 | 4.1.95 | 06/02/2026 | fraud api alpha version |

data/docs/Coupon.md

@@ -7,6 +7,7 @@
 | **affiliate_oid** | **Integer** | Associates an order with an affiliate when this value is set. | [optional] |
 | **allow_multiple_one_time_codes** | **Boolean** | True if multiple one time codes for this coupon can be used on a cart at the same time. | [optional] |
 | **amount_off_items** | [**CouponAmountOffItems**](CouponAmountOffItems.md) |  | [optional] |
+| **amount_off_items_and_free_shipping** | [**CouponAmountOffItemsAndFreeShipping**](CouponAmountOffItemsAndFreeShipping.md) |  | [optional] |
 | **amount_off_shipping** | [**CouponAmountOffShipping**](CouponAmountOffShipping.md) |  | [optional] |
 | **amount_off_shipping_with_items_purchase** | [**CouponAmountOffShippingWithItemsPurchase**](CouponAmountOffShippingWithItemsPurchase.md) |  | [optional] |
 | **amount_off_subtotal** | [**CouponAmountOffSubtotal**](CouponAmountOffSubtotal.md) |  | [optional] |
@@ -82,6 +83,7 @@ instance = UltracartClient::Coupon.new(
   affiliate_oid: null,
   allow_multiple_one_time_codes: null,
   amount_off_items: null,
+  amount_off_items_and_free_shipping: null,
   amount_off_shipping: null,
   amount_off_shipping_with_items_purchase: null,
   amount_off_subtotal: null,

data/docs/CouponAmountOffItemsAndFreeShipping.md

@@ -0,0 +1,28 @@
+# UltracartClient::CouponAmountOffItemsAndFreeShipping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO-4217 three letter currency code the customer is viewing prices in | [optional] |
+| **discount_amount** | **Float** | The amount of discount | [optional] |
+| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount. | [optional] |
+| **items** | **Array<String>** | A list of items which are eligible for the discount amount. | [optional] |
+| **limit** | **Integer** | The limit of items which are eligible for the discount amount. | [optional] |
+| **shipping_methods** | **Array<String>** | One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CouponAmountOffItemsAndFreeShipping.new(
+  currency_code: null,
+  discount_amount: null,
+  item_tags: null,
+  items: null,
+  limit: null,
+  shipping_methods: null
+)
+```
+

data/lib/ultracart_api/models/coupon.rb

@@ -23,6 +23,8 @@ module UltracartClient
 
     attr_accessor :amount_off_items
 
+    attr_accessor :amount_off_items_and_free_shipping
+
     attr_accessor :amount_off_shipping
 
     attr_accessor :amount_off_shipping_with_items_purchase
@@ -198,6 +200,7 @@ module UltracartClient
         :'affiliate_oid' => :'affiliate_oid',
         :'allow_multiple_one_time_codes' => :'allow_multiple_one_time_codes',
         :'amount_off_items' => :'amount_off_items',
+        :'amount_off_items_and_free_shipping' => :'amount_off_items_and_free_shipping',
         :'amount_off_shipping' => :'amount_off_shipping',
         :'amount_off_shipping_with_items_purchase' => :'amount_off_shipping_with_items_purchase',
         :'amount_off_subtotal' => :'amount_off_subtotal',
@@ -277,6 +280,7 @@ module UltracartClient
         :'affiliate_oid' => :'Integer',
         :'allow_multiple_one_time_codes' => :'Boolean',
         :'amount_off_items' => :'CouponAmountOffItems',
+        :'amount_off_items_and_free_shipping' => :'CouponAmountOffItemsAndFreeShipping',
         :'amount_off_shipping' => :'CouponAmountOffShipping',
         :'amount_off_shipping_with_items_purchase' => :'CouponAmountOffShippingWithItemsPurchase',
         :'amount_off_subtotal' => :'CouponAmountOffSubtotal',
@@ -378,6 +382,10 @@ module UltracartClient
         self.amount_off_items = attributes[:'amount_off_items']
       end
 
+      if attributes.key?(:'amount_off_items_and_free_shipping')
+        self.amount_off_items_and_free_shipping = attributes[:'amount_off_items_and_free_shipping']
+      end
+
       if attributes.key?(:'amount_off_shipping')
         self.amount_off_shipping = attributes[:'amount_off_shipping']
       end
@@ -758,6 +766,7 @@ module UltracartClient
           affiliate_oid == o.affiliate_oid &&
           allow_multiple_one_time_codes == o.allow_multiple_one_time_codes &&
           amount_off_items == o.amount_off_items &&
+          amount_off_items_and_free_shipping == o.amount_off_items_and_free_shipping &&
           amount_off_shipping == o.amount_off_shipping &&
           amount_off_shipping_with_items_purchase == o.amount_off_shipping_with_items_purchase &&
           amount_off_subtotal == o.amount_off_subtotal &&
@@ -834,7 +843,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_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_items_with_minimum_item_amount, 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_items_and_free_shipping, 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_items_with_minimum_item_amount, 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_amount_off_items_and_free_shipping.rb

@@ -0,0 +1,291 @@
+=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 CouponAmountOffItemsAndFreeShipping
+    # The ISO-4217 three letter currency code the customer is viewing prices in
+    attr_accessor :currency_code
+
+    # The amount of discount
+    attr_accessor :discount_amount
+
+    # An optional list of item tags which will receive a discount.
+    attr_accessor :item_tags
+
+    # A list of items which are eligible for the discount amount.
+    attr_accessor :items
+
+    # The limit of items which are eligible for the discount amount.
+    attr_accessor :limit
+
+    # One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+    attr_accessor :shipping_methods
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'currency_code' => :'currency_code',
+        :'discount_amount' => :'discount_amount',
+        :'item_tags' => :'item_tags',
+        :'items' => :'items',
+        :'limit' => :'limit',
+        :'shipping_methods' => :'shipping_methods'
+      }
+    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
+      {
+        :'currency_code' => :'String',
+        :'discount_amount' => :'Float',
+        :'item_tags' => :'Array<String>',
+        :'items' => :'Array<String>',
+        :'limit' => :'Integer',
+        :'shipping_methods' => :'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::CouponAmountOffItemsAndFreeShipping` 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::CouponAmountOffItemsAndFreeShipping`. 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?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'discount_amount')
+        self.discount_amount = attributes[:'discount_amount']
+      end
+
+      if attributes.key?(:'item_tags')
+        if (value = attributes[:'item_tags']).is_a?(Array)
+          self.item_tags = value
+        end
+      end
+
+      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?(:'shipping_methods')
+        if (value = attributes[:'shipping_methods']).is_a?(Array)
+          self.shipping_methods = 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
+      if !@currency_code.nil? && @currency_code.to_s.length > 3
+        invalid_properties.push('invalid value for "currency_code", the character length must be smaller than or equal to 3.')
+      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 !@currency_code.nil? && @currency_code.to_s.length > 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_code Value to be assigned
+    def currency_code=(currency_code)
+      if !currency_code.nil? && currency_code.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency_code", the character length must be smaller than or equal to 3.'
+      end
+
+      @currency_code = currency_code
+    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 &&
+          currency_code == o.currency_code &&
+          discount_amount == o.discount_amount &&
+          item_tags == o.item_tags &&
+          items == o.items &&
+          limit == o.limit &&
+          shipping_methods == o.shipping_methods
+    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
+      [currency_code, discount_amount, item_tags, items, limit, shipping_methods].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.1.97'
+  VERSION = '4.1.98'
 end

data/lib/ultracart_api.rb

@@ -329,6 +329,7 @@ require 'ultracart_api/models/countries_response'
 require 'ultracart_api/models/country'
 require 'ultracart_api/models/coupon'
 require 'ultracart_api/models/coupon_amount_off_items'
+require 'ultracart_api/models/coupon_amount_off_items_and_free_shipping'
 require 'ultracart_api/models/coupon_amount_off_shipping'
 require 'ultracart_api/models/coupon_amount_off_shipping_with_items_purchase'
 require 'ultracart_api/models/coupon_amount_off_subtotal'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.97
+  version: 4.1.98
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-03 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -379,6 +379,7 @@ files:
 - docs/Country.md
 - docs/Coupon.md
 - docs/CouponAmountOffItems.md
+- docs/CouponAmountOffItemsAndFreeShipping.md
 - docs/CouponAmountOffShipping.md
 - docs/CouponAmountOffShippingWithItemsPurchase.md
 - docs/CouponAmountOffSubtotal.md
@@ -1424,6 +1425,7 @@ files:
 - lib/ultracart_api/models/country.rb
 - lib/ultracart_api/models/coupon.rb
 - lib/ultracart_api/models/coupon_amount_off_items.rb
+- lib/ultracart_api/models/coupon_amount_off_items_and_free_shipping.rb
 - lib/ultracart_api/models/coupon_amount_off_shipping.rb
 - lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb
 - lib/ultracart_api/models/coupon_amount_off_subtotal.rb