talon_one 1.2.0 → 2.1.1

data/lib/talon_one/models/effect.rb

@@ -0,0 +1,287 @@
+=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.2.3
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class Effect
+    # The ID of the campaign that triggered this effect
+    attr_accessor :campaign_id
+
+    # The ID of the ruleset that was active in the campaign when this effect was triggered
+    attr_accessor :ruleset_id
+
+    # The position of the rule that triggered this effect within the ruleset
+    attr_accessor :rule_index
+
+    # The name of the rule that triggered this effect
+    attr_accessor :rule_name
+
+    # The type of effect that was triggered
+    attr_accessor :effect_type
+
+    attr_accessor :props
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignId',
+        :'ruleset_id' => :'rulesetId',
+        :'rule_index' => :'ruleIndex',
+        :'rule_name' => :'ruleName',
+        :'effect_type' => :'effectType',
+        :'props' => :'props'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'campaign_id' => :'Integer',
+        :'ruleset_id' => :'Integer',
+        :'rule_index' => :'Integer',
+        :'rule_name' => :'String',
+        :'effect_type' => :'String',
+        :'props' => :'Object'
+      }
+    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::Effect` 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::Effect`. 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?(:'ruleset_id')
+        self.ruleset_id = attributes[:'ruleset_id']
+      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?(:'effect_type')
+        self.effect_type = attributes[:'effect_type']
+      end
+
+      if attributes.key?(:'props')
+        self.props = attributes[:'props']
+      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 @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
+
+      if @effect_type.nil?
+        invalid_properties.push('invalid value for "effect_type", effect_type cannot be nil.')
+      end
+
+      if @props.nil?
+        invalid_properties.push('invalid value for "props", props 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 @ruleset_id.nil?
+      return false if @rule_index.nil?
+      return false if @rule_name.nil?
+      return false if @effect_type.nil?
+      return false if @props.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 &&
+          ruleset_id == o.ruleset_id &&
+          rule_index == o.rule_index &&
+          rule_name == o.rule_name &&
+          effect_type == o.effect_type &&
+          props == o.props
+    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, ruleset_id, rule_index, rule_name, effect_type, props].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/effect_entity.rb

@@ -0,0 +1,273 @@
+=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.2.3
+
+=end
+
+require 'date'
+
+module TalonOne
+  # Definition of all properties that are present on all effects, independent of their type
+  class EffectEntity
+    # The ID of the campaign that triggered this effect
+    attr_accessor :campaign_id
+
+    # The ID of the ruleset that was active in the campaign when this effect was triggered
+    attr_accessor :ruleset_id
+
+    # The position of the rule that triggered this effect within the ruleset
+    attr_accessor :rule_index
+
+    # The name of the rule that triggered this effect
+    attr_accessor :rule_name
+
+    # The type of effect that was triggered
+    attr_accessor :effect_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignId',
+        :'ruleset_id' => :'rulesetId',
+        :'rule_index' => :'ruleIndex',
+        :'rule_name' => :'ruleName',
+        :'effect_type' => :'effectType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'campaign_id' => :'Integer',
+        :'ruleset_id' => :'Integer',
+        :'rule_index' => :'Integer',
+        :'rule_name' => :'String',
+        :'effect_type' => :'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::EffectEntity` 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::EffectEntity`. 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?(:'ruleset_id')
+        self.ruleset_id = attributes[:'ruleset_id']
+      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?(:'effect_type')
+        self.effect_type = attributes[:'effect_type']
+      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 @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
+
+      if @effect_type.nil?
+        invalid_properties.push('invalid value for "effect_type", effect_type 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 @ruleset_id.nil?
+      return false if @rule_index.nil?
+      return false if @rule_name.nil?
+      return false if @effect_type.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 &&
+          ruleset_id == o.ruleset_id &&
+          rule_index == o.rule_index &&
+          rule_name == o.rule_name &&
+          effect_type == o.effect_type
+    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, ruleset_id, rule_index, rule_name, effect_type].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