talon_one 1.4.0 → 2.3.0

data/lib/talon_one/models/new_additional_cost.rb

@@ -0,0 +1,255 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class NewAdditionalCost
+    # The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload.
+    attr_accessor :name
+
+    # The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique.
+    attr_accessor :title
+
+    # A description of this additional cost.
+    attr_accessor :description
+
+    # A list of the IDs of the applications that are subscribed to this additional cost
+    attr_accessor :subscribed_applications_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'subscribed_applications_ids' => :'subscribedApplicationsIds'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'subscribed_applications_ids' => :'Array<Integer>'
+      }
+    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::NewAdditionalCost` 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::NewAdditionalCost`. 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?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'subscribed_applications_ids')
+        if (value = attributes[:'subscribed_applications_ids']).is_a?(Array)
+          self.subscribed_applications_ids = 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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description 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 @title.nil?
+      return false if @description.nil?
+      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 &&
+          name == o.name &&
+          title == o.title &&
+          description == o.description &&
+          subscribed_applications_ids == o.subscribed_applications_ids
+    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, title, description, subscribed_applications_ids].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/new_application.rb

@@ -3,10 +3,10 @@
 
 #The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
 
-OpenAPI spec version: 1.0.0
+The version of the OpenAPI document: 1.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.7
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -36,8 +36,26 @@ module TalonOne
     # Default limits for campaigns created in this application
     attr_accessor :limits
 
+    # Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\"
+    attr_accessor :campaign_priority
+
+    # The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\"
+    attr_accessor :exclusive_campaigns_strategy
+
+    # The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect.
+    attr_accessor :default_discount_scope
+
+    # Flag indicating if discounts should cascade for this application
+    attr_accessor :enable_cascading_discounts
+
+    # Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one
+    attr_accessor :enable_flattened_cart_items
+
     attr_accessor :attributes_settings
 
+    # Flag indicating if this is a live or sandbox application
+    attr_accessor :sandbox
+
     # Hex key for HMAC-signing API calls as coming from this application (16 hex digits)
     attr_accessor :key
 
@@ -73,13 +91,19 @@ module TalonOne
         :'case_sensitivity' => :'caseSensitivity',
         :'attributes' => :'attributes',
         :'limits' => :'limits',
+        :'campaign_priority' => :'campaignPriority',
+        :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy',
+        :'default_discount_scope' => :'defaultDiscountScope',
+        :'enable_cascading_discounts' => :'enableCascadingDiscounts',
+        :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
         :'attributes_settings' => :'attributesSettings',
+        :'sandbox' => :'sandbox',
         :'key' => :'key'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'name' => :'String',
         :'description' => :'String',
@@ -88,54 +112,97 @@ module TalonOne
         :'case_sensitivity' => :'String',
         :'attributes' => :'Object',
         :'limits' => :'Array<LimitConfig>',
+        :'campaign_priority' => :'String',
+        :'exclusive_campaigns_strategy' => :'String',
+        :'default_discount_scope' => :'String',
+        :'enable_cascading_discounts' => :'Boolean',
+        :'enable_flattened_cart_items' => :'Boolean',
         :'attributes_settings' => :'AttributesSettings',
+        :'sandbox' => :'Boolean',
         :'key' => :'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 = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewApplication` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::NewApplication`. 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.has_key?(:'name')
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'description')
+      if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
-      if attributes.has_key?(:'timezone')
+      if attributes.key?(:'timezone')
         self.timezone = attributes[:'timezone']
       end
 
-      if attributes.has_key?(:'currency')
+      if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
       end
 
-      if attributes.has_key?(:'caseSensitivity')
-        self.case_sensitivity = attributes[:'caseSensitivity']
+      if attributes.key?(:'case_sensitivity')
+        self.case_sensitivity = attributes[:'case_sensitivity']
       end
 
-      if attributes.has_key?(:'attributes')
+      if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
 
-      if attributes.has_key?(:'limits')
+      if attributes.key?(:'limits')
         if (value = attributes[:'limits']).is_a?(Array)
           self.limits = value
         end
       end
 
-      if attributes.has_key?(:'attributesSettings')
-        self.attributes_settings = attributes[:'attributesSettings']
+      if attributes.key?(:'campaign_priority')
+        self.campaign_priority = attributes[:'campaign_priority']
+      end
+
+      if attributes.key?(:'exclusive_campaigns_strategy')
+        self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
+      end
+
+      if attributes.key?(:'default_discount_scope')
+        self.default_discount_scope = attributes[:'default_discount_scope']
+      end
+
+      if attributes.key?(:'enable_cascading_discounts')
+        self.enable_cascading_discounts = attributes[:'enable_cascading_discounts']
+      end
+
+      if attributes.key?(:'enable_flattened_cart_items')
+        self.enable_flattened_cart_items = attributes[:'enable_flattened_cart_items']
+      end
+
+      if attributes.key?(:'attributes_settings')
+        self.attributes_settings = attributes[:'attributes_settings']
       end
 
-      if attributes.has_key?(:'key')
+      if attributes.key?(:'sandbox')
+        self.sandbox = attributes[:'sandbox']
+      end
+
+      if attributes.key?(:'key')
         self.key = attributes[:'key']
       end
     end
