ultracart_api 3.1.16 → 3.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e1dca094efb67d0bac4bb8b5cf7981f9e79a839d7981692ebfe6861958f5f22
-  data.tar.gz: 80635a0be6fee0613757361dabfee9eb3f5101ff2789efdc7f0619b237c35c19
+  metadata.gz: 73ab4c834ab8a23e2eed548475b1b8028ce7e88e0fcce48124cbfd182bc653a7
+  data.tar.gz: c4ce953a77aae9325c9a80e954810a069e82bd8796d62c29056938392694eb8a
 SHA512:
-  metadata.gz: 7b487dd7b86403457585a031da3a855c9b0b3cd99d4b786b6e57fa8bea67ea8f1132e736d91ac09853d0c28838429146b62c0ab0dfab11424bd851e1e4fc8a69
-  data.tar.gz: 5abfdda396d83c67d25e8df251d9b30b6b89f0a6dd7c56a45ef808af98822c93ea2eb0156d83b4c47569764e39157b3e98f18b5eb7c2b6581534c3222b076c0a
+  metadata.gz: 1ea1e5422d0aa76786848d12718a0fe99afe9bd0486e2528a64b41346782d284247991551172cc8608bfb0fea5533638fe9f0b098500d6e0fd1b83e6a7054489
+  data.tar.gz: f8a0cf76b26e52c1ed87cffa09986ebfa66c7a6e62b17788c908dae65abea1e20138771fb609fb967e1e07458db6e4e6bf6cd4f39a34d17cb442b83f8a1e11b7

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.1.16
+- Package version: 3.1.17
 - 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.1.16.gem
+gem install ./ultracart_api-3.1.17.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.16.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.17.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.1.16'
+    gem 'ultracart_api', '~> 3.1.17'
 
 ### Install from Git
 
@@ -522,6 +522,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
  - [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
  - [UltracartClient::CouponPercentOffItemsWithItemsPurchase](docs/CouponPercentOffItemsWithItemsPurchase.md)
+ - [UltracartClient::CouponPercentOffMsrpItems](docs/CouponPercentOffMsrpItems.md)
  - [UltracartClient::CouponPercentOffRetailPriceItems](docs/CouponPercentOffRetailPriceItems.md)
  - [UltracartClient::CouponPercentOffShipping](docs/CouponPercentOffShipping.md)
  - [UltracartClient::CouponPercentOffSubtotal](docs/CouponPercentOffSubtotal.md)
@@ -1007,6 +1008,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.1.17 | 03/17/2021 | New coupon - percent off MSRP item |
 | 3.1.16 | 03/16/2021 | screen recording filter page parameter names |
 | 3.1.15 | 03/15/2021 | fix response from deleteScreenRecordingSegment that should have been void |
 | 3.1.14 | 03/15/2021 | sort screen recordings by favorite flag |

data/docs/Coupon.md

@@ -41,6 +41,7 @@ Name | Type | Description | Notes
 **percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) |  | [optional] 
 **percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) |  | [optional] 
 **percent_off_items_with_items_purchase** | [**CouponPercentOffItemsWithItemsPurchase**](CouponPercentOffItemsWithItemsPurchase.md) |  | [optional] 
+**percent_off_msrp_items** | [**CouponPercentOffMsrpItems**](CouponPercentOffMsrpItems.md) |  | [optional] 
 **percent_off_retail_price_items** | [**CouponPercentOffRetailPriceItems**](CouponPercentOffRetailPriceItems.md) |  | [optional] 
 **percent_off_shipping** | [**CouponPercentOffShipping**](CouponPercentOffShipping.md) |  | [optional] 
 **percent_off_subtotal** | [**CouponPercentOffSubtotal**](CouponPercentOffSubtotal.md) |  | [optional] 

data/docs/CouponPercentOffMsrpItems.md

@@ -0,0 +1,11 @@
+# UltracartClient::CouponPercentOffMsrpItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount_percent** | **Float** | The percentage of subtotal discount | [optional] 
+**excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional] 
+**items** | **Array<String>** | An optional list of items which will receive a discount.  If blank, discount applies to all items except excluded items. | [optional] 
+**limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] 
+
+

data/lib/ultracart_api.rb

@@ -156,6 +156,7 @@ require 'ultracart_api/models/coupon_percent_off_item_with_items_quantity_purcha
 require 'ultracart_api/models/coupon_percent_off_items'
 require 'ultracart_api/models/coupon_percent_off_items_and_free_shipping'
 require 'ultracart_api/models/coupon_percent_off_items_with_items_purchase'
+require 'ultracart_api/models/coupon_percent_off_msrp_items'
 require 'ultracart_api/models/coupon_percent_off_retail_price_items'
 require 'ultracart_api/models/coupon_percent_off_shipping'
 require 'ultracart_api/models/coupon_percent_off_subtotal'

data/lib/ultracart_api/models/coupon.rb

