talon_one 9.0.0 → 10.0.0

data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb

@@ -0,0 +1,269 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class CardAddedDeductedPointsBalancesNotificationPolicy
+    # Notification name.
+    attr_accessor :name
+
+    attr_accessor :scopes
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'scopes' => :'scopes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'scopes' => :'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 `TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy` 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 `TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @scopes.nil?
+        invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+      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?
+      return false if @name.to_s.length < 1
+      return false if @scopes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          scopes == o.scopes
+    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
+      [name, scopes].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)
+      self.class.openapi_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
+        TalonOne.const_get(type).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/talon_one/models/cart_item.rb

@@ -58,9 +58,24 @@ module TalonOne
     # Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). 
     attr_accessor :additional_costs
 
-    # The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog).
+    # The catalog item ID.
     attr_accessor :catalog_item_id
 
+    # The selected price type for this cart item (e.g. the price for members only).
+    attr_accessor :selected_price_type
+
+    # The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment.
+    attr_accessor :adjustment_reference_id
+
+    # The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field.
+    attr_accessor :adjustment_effective_from
+
+    # The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field.
+    attr_accessor :adjustment_effective_until
+
+    # A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. 
+    attr_accessor :prices
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -79,7 +94,12 @@ module TalonOne
         :'position' => :'position',
         :'attributes' => :'attributes',
         :'additional_costs' => :'additionalCosts',
-        :'catalog_item_id' => :'catalogItemID'
+        :'catalog_item_id' => :'catalogItemID',
+        :'selected_price_type' => :'selectedPriceType',
+        :'adjustment_reference_id' => :'adjustmentReferenceId',
+        :'adjustment_effective_from' => :'adjustmentEffectiveFrom',
+        :'adjustment_effective_until' => :'adjustmentEffectiveUntil',
+        :'prices' => :'prices'
       }
     end
 
@@ -101,7 +121,12 @@ module TalonOne
         :'position' => :'Float',
         :'attributes' => :'Object',
         :'additional_costs' => :'Hash<String, AdditionalCost>',
-        :'catalog_item_id' => :'Integer'
+        :'catalog_item_id' => :'Integer',
+        :'selected_price_type' => :'String',
+        :'adjustment_reference_id' => :'String',
+        :'adjustment_effective_from' => :'DateTime',
+        :'adjustment_effective_until' => :'DateTime',
+        :'prices' => :'Hash<String, PriceDetail>'
       }
     end
 
@@ -191,6 +216,28 @@ module TalonOne
       if attributes.key?(:'catalog_item_id')
         self.catalog_item_id = attributes[:'catalog_item_id']
       end
+
+      if attributes.key?(:'selected_price_type')
+        self.selected_price_type = attributes[:'selected_price_type']
+      end
+
+      if attributes.key?(:'adjustment_reference_id')
+        self.adjustment_reference_id = attributes[:'adjustment_reference_id']
+      end
+
+      if attributes.key?(:'adjustment_effective_from')
+        self.adjustment_effective_from = attributes[:'adjustment_effective_from']
+      end
+
+      if attributes.key?(:'adjustment_effective_until')
+        self.adjustment_effective_until = attributes[:'adjustment_effective_until']
+      end
+
+      if attributes.key?(:'prices')
+        if (value = attributes[:'prices']).is_a?(Hash)
+          self.prices = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -274,7 +321,12 @@ module TalonOne
           position == o.position &&
           attributes == o.attributes &&
           additional_costs == o.additional_costs &&
-          catalog_item_id == o.catalog_item_id
+          catalog_item_id == o.catalog_item_id &&
+          selected_price_type == o.selected_price_type &&
+          adjustment_reference_id == o.adjustment_reference_id &&
+          adjustment_effective_from == o.adjustment_effective_from &&
+          adjustment_effective_until == o.adjustment_effective_until &&
+          prices == o.prices
     end
 
     # @see the `==` method
@@ -286,7 +338,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, sku, quantity, returned_quantity, remaining_quantity, price, category, product, weight, height, width, length, position, attributes, additional_costs, catalog_item_id].hash
+      [name, sku, quantity, returned_quantity, remaining_quantity, price, category, product, weight, height, width, length, position, attributes, additional_costs, catalog_item_id, selected_price_type, adjustment_reference_id, adjustment_effective_from, adjustment_effective_until, prices].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/catalog.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Catalog
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/catalog_action.rb

@@ -107,7 +107,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["ADD", "PATCH", "PATCH_MANY", "REMOVE", "REMOVE_MANY"])
+      type_validator = EnumAttributeValidator.new('String', ["ADD", "PATCH", "PATCH_MANY", "REMOVE", "REMOVE_MANY", "ADD_PRICE_ADJUSTMENT"])
       return false unless type_validator.valid?(@type)
       return false if @payload.nil?
       true
@@ -116,7 +116,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["ADD", "PATCH", "PATCH_MANY", "REMOVE", "REMOVE_MANY"])
+      validator = EnumAttributeValidator.new('String', ["ADD", "PATCH", "PATCH_MANY", "REMOVE", "REMOVE_MANY", "ADD_PRICE_ADJUSTMENT"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/catalog_item.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CatalogItem
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/change.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Change
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/collection.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Collection
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/collection_without_payload.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CollectionWithoutPayload
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/coupon.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module TalonOne
   class Coupon
-    # Internal ID of this entity.
+    # The internal ID of the coupon.
     attr_accessor :id
 
-    # The time this entity was created.
+    # The time the coupon was created.
     attr_accessor :created
 
     # The ID of the campaign that owns this entity.
@@ -288,8 +288,8 @@ module TalonOne
         invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
       end
 
-      if !@discount_limit.nil? && @discount_limit > 999999
-        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -326,7 +326,7 @@ module TalonOne
       return false if @usage_limit.nil?
       return false if @usage_limit > 999999
       return false if @usage_limit < 0
-      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -370,8 +370,8 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] discount_limit Value to be assigned
     def discount_limit=(discount_limit)
-      if !discount_limit.nil? && discount_limit > 999999
-        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/coupon_constraints.rb

@@ -105,8 +105,8 @@ module TalonOne
         invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
       end
 
-      if !@discount_limit.nil? && @discount_limit > 999999
-        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -129,7 +129,7 @@ module TalonOne
     def valid?
       return false if !@usage_limit.nil? && @usage_limit > 999999
       return false if !@usage_limit.nil? && @usage_limit < 0
-      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -153,8 +153,8 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] discount_limit Value to be assigned
     def discount_limit=(discount_limit)
-      if !discount_limit.nil? && discount_limit > 999999
-        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/coupon_creation_job.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CouponCreationJob
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.
@@ -283,8 +283,8 @@ module TalonOne
         invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
       end
 
-      if !@discount_limit.nil? && @discount_limit > 999999
-        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -361,7 +361,7 @@ module TalonOne
       return false if @usage_limit.nil?
       return false if @usage_limit > 999999
       return false if @usage_limit < 0
-      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -401,8 +401,8 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] discount_limit Value to be assigned
     def discount_limit=(discount_limit)
-      if !discount_limit.nil? && discount_limit > 999999
-        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/coupon_deletion_job.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CouponDeletionJob
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.