@@ -168,16 +235,9 @@ module TalonOne
         invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 1.')
       end
 
-      if !@key.nil? && @key.to_s.length > 16
-        invalid_properties.push('invalid value for "key", the character length must be smaller than or equal to 16.')
-      end
-
-      if !@key.nil? && @key.to_s.length < 16
-        invalid_properties.push('invalid value for "key", the character length must be great than or equal to 16.')
-      end
-
-      if !@key.nil? && @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
-        invalid_properties.push('invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.')
+      pattern = Regexp.new(/^[a-fA-F0-9]{16}$/)
+      if !@key.nil? && @key !~ pattern
+        invalid_properties.push("invalid value for \"key\", must conform to the pattern #{pattern}.")
       end
 
       invalid_properties
@@ -192,10 +252,14 @@ module TalonOne
       return false if @timezone.to_s.length < 1
       return false if @currency.nil?
       return false if @currency.to_s.length < 1
-      case_sensitivity_validator = EnumAttributeValidator.new('String', ['sensitive', 'insensitive-uppercase', 'insensitive-lowercase'])
+      case_sensitivity_validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"])
       return false unless case_sensitivity_validator.valid?(@case_sensitivity)
-      return false if !@key.nil? && @key.to_s.length > 16
-      return false if !@key.nil? && @key.to_s.length < 16
+      campaign_priority_validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"])
+      return false unless campaign_priority_validator.valid?(@campaign_priority)
+      exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
+      return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
+      default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
+      return false unless default_discount_scope_validator.valid?(@default_discount_scope)
       return false if !@key.nil? && @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
       true
     end
@@ -245,26 +309,49 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] case_sensitivity Object to be assigned
     def case_sensitivity=(case_sensitivity)
-      validator = EnumAttributeValidator.new('String', ['sensitive', 'insensitive-uppercase', 'insensitive-lowercase'])
+      validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"])
       unless validator.valid?(case_sensitivity)
-        fail ArgumentError, 'invalid value for "case_sensitivity", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"case_sensitivity\", must be one of #{validator.allowable_values}."
       end
       @case_sensitivity = case_sensitivity
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] key Value to be assigned
-    def key=(key)
-      if !key.nil? && key.to_s.length > 16
-        fail ArgumentError, 'invalid value for "key", the character length must be smaller than or equal to 16.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_priority Object to be assigned
+    def campaign_priority=(campaign_priority)
+      validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"])
+      unless validator.valid?(campaign_priority)
+        fail ArgumentError, "invalid value for \"campaign_priority\", must be one of #{validator.allowable_values}."
       end
+      @campaign_priority = campaign_priority
+    end
 
-      if !key.nil? && key.to_s.length < 16
-        fail ArgumentError, 'invalid value for "key", the character length must be great than or equal to 16.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] exclusive_campaigns_strategy Object to be assigned
+    def exclusive_campaigns_strategy=(exclusive_campaigns_strategy)
+      validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
+      unless validator.valid?(exclusive_campaigns_strategy)
+        fail ArgumentError, "invalid value for \"exclusive_campaigns_strategy\", must be one of #{validator.allowable_values}."
       end
+      @exclusive_campaigns_strategy = exclusive_campaigns_strategy
+    end
 
-      if !key.nil? && key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
-        fail ArgumentError, 'invalid value for "key", must conform to the pattern /^[a-fA-F0-9]{16}$/.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] default_discount_scope Object to be assigned
+    def default_discount_scope=(default_discount_scope)
+      validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
+      unless validator.valid?(default_discount_scope)
+        fail ArgumentError, "invalid value for \"default_discount_scope\", must be one of #{validator.allowable_values}."
+      end
+      @default_discount_scope = default_discount_scope
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      pattern = Regexp.new(/^[a-fA-F0-9]{16}$/)
+      if !key.nil? && key !~ pattern
+        fail ArgumentError, "invalid value for \"key\", must conform to the pattern #{pattern}."
       end
 
       @key = key
@@ -282,7 +369,13 @@ module TalonOne
           case_sensitivity == o.case_sensitivity &&
           attributes == o.attributes &&
           limits == o.limits &&
+          campaign_priority == o.campaign_priority &&
+          exclusive_campaigns_strategy == o.exclusive_campaigns_strategy &&
+          default_discount_scope == o.default_discount_scope &&
+          enable_cascading_discounts == o.enable_cascading_discounts &&
+          enable_flattened_cart_items == o.enable_flattened_cart_items &&
           attributes_settings == o.attributes_settings &&
+          sandbox == o.sandbox &&
           key == o.key
     end
 
@@ -293,9 +386,16 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [name, description, timezone, currency, case_sensitivity, attributes, limits, attributes_settings, key].hash
+      [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, key].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
@@ -303,9 +403,9 @@ module TalonOne
     # @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|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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) })
@@ -334,7 +434,7 @@ module TalonOne
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -355,8 +455,7 @@ module TalonOne
           end
         end
       else # model
-        temp_model = TalonOne.const_get(type).new
-        temp_model.build_from_hash(value)
+        TalonOne.const_get(type).build_from_hash(value)
       end
     end
 
@@ -378,7 +477,11 @@ module TalonOne
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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