ultracart_api 3.8.2 → 3.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6fcd6b38c2028518ee26e9fe47536e68d689cfd36fde62e82785886d897728
-  data.tar.gz: f9091412de255d297c8d4b82b9d252f89788f386cd6b73b6826c3d84dcef1f30
+  metadata.gz: cf5d7299ac7cec6283cad21854c0553d612b51c3db332a89bb2e615ca849e5ca
+  data.tar.gz: 52af10f64882802aa7ccd617657c6cd7cee92cc0ee6a0ce32eb8802b48d45ae7
 SHA512:
-  metadata.gz: e334f9c3ea1113fcb3f2ba2617b21612bbf616f132383f0ec9b449c035119078ab469272dbe22b7e87114aa06c2d9099ecea3bdb6c2d1eddd5a84e64bd409712
-  data.tar.gz: 046c6501f2cc2ec2642e634c66679eb114c2ebda519fdccf35a45ad82007d70cbbefb195dbb2a969b598ef9f64371913faadf26beca54c429632bbdbefc33b16
+  metadata.gz: e3c0226e47f35ec46be9dcc1b70c1f844103e9b7f8ce4af57fe36e36b1776c94ad695869b7bd69e1dce9799d3913c539c1c4c86078bf281baf9ed059bf3891ad
+  data.tar.gz: dd0140c3ec4843a6b02b72b8831c6bafcd926dc447eea3f27c877e7a9c4684cff076dd0994e708d263dc02a3fb531c0dda48abb4139288d275869a5fc8b96a28

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.8.2
+- Package version: 3.8.5
 - 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.8.2.gem
+gem install ./ultracart_api-3.8.5.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.8.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.8.5.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.8.2'
+    gem 'ultracart_api', '~> 3.8.5'
 
 ### Install from Git
 
@@ -545,6 +545,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponAmountOffSubtotalWithBlockPurchase](docs/CouponAmountOffSubtotalWithBlockPurchase.md)
  - [UltracartClient::CouponAmountOffSubtotalWithItemsPurchase](docs/CouponAmountOffSubtotalWithItemsPurchase.md)
  - [UltracartClient::CouponAmountOffSubtotalWithPurchase](docs/CouponAmountOffSubtotalWithPurchase.md)
+ - [UltracartClient::CouponAmountShippingWithSubtotal](docs/CouponAmountShippingWithSubtotal.md)
  - [UltracartClient::CouponAutoApplyCondition](docs/CouponAutoApplyCondition.md)
  - [UltracartClient::CouponAutoApplyConditions](docs/CouponAutoApplyConditions.md)
  - [UltracartClient::CouponAutomaticallyApplyCouponCodes](docs/CouponAutomaticallyApplyCouponCodes.md)
@@ -1145,6 +1146,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.8.5 | 02/25/2022 | new coupon for fixed cost shipping method |
 | 3.8.2 | 02/16/2022 | create gift certificate method was missing email |
 | 3.8.1 | 02/16/2022 | auto order item level pause flag |
 | 3.8.0 | 02/16/2022 | gift certificate api (testing) |

data/docs/Coupon.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **amount_off_subtotal_with_block_purchase** | [**CouponAmountOffSubtotalWithBlockPurchase**](CouponAmountOffSubtotalWithBlockPurchase.md) |  | [optional] 
 **amount_off_subtotal_with_items_purchase** | [**CouponAmountOffSubtotalWithItemsPurchase**](CouponAmountOffSubtotalWithItemsPurchase.md) |  | [optional] 
 **amount_off_subtotal_with_purchase** | [**CouponAmountOffSubtotalWithPurchase**](CouponAmountOffSubtotalWithPurchase.md) |  | [optional] 
+**amount_shipping_with_subtotal** | [**CouponAmountShippingWithSubtotal**](CouponAmountShippingWithSubtotal.md) |  | [optional] 
 **automatically_apply_coupon_codes** | [**CouponAutomaticallyApplyCouponCodes**](CouponAutomaticallyApplyCouponCodes.md) |  | [optional] 
 **buy_one_get_one** | [**CouponBuyOneGetOneLimit**](CouponBuyOneGetOneLimit.md) |  | [optional] 
 **calculated_description** | **String** | Calculated description displayed to the customer if no description is specified. | [optional] 

data/docs/CouponAmountShippingWithSubtotal.md

@@ -0,0 +1,11 @@
+# UltracartClient::CouponAmountShippingWithSubtotal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_code** | **String** | The ISO-4217 three letter currency code the customer is viewing prices in | [optional] 
+**purchase_amount** | **Float** | The purchase amount to qualify for subtotal discount and free shipping | [optional] 
+**shipping_amount** | **Float** | The amount of the shipping cost (this is not a discount, this is the actual cost of shipping) | [optional] 
+**shipping_methods** | **Array<String>** | One or more shipping methods that may be used with this coupon | [optional] 
+
+

data/lib/ultracart_api/models/coupon.rb

@@ -38,6 +38,8 @@ module UltracartClient
 
     attr_accessor :amount_off_subtotal_with_purchase
 
+    attr_accessor :amount_shipping_with_subtotal
+
     attr_accessor :automatically_apply_coupon_codes
 
     attr_accessor :buy_one_get_one