@@ -100,6 +100,8 @@ module UltracartClient
 
     attr_accessor :percent_off_items_with_items_purchase
 
+    attr_accessor :percent_off_msrp_items
+
     attr_accessor :percent_off_retail_price_items
 
     attr_accessor :percent_off_shipping
@@ -186,6 +188,7 @@ module UltracartClient
         :'percent_off_items' => :'percent_off_items',
         :'percent_off_items_and_free_shipping' => :'percent_off_items_and_free_shipping',
         :'percent_off_items_with_items_purchase' => :'percent_off_items_with_items_purchase',
+        :'percent_off_msrp_items' => :'percent_off_msrp_items',
         :'percent_off_retail_price_items' => :'percent_off_retail_price_items',
         :'percent_off_shipping' => :'percent_off_shipping',
         :'percent_off_subtotal' => :'percent_off_subtotal',
@@ -249,6 +252,7 @@ module UltracartClient
         :'percent_off_items' => :'CouponPercentOffItems',
         :'percent_off_items_and_free_shipping' => :'CouponPercentOffItemsAndFreeShipping',
         :'percent_off_items_with_items_purchase' => :'CouponPercentOffItemsWithItemsPurchase',
+        :'percent_off_msrp_items' => :'CouponPercentOffMsrpItems',
         :'percent_off_retail_price_items' => :'CouponPercentOffRetailPriceItems',
         :'percent_off_shipping' => :'CouponPercentOffShipping',
         :'percent_off_subtotal' => :'CouponPercentOffSubtotal',
@@ -431,6 +435,10 @@ module UltracartClient
         self.percent_off_items_with_items_purchase = attributes[:'percent_off_items_with_items_purchase']
       end
 
+      if attributes.has_key?(:'percent_off_msrp_items')
+        self.percent_off_msrp_items = attributes[:'percent_off_msrp_items']
+      end
+
       if attributes.has_key?(:'percent_off_retail_price_items')
         self.percent_off_retail_price_items = attributes[:'percent_off_retail_price_items']
       end
@@ -660,6 +668,7 @@ module UltracartClient
           percent_off_items == o.percent_off_items &&
           percent_off_items_and_free_shipping == o.percent_off_items_and_free_shipping &&
           percent_off_items_with_items_purchase == o.percent_off_items_with_items_purchase &&
+          percent_off_msrp_items == o.percent_off_msrp_items &&
           percent_off_retail_price_items == o.percent_off_retail_price_items &&
           percent_off_shipping == o.percent_off_shipping &&
           percent_off_subtotal == o.percent_off_subtotal &&
@@ -690,7 +699,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, 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_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_item, 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, 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, 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_item, 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_percent_off_msrp_items.rb

@@ -0,0 +1,219 @@
+=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 CouponPercentOffMsrpItems
+    # The percentage of subtotal discount
+    attr_accessor :discount_percent
+
+    # A list of items which cannot be discounted.
+    attr_accessor :excluded_items
+
+    # An optional list of items which will receive a discount.  If blank, discount applies to all items except excluded items.
+    attr_accessor :items
+
+    # The (optional) maximum quantity of discounted items.
+    attr_accessor :limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'discount_percent' => :'discount_percent',
+        :'excluded_items' => :'excluded_items',
+        :'items' => :'items',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'discount_percent' => :'Float',
+        :'excluded_items' => :'Array<String>',
+        :'items' => :'Array<String>',
+        :'limit' => :'Integer'
+      }
+    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?(:'discount_percent')
+        self.discount_percent = attributes[:'discount_percent']
+      end
+
+      if attributes.has_key?(:'excluded_items')
+        if (value = attributes[:'excluded_items']).is_a?(Array)
+          self.excluded_items = value
+        end
+      end
+
+      if attributes.has_key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+
+      if attributes.has_key?(:'limit')
+        self.limit = attributes[:'limit']
+      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 &&
+          discount_percent == o.discount_percent &&
+          excluded_items == o.excluded_items &&
+          items == o.items &&
+          limit == o.limit
+    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
+      [discount_percent, excluded_items, items, limit].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.1.16'
+  VERSION = '3.1.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.1.16
+  version: 3.1.17
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -345,6 +345,7 @@ files:
 - docs/CouponPercentOffItems.md
 - docs/CouponPercentOffItemsAndFreeShipping.md
 - docs/CouponPercentOffItemsWithItemsPurchase.md
+- docs/CouponPercentOffMsrpItems.md
 - docs/CouponPercentOffRetailPriceItems.md
 - docs/CouponPercentOffShipping.md
 - docs/CouponPercentOffSubtotal.md
@@ -937,6 +938,7 @@ files:
 - lib/ultracart_api/models/coupon_percent_off_items.rb
 - lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb
 - lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb
+- lib/ultracart_api/models/coupon_percent_off_msrp_items.rb
 - lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb
 - lib/ultracart_api/models/coupon_percent_off_shipping.rb
 - lib/ultracart_api/models/coupon_percent_off_subtotal.rb