talon_one 1.4.0 → 2.3.0

data/lib/talon_one/models/rule_failure_reason.rb

@@ -0,0 +1,343 @@
+=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
+  # Details about why a rule failed
+  class RuleFailureReason
+    # The ID of the campaign that contains the rule that failed
+    attr_accessor :campaign_id
+
+    # The name of the campaign that contains the rule that failed
+    attr_accessor :campaign_name
+
+    # The ID of the ruleset that contains the rule that failed
+    attr_accessor :ruleset_id
+
+    # The ID of the coupon that was being evaluated at the time of the rule failure
+    attr_accessor :coupon_id
+
+    # The value of the coupon that was being evaluated at the time of the rule failure
+    attr_accessor :coupon_value
+
+    # The ID of the referral that was being evaluated at the time of the rule failure
+    attr_accessor :referral_id
+
+    # The value of the referral that was being evaluated at the time of the rule failure
+    attr_accessor :referral_value
+
+    # The index of the rule that failed within the ruleset
+    attr_accessor :rule_index
+
+    # The name of the rule that failed within the ruleset
+    attr_accessor :rule_name
+
+    # The index of the condition that failed
+    attr_accessor :condition_index
+
+    # The index of the effect that failed
+    attr_accessor :effect_index
+
+    # More details about the failure
+    attr_accessor :details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignID',
+        :'campaign_name' => :'campaignName',
+        :'ruleset_id' => :'rulesetID',
+        :'coupon_id' => :'couponID',
+        :'coupon_value' => :'couponValue',
+        :'referral_id' => :'referralID',
+        :'referral_value' => :'referralValue',
+        :'rule_index' => :'ruleIndex',
+        :'rule_name' => :'ruleName',
+        :'condition_index' => :'conditionIndex',
+        :'effect_index' => :'effectIndex',
+        :'details' => :'details'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'campaign_id' => :'Integer',
+        :'campaign_name' => :'String',
+        :'ruleset_id' => :'Integer',
+        :'coupon_id' => :'Integer',
+        :'coupon_value' => :'String',
+        :'referral_id' => :'Integer',
+        :'referral_value' => :'String',
+        :'rule_index' => :'Integer',
+        :'rule_name' => :'String',
+        :'condition_index' => :'Integer',
+        :'effect_index' => :'Integer',
+        :'details' => :'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::RuleFailureReason` 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::RuleFailureReason`. 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?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'campaign_name')
+        self.campaign_name = attributes[:'campaign_name']
+      end
+
+      if attributes.key?(:'ruleset_id')
+        self.ruleset_id = attributes[:'ruleset_id']
+      end
+
+      if attributes.key?(:'coupon_id')
+        self.coupon_id = attributes[:'coupon_id']
+      end
+
+      if attributes.key?(:'coupon_value')
+        self.coupon_value = attributes[:'coupon_value']
+      end
+
+      if attributes.key?(:'referral_id')
+        self.referral_id = attributes[:'referral_id']
+      end
+
+      if attributes.key?(:'referral_value')
+        self.referral_value = attributes[:'referral_value']
+      end
+
+      if attributes.key?(:'rule_index')
+        self.rule_index = attributes[:'rule_index']
+      end
+
+      if attributes.key?(:'rule_name')
+        self.rule_name = attributes[:'rule_name']
+      end
+
+      if attributes.key?(:'condition_index')
+        self.condition_index = attributes[:'condition_index']
+      end
+
+      if attributes.key?(:'effect_index')
+        self.effect_index = attributes[:'effect_index']
+      end
+
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
+      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 @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @campaign_name.nil?
+        invalid_properties.push('invalid value for "campaign_name", campaign_name cannot be nil.')
+      end
+
+      if @ruleset_id.nil?
+        invalid_properties.push('invalid value for "ruleset_id", ruleset_id cannot be nil.')
+      end
+
+      if @rule_index.nil?
+        invalid_properties.push('invalid value for "rule_index", rule_index cannot be nil.')
+      end
+
+      if @rule_name.nil?
+        invalid_properties.push('invalid value for "rule_name", rule_name 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 @campaign_id.nil?
+      return false if @campaign_name.nil?
+      return false if @ruleset_id.nil?
+      return false if @rule_index.nil?
+      return false if @rule_name.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 &&
+          campaign_id == o.campaign_id &&
+          campaign_name == o.campaign_name &&
+          ruleset_id == o.ruleset_id &&
+          coupon_id == o.coupon_id &&
+          coupon_value == o.coupon_value &&
+          referral_id == o.referral_id &&
+          referral_value == o.referral_value &&
+          rule_index == o.rule_index &&
+          rule_name == o.rule_name &&
+          condition_index == o.condition_index &&
+          effect_index == o.effect_index &&
+          details == o.details
+    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
+      [campaign_id, campaign_name, ruleset_id, coupon_id, coupon_value, referral_id, referral_value, rule_index, rule_name, condition_index, effect_index, details].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/ruleset.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
 
@@ -58,7 +58,7 @@ module TalonOne
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'id' => :'Integer',
         :'created' => :'DateTime',
@@ -67,57 +67,70 @@ module TalonOne
         :'rules' => :'Array<Rule>',
         :'bindings' => :'Array<Binding>',
         :'rb_version' => :'String',
-        :'activate' => :'BOOLEAN',
+        :'activate' => :'Boolean',
         :'activated_at' => :'DateTime'
       }
     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::Ruleset` 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::Ruleset`. 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?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'created')
+      if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
 
-      if attributes.has_key?(:'campaignId')
-        self.campaign_id = attributes[:'campaignId']
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
       end
 
-      if attributes.has_key?(:'userId')
-        self.user_id = attributes[:'userId']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
       end
 
-      if attributes.has_key?(:'rules')
+      if attributes.key?(:'rules')
         if (value = attributes[:'rules']).is_a?(Array)
           self.rules = value
         end
       end
 
-      if attributes.has_key?(:'bindings')
+      if attributes.key?(:'bindings')
         if (value = attributes[:'bindings']).is_a?(Array)
           self.bindings = value
         end
       end
 
-      if attributes.has_key?(:'rbVersion')
-        self.rb_version = attributes[:'rbVersion']
+      if attributes.key?(:'rb_version')
+        self.rb_version = attributes[:'rb_version']
       end
 
-      if attributes.has_key?(:'activate')
+      if attributes.key?(:'activate')
         self.activate = attributes[:'activate']
       end
 
-      if attributes.has_key?(:'activatedAt')
-        self.activated_at = attributes[:'activatedAt']
+      if attributes.key?(:'activated_at')
+        self.activated_at = attributes[:'activated_at']
       end
     end
 
@@ -187,19 +200,26 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, created, campaign_id, user_id, rules, bindings, rb_version, activate, activated_at].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.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) })
@@ -228,7 +248,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
@@ -249,8 +269,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
 
@@ -272,7 +291,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