talon_one 0.1.3 → 1.1.0

data/lib/talon_one/models/customer_profile_search_query.rb

@@ -0,0 +1,206 @@
+=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 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  class CustomerProfileSearchQuery
+    # Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes
+    attr_accessor :attributes
+
+    attr_accessor :integration_i_ds
+
+    attr_accessor :profile_i_ds
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'integration_i_ds' => :'integrationIDs',
+        :'profile_i_ds' => :'profileIDs'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'attributes' => :'Object',
+        :'integration_i_ds' => :'Array<String>',
+        :'profile_i_ds' => :'Array<Integer>'
+      }
+    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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.has_key?(:'integrationIDs')
+        if (value = attributes[:'integrationIDs']).is_a?(Array)
+          self.integration_i_ds = value
+        end
+      end
+
+      if attributes.has_key?(:'profileIDs')
+        if (value = attributes[:'profileIDs']).is_a?(Array)
+          self.profile_i_ds = 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 &&
+          attributes == o.attributes &&
+          integration_i_ds == o.integration_i_ds &&
+          profile_i_ds == o.profile_i_ds
+    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
+      [attributes, integration_i_ds, profile_i_ds].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 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 = TalonOne.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/talon_one/models/customer_session.rb

@@ -0,0 +1,407 @@
+=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 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class CustomerSession
+    # The ID used for this entity in the application system.
+    attr_accessor :integration_id
+
+    # The exact moment this entity was created.
+    attr_accessor :created
+
+    # The ID of the application that owns this entity.
+    attr_accessor :application_id
+
+    # ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID.
+    attr_accessor :profile_id
+
+    # Any coupon code entered.
+    attr_accessor :coupon
+
+    # Any referral code entered.
+    attr_accessor :referral
+
+    # Indicates the current state of the session. All sessions must start in the \"open\" state, after which valid transitions are...  1. open -> closed 2. open -> cancelled 3. closed -> cancelled 
+    attr_accessor :state
+
+    # Serialized JSON representation.
+    attr_accessor :cart_items
+
+    # Identifiers for the customer, this can be used for limits on values such as device ID.
+    attr_accessor :identifiers
+
+    # The total sum of the cart in one session.
+    attr_accessor :total
+
+    # A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. 
+    attr_accessor :attributes
+
+    # Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions.
+    attr_accessor :first_session
+
+    # A map of labelled discount values, values will be in the same currency as the application associated with the session.
+    attr_accessor :discounts
+
+    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
+      {
+        :'integration_id' => :'integrationId',
+        :'created' => :'created',
+        :'application_id' => :'applicationId',
+        :'profile_id' => :'profileId',
+        :'coupon' => :'coupon',
+        :'referral' => :'referral',
+        :'state' => :'state',
+        :'cart_items' => :'cartItems',
+        :'identifiers' => :'identifiers',
+        :'total' => :'total',
+        :'attributes' => :'attributes',
+        :'first_session' => :'firstSession',
+        :'discounts' => :'discounts'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'integration_id' => :'String',
+        :'created' => :'DateTime',
+        :'application_id' => :'Integer',
+        :'profile_id' => :'String',
+        :'coupon' => :'String',
+        :'referral' => :'String',
+        :'state' => :'String',
+        :'cart_items' => :'Array<CartItem>',
+        :'identifiers' => :'Array<String>',
+        :'total' => :'Float',
+        :'attributes' => :'Object',
+        :'first_session' => :'BOOLEAN',
+        :'discounts' => :'Hash<String, Float>'
+      }
+    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?(:'integrationId')
+        self.integration_id = attributes[:'integrationId']
+      end
+
+      if attributes.has_key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.has_key?(:'applicationId')
+        self.application_id = attributes[:'applicationId']
+      end
+
+      if attributes.has_key?(:'profileId')
+        self.profile_id = attributes[:'profileId']
+      end
+
+      if attributes.has_key?(:'coupon')
+        self.coupon = attributes[:'coupon']
+      end
+
+      if attributes.has_key?(:'referral')
+        self.referral = attributes[:'referral']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = 'open'
+      end
+
+      if attributes.has_key?(:'cartItems')
+        if (value = attributes[:'cartItems']).is_a?(Array)
+          self.cart_items = value
+        end
+      end
+
+      if attributes.has_key?(:'identifiers')
+        if (value = attributes[:'identifiers']).is_a?(Array)
+          self.identifiers = value
+        end
+      end
+
+      if attributes.has_key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.has_key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.has_key?(:'firstSession')
+        self.first_session = attributes[:'firstSession']
+      end
+
+      if attributes.has_key?(:'discounts')
+        if (value = attributes[:'discounts']).is_a?(Hash)
+          self.discounts = 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 @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @profile_id.nil?
+        invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
+      end
+
+      if @coupon.nil?
+        invalid_properties.push('invalid value for "coupon", coupon cannot be nil.')
+      end
+
+      if @referral.nil?
+        invalid_properties.push('invalid value for "referral", referral cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @cart_items.nil?
+        invalid_properties.push('invalid value for "cart_items", cart_items cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
+      end
+
+      if @first_session.nil?
+        invalid_properties.push('invalid value for "first_session", first_session cannot be nil.')
+      end
+
+      if @discounts.nil?
+        invalid_properties.push('invalid value for "discounts", discounts 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 @integration_id.nil?
+      return false if @created.nil?
+      return false if @application_id.nil?
+      return false if @profile_id.nil?
+      return false if @coupon.nil?
+      return false if @referral.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ['open', 'closed', 'cancelled'])
+      return false unless state_validator.valid?(@state)
+      return false if @cart_items.nil?
+      return false if @total.nil?
+      return false if @attributes.nil?
+      return false if @first_session.nil?
+      return false if @discounts.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ['open', 'closed', 'cancelled'])
+      unless validator.valid?(state)
+        fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
+      end
+      @state = state
+    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 &&
+          integration_id == o.integration_id &&
+          created == o.created &&
+          application_id == o.application_id &&
+          profile_id == o.profile_id &&
+          coupon == o.coupon &&
+          referral == o.referral &&
+          state == o.state &&
+          cart_items == o.cart_items &&
+          identifiers == o.identifiers &&
+          total == o.total &&
+          attributes == o.attributes &&
+          first_session == o.first_session &&
+          discounts == o.discounts
+    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
+      [integration_id, created, application_id, profile_id, coupon, referral, state, cart_items, identifiers, total, attributes, first_session, discounts].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 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 = TalonOne.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