@@ -164,6 +166,7 @@ module UltracartClient
         :'amount_off_subtotal_with_block_purchase' => :'amount_off_subtotal_with_block_purchase',
         :'amount_off_subtotal_with_items_purchase' => :'amount_off_subtotal_with_items_purchase',
         :'amount_off_subtotal_with_purchase' => :'amount_off_subtotal_with_purchase',
+        :'amount_shipping_with_subtotal' => :'amount_shipping_with_subtotal',
         :'automatically_apply_coupon_codes' => :'automatically_apply_coupon_codes',
         :'buy_one_get_one' => :'buy_one_get_one',
         :'calculated_description' => :'calculated_description',
@@ -229,6 +232,7 @@ module UltracartClient
         :'amount_off_subtotal_with_block_purchase' => :'CouponAmountOffSubtotalWithBlockPurchase',
         :'amount_off_subtotal_with_items_purchase' => :'CouponAmountOffSubtotalWithItemsPurchase',
         :'amount_off_subtotal_with_purchase' => :'CouponAmountOffSubtotalWithPurchase',
+        :'amount_shipping_with_subtotal' => :'CouponAmountShippingWithSubtotal',
         :'automatically_apply_coupon_codes' => :'CouponAutomaticallyApplyCouponCodes',
         :'buy_one_get_one' => :'CouponBuyOneGetOneLimit',
         :'calculated_description' => :'String',
@@ -332,6 +336,10 @@ module UltracartClient
         self.amount_off_subtotal_with_purchase = attributes[:'amount_off_subtotal_with_purchase']
       end
 
+      if attributes.has_key?(:'amount_shipping_with_subtotal')
+        self.amount_shipping_with_subtotal = attributes[:'amount_shipping_with_subtotal']
+      end
+
       if attributes.has_key?(:'automatically_apply_coupon_codes')
         self.automatically_apply_coupon_codes = attributes[:'automatically_apply_coupon_codes']
       end
@@ -650,6 +658,7 @@ module UltracartClient
           amount_off_subtotal_with_block_purchase == o.amount_off_subtotal_with_block_purchase &&
           amount_off_subtotal_with_items_purchase == o.amount_off_subtotal_with_items_purchase &&
           amount_off_subtotal_with_purchase == o.amount_off_subtotal_with_purchase &&
+          amount_shipping_with_subtotal == o.amount_shipping_with_subtotal &&
           automatically_apply_coupon_codes == o.automatically_apply_coupon_codes &&
           buy_one_get_one == o.buy_one_get_one &&
           calculated_description == o.calculated_description &&
@@ -709,7 +718,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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, 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, multiple_amounts_off_items, no_discount, 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, start_dts, super_coupon, tiered_amount_off_items, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, 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_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, multiple_amounts_off_items, no_discount, 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, start_dts, super_coupon, tiered_amount_off_items, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb

@@ -0,0 +1,232 @@
+=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 CouponAmountShippingWithSubtotal
+    # The ISO-4217 three letter currency code the customer is viewing prices in
+    attr_accessor :currency_code
+
+    # The purchase amount to qualify for subtotal discount and free shipping
+    attr_accessor :purchase_amount
+
+    # The amount of the shipping cost (this is not a discount, this is the actual cost of shipping)
+    attr_accessor :shipping_amount
+
+    # One or more shipping methods that may be used with this coupon
+    attr_accessor :shipping_methods
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'currency_code' => :'currency_code',
+        :'purchase_amount' => :'purchase_amount',
+        :'shipping_amount' => :'shipping_amount',
+        :'shipping_methods' => :'shipping_methods'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'currency_code' => :'String',
+        :'purchase_amount' => :'Float',
+        :'shipping_amount' => :'Float',
+        :'shipping_methods' => :'Array<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?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.has_key?(:'purchase_amount')
+        self.purchase_amount = attributes[:'purchase_amount']
+      end
+
+      if attributes.has_key?(:'shipping_amount')
+        self.shipping_amount = attributes[:'shipping_amount']
+      end
+
+      if attributes.has_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 &&
+          purchase_amount == o.purchase_amount &&
+          shipping_amount == o.shipping_amount &&
+          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 [Fixnum] Hash code
+    def hash
+      [currency_code, purchase_amount, shipping_amount, 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 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/version.rb

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

data/lib/ultracart_api.rb

@@ -129,6 +129,7 @@ require 'ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purc
 require 'ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase'
 require 'ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase'
 require 'ultracart_api/models/coupon_amount_off_subtotal_with_purchase'
+require 'ultracart_api/models/coupon_amount_shipping_with_subtotal'
 require 'ultracart_api/models/coupon_auto_apply_condition'
 require 'ultracart_api/models/coupon_auto_apply_conditions'
 require 'ultracart_api/models/coupon_automatically_apply_coupon_codes'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.8.5
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -318,6 +318,7 @@ files:
 - docs/CouponAmountOffSubtotalWithBlockPurchase.md
 - docs/CouponAmountOffSubtotalWithItemsPurchase.md
 - docs/CouponAmountOffSubtotalWithPurchase.md
+- docs/CouponAmountShippingWithSubtotal.md
 - docs/CouponApi.md
 - docs/CouponAutoApplyCondition.md
 - docs/CouponAutoApplyConditions.md
@@ -1000,6 +1001,7 @@ files:
 - lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb
 - lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb
 - lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb
+- lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb
 - lib/ultracart_api/models/coupon_auto_apply_condition.rb
 - lib/ultracart_api/models/coupon_auto_apply_conditions.rb
 - lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb