ultracart_api 3.10.60 → 3.10.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ae39ba428e276a0e0b5fca7bf34a24f910b1f9475409615a6b72aa1b7de0c69
-  data.tar.gz: 54b7663a30fe6d0e2a268b090579ac34cef3bf780ee1daf2f97fbe6fee5eddd1
+  metadata.gz: 897aa52e1624e0b694c701c24aa5626564c1cc0b80dff5b49992dc69d47678cd
+  data.tar.gz: c5c868f75fd1b82fab93fcacb31ceb16c7dcab674dbc1fa87471748e7ce4443d
 SHA512:
-  metadata.gz: 1e5cb568a899738c4e0fb60dc8cef31fc59ddf51c2813917a1b75978f346fcc95fbdd6bc031960ae3d073565d9ba7dcd6d456eee7d8e0169c49193ad5f8186a1
-  data.tar.gz: d5170a0d52c150efc3501725b303105de10c6d0070f44637533290c8c723576cdc79f9f83a5d4092f1e28098e2930a2ad74b3a37d98c044bfd4ac97d91e5b6b1
+  metadata.gz: ad671cc73abf0d555f2af954033086fc24739200bfb2a7c3b62b0ace8970c95a6c7a09cd2c9c406d22d8d2e89d02e77f0a9b3baf49183e64d083c3c818ee7473
+  data.tar.gz: ed94eaa6a5790be0c4136943269eec256d341dd15363f3e02a6526aa65d7f84e671f34ac3885f55c278d6448f87fbe9b5f51b06e3596d9099086c47a117ff865

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.60
+- Package version: 3.10.62
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.60.gem
+gem install ./ultracart_api-3.10.62.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.60.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.62.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.10.60'
+    gem 'ultracart_api', '~> 3.10.62'
 
 ### Install from Git
 
@@ -665,6 +665,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponTieredPercentOffItems](docs/CouponTieredPercentOffItems.md)
  - [UltracartClient::CouponTieredPercentOffShipping](docs/CouponTieredPercentOffShipping.md)
  - [UltracartClient::CouponTieredPercentOffSubtotal](docs/CouponTieredPercentOffSubtotal.md)
+ - [UltracartClient::CouponTieredPercentOffSubtotalBasedOnMSRP](docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md)
  - [UltracartClient::CouponType](docs/CouponType.md)
  - [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
@@ -1212,6 +1213,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.62 | 11/09/2022 | conversations - add an enum of event typing |
+| 3.10.61 | 11/04/2022 | new coupon type percent based on msrp |
 | 3.10.60 | 10/31/2022 | communication bug fix on dup annonation |
 | 3.10.59 | 10/31/2022 | communications - addl statistics on EmailStepStat object |
 | 3.10.58 | 10/26/2022 | esp - methods for sms testing |

data/docs/Coupon.md

@@ -62,6 +62,7 @@ Name | Type | Description | Notes
 **tiered_percent_off_items** | [**CouponTieredPercentOffItems**](CouponTieredPercentOffItems.md) |  | [optional] 
 **tiered_percent_off_shipping** | [**CouponTieredPercentOffShipping**](CouponTieredPercentOffShipping.md) |  | [optional] 
 **tiered_percent_off_subtotal** | [**CouponTieredPercentOffSubtotal**](CouponTieredPercentOffSubtotal.md) |  | [optional] 
+**tiered_percent_off_subtotal_based_on_msrp** | [**CouponTieredPercentOffSubtotalBasedOnMSRP**](CouponTieredPercentOffSubtotalBasedOnMSRP.md) |  | [optional] 
 **usable_by** | **String** | Who may use this coupon. | [optional] 
 
 

data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md

@@ -0,0 +1,9 @@
+# UltracartClient::CouponTieredPercentOffSubtotalBasedOnMSRP
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | **Array<String>** | An optional list of items of which a quantity of one or many must be purchased for coupon to be valid.  If empty, all items apply toward subtotal amount. | [optional] 
+**tiers** | [**Array<CouponTierPercent>**](CouponTierPercent.md) | A list of discount tiers. | [optional] 
+
+

data/docs/ItemFulfillmentAddon.md

@@ -5,7 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **add_item_id** | **String** | Add Item Id | [optional] 
 **add_item_oid** | **Integer** | Add Item object identifier | [optional] 
-**once_per_order** | **BOOLEAN** | Quantity | [optional] 
+**initial_order_only** | **BOOLEAN** | Initial Order Only | [optional] 
+**once_per_order** | **BOOLEAN** | Once Per Order | [optional] 
 **quantity** | **Integer** | Quantity | [optional] 
 
 

data/lib/ultracart_api/models/conversation_websocket_message.rb

@@ -182,7 +182,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message'])
+      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing'])
       return false unless event_type_validator.valid?(@event_type)
       type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       return false unless type_validator.valid?(@type)
@@ -192,7 +192,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_type Object to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/models/coupon.rb

@@ -149,6 +149,8 @@ module UltracartClient
 
     attr_accessor :tiered_percent_off_subtotal
 
+    attr_accessor :tiered_percent_off_subtotal_based_on_msrp
+
     # Who may use this coupon.
     attr_accessor :usable_by
 
@@ -214,6 +216,7 @@ module UltracartClient
         :'tiered_percent_off_items' => :'tiered_percent_off_items',
         :'tiered_percent_off_shipping' => :'tiered_percent_off_shipping',
         :'tiered_percent_off_subtotal' => :'tiered_percent_off_subtotal',
+        :'tiered_percent_off_subtotal_based_on_msrp' => :'tiered_percent_off_subtotal_based_on_msrp',
         :'usable_by' => :'usable_by'
       }
     end
@@ -280,6 +283,7 @@ module UltracartClient
         :'tiered_percent_off_items' => :'CouponTieredPercentOffItems',
         :'tiered_percent_off_shipping' => :'CouponTieredPercentOffShipping',
         :'tiered_percent_off_subtotal' => :'CouponTieredPercentOffSubtotal',
+        :'tiered_percent_off_subtotal_based_on_msrp' => :'CouponTieredPercentOffSubtotalBasedOnMSRP',
         :'usable_by' => :'String'
       }
     end
@@ -534,6 +538,10 @@ module UltracartClient
         self.tiered_percent_off_subtotal = attributes[:'tiered_percent_off_subtotal']
       end
 
+      if attributes.has_key?(:'tiered_percent_off_subtotal_based_on_msrp')
+        self.tiered_percent_off_subtotal_based_on_msrp = attributes[:'tiered_percent_off_subtotal_based_on_msrp']
+      end
+
       if attributes.has_key?(:'usable_by')
         self.usable_by = attributes[:'usable_by']
       end
@@ -706,6 +714,7 @@ module UltracartClient
           tiered_percent_off_items == o.tiered_percent_off_items &&
           tiered_percent_off_shipping == o.tiered_percent_off_shipping &&
           tiered_percent_off_subtotal == o.tiered_percent_off_subtotal &&
+          tiered_percent_off_subtotal_based_on_msrp == o.tiered_percent_off_subtotal_based_on_msrp &&
           usable_by == o.usable_by
     end
 
@@ -718,7 +727,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, 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
+      [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, tiered_percent_off_subtotal_based_on_msrp, usable_by].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb

@@ -0,0 +1,199 @@
+=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 CouponTieredPercentOffSubtotalBasedOnMSRP
+    # An optional list of items of which a quantity of one or many must be purchased for coupon to be valid.  If empty, all items apply toward subtotal amount.
+    attr_accessor :items
+
+    # A list of discount tiers.
+    attr_accessor :tiers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'items' => :'items',
+        :'tiers' => :'tiers'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'items' => :'Array<String>',
+        :'tiers' => :'Array<CouponTierPercent>'
+      }
+    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?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+
+      if attributes.has_key?(:'tiers')
+        if (value = attributes[:'tiers']).is_a?(Array)
+          self.tiers = 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 &&
+          tiers == o.tiers
+    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
+      [items, tiers].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/item_fulfillment_addon.rb

@@ -20,7 +20,10 @@ module UltracartClient
     # Add Item object identifier
     attr_accessor :add_item_oid
 
-    # Quantity
+    # Initial Order Only
+    attr_accessor :initial_order_only
+
+    # Once Per Order
     attr_accessor :once_per_order
 
     # Quantity
@@ -31,6 +34,7 @@ module UltracartClient
       {
         :'add_item_id' => :'add_item_id',
         :'add_item_oid' => :'add_item_oid',
+        :'initial_order_only' => :'initial_order_only',
         :'once_per_order' => :'once_per_order',
         :'quantity' => :'quantity'
       }
@@ -41,6 +45,7 @@ module UltracartClient
       {
         :'add_item_id' => :'String',
         :'add_item_oid' => :'Integer',
+        :'initial_order_only' => :'BOOLEAN',
         :'once_per_order' => :'BOOLEAN',
         :'quantity' => :'Integer'
       }
@@ -62,6 +67,10 @@ module UltracartClient
         self.add_item_oid = attributes[:'add_item_oid']
       end
 
+      if attributes.has_key?(:'initial_order_only')
+        self.initial_order_only = attributes[:'initial_order_only']
+      end
+
       if attributes.has_key?(:'once_per_order')
         self.once_per_order = attributes[:'once_per_order']
       end
@@ -91,6 +100,7 @@ module UltracartClient
       self.class == o.class &&
           add_item_id == o.add_item_id &&
           add_item_oid == o.add_item_oid &&
+          initial_order_only == o.initial_order_only &&
           once_per_order == o.once_per_order &&
           quantity == o.quantity
     end
@@ -104,7 +114,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [add_item_id, add_item_oid, once_per_order, quantity].hash
+      [add_item_id, add_item_oid, initial_order_only, once_per_order, quantity].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -221,6 +221,7 @@ require 'ultracart_api/models/coupon_tiered_amount_off_subtotal'
 require 'ultracart_api/models/coupon_tiered_percent_off_items'
 require 'ultracart_api/models/coupon_tiered_percent_off_shipping'
 require 'ultracart_api/models/coupon_tiered_percent_off_subtotal'
+require 'ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp'
 require 'ultracart_api/models/coupon_type'
 require 'ultracart_api/models/coupons_request'
 require 'ultracart_api/models/coupons_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.60
+  version: 3.10.62
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -432,6 +432,7 @@ files:
 - docs/CouponTieredPercentOffItems.md
 - docs/CouponTieredPercentOffShipping.md
 - docs/CouponTieredPercentOffSubtotal.md
+- docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md
 - docs/CouponType.md
 - docs/CouponsRequest.md
 - docs/CouponsResponse.md
@@ -1149,6 +1150,7 @@ files:
 - lib/ultracart_api/models/coupon_tiered_percent_off_items.rb
 - lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb
 - lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb
+- lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb
 - lib/ultracart_api/models/coupon_type.rb
 - lib/ultracart_api/models/coupons_request.rb
 - lib/ultracart_api/models/coupons_response.rb