talon_one 4.0.0 → 6.0.0

data/lib/talon_one/models/projected_tier.rb

@@ -0,0 +1,232 @@
+=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 ProjectedTier
+    # The active points of the customer when their current tier expires.
+    attr_accessor :projected_active_points
+
+    # The number of points the customer needs to stay in the current tier.  **Note**: This is included in the response when the customer is projected to be downgraded. 
+    attr_accessor :stay_in_tier_points
+
+    # The name of the tier the user will enter once their current tier expires.
+    attr_accessor :projected_tier_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'projected_active_points' => :'projectedActivePoints',
+        :'stay_in_tier_points' => :'stayInTierPoints',
+        :'projected_tier_name' => :'projectedTierName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'projected_active_points' => :'Float',
+        :'stay_in_tier_points' => :'Float',
+        :'projected_tier_name' => :'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::ProjectedTier` 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::ProjectedTier`. 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?(:'projected_active_points')
+        self.projected_active_points = attributes[:'projected_active_points']
+      end
+
+      if attributes.key?(:'stay_in_tier_points')
+        self.stay_in_tier_points = attributes[:'stay_in_tier_points']
+      end
+
+      if attributes.key?(:'projected_tier_name')
+        self.projected_tier_name = attributes[:'projected_tier_name']
+      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 @projected_active_points.nil?
+        invalid_properties.push('invalid value for "projected_active_points", projected_active_points 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 @projected_active_points.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 &&
+          projected_active_points == o.projected_active_points &&
+          stay_in_tier_points == o.stay_in_tier_points &&
+          projected_tier_name == o.projected_tier_name
+    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
+      [projected_active_points, stay_in_tier_points, projected_tier_name].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/referral.rb

@@ -24,7 +24,7 @@ module TalonOne
     # Timestamp at which point the referral code becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
+    # Expiration date of the referral code. Referral never expires if this is omitted.
     attr_accessor :expiry_date
 
     # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 

data/lib/talon_one/models/referral_constraints.rb

@@ -17,7 +17,7 @@ module TalonOne
     # Timestamp at which point the referral code becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
+    # Expiration date of the referral code. Referral never expires if this is omitted.
     attr_accessor :expiry_date
 
     # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 

data/lib/talon_one/models/reject_coupon_effect_props.rb

@@ -30,6 +30,9 @@ module TalonOne
     # More details about the failure.
     attr_accessor :details
 
+    # The reason why the campaign was not applied.
+    attr_accessor :campaign_exclusion_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +40,8 @@ module TalonOne
         :'rejection_reason' => :'rejectionReason',
         :'condition_index' => :'conditionIndex',
         :'effect_index' => :'effectIndex',
-        :'details' => :'details'
+        :'details' => :'details',
+        :'campaign_exclusion_reason' => :'campaignExclusionReason'
       }
     end
 
@@ -48,7 +52,8 @@ module TalonOne
         :'rejection_reason' => :'String',
         :'condition_index' => :'Integer',
         :'effect_index' => :'Integer',
-        :'details' => :'String'
+        :'details' => :'String',
+        :'campaign_exclusion_reason' => :'String'
       }
     end
 
@@ -92,6 +97,10 @@ module TalonOne
       if attributes.key?(:'details')
         self.details = attributes[:'details']
       end
+
+      if attributes.key?(:'campaign_exclusion_reason')
+        self.campaign_exclusion_reason = attributes[:'campaign_exclusion_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +135,8 @@ module TalonOne
           rejection_reason == o.rejection_reason &&
           condition_index == o.condition_index &&
           effect_index == o.effect_index &&
-          details == o.details
+          details == o.details &&
+          campaign_exclusion_reason == o.campaign_exclusion_reason
     end
 
     # @see the `==` method
@@ -138,7 +148,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, rejection_reason, condition_index, effect_index, details].hash
+      [value, rejection_reason, condition_index, effect_index, details, campaign_exclusion_reason].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/reject_referral_effect_props.rb

@@ -30,6 +30,9 @@ module TalonOne
     # More details about the failure.
     attr_accessor :details
 
+    # The reason why the campaign was not applied.
+    attr_accessor :campaign_exclusion_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +40,8 @@ module TalonOne
         :'rejection_reason' => :'rejectionReason',
         :'condition_index' => :'conditionIndex',
         :'effect_index' => :'effectIndex',
-        :'details' => :'details'
+        :'details' => :'details',
+        :'campaign_exclusion_reason' => :'campaignExclusionReason'
       }
     end
 
@@ -48,7 +52,8 @@ module TalonOne
         :'rejection_reason' => :'String',
         :'condition_index' => :'Integer',
         :'effect_index' => :'Integer',
-        :'details' => :'String'
+        :'details' => :'String',
+        :'campaign_exclusion_reason' => :'String'
       }
     end
 
@@ -92,6 +97,10 @@ module TalonOne
       if attributes.key?(:'details')
         self.details = attributes[:'details']
       end
+
+      if attributes.key?(:'campaign_exclusion_reason')
+        self.campaign_exclusion_reason = attributes[:'campaign_exclusion_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +135,8 @@ module TalonOne
           rejection_reason == o.rejection_reason &&
           condition_index == o.condition_index &&
           effect_index == o.effect_index &&
-          details == o.details
+          details == o.details &&
+          campaign_exclusion_reason == o.campaign_exclusion_reason
     end
 
     # @see the `==` method
@@ -138,7 +148,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, rejection_reason, condition_index, effect_index, details].hash
+      [value, rejection_reason, condition_index, effect_index, details, campaign_exclusion_reason].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/revision.rb

@@ -0,0 +1,319 @@
+=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 Revision
+    # Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints.
+    attr_accessor :id
+
+    attr_accessor :activate_at
+
+    attr_accessor :account_id
+
+    attr_accessor :application_id
+
+    attr_accessor :campaign_id
+
+    attr_accessor :created
+
+    attr_accessor :created_by
+
+    attr_accessor :activated_at
+
+    attr_accessor :activated_by
+
+    attr_accessor :current_version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'activate_at' => :'activateAt',
+        :'account_id' => :'accountId',
+        :'application_id' => :'applicationId',
+        :'campaign_id' => :'campaignId',
+        :'created' => :'created',
+        :'created_by' => :'createdBy',
+        :'activated_at' => :'activatedAt',
+        :'activated_by' => :'activatedBy',
+        :'current_version' => :'currentVersion'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'activate_at' => :'DateTime',
+        :'account_id' => :'Integer',
+        :'application_id' => :'Integer',
+        :'campaign_id' => :'Integer',
+        :'created' => :'DateTime',
+        :'created_by' => :'Integer',
+        :'activated_at' => :'DateTime',
+        :'activated_by' => :'Integer',
+        :'current_version' => :'RevisionVersion'
+      }
+    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::Revision` 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::Revision`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'activate_at')
+        self.activate_at = attributes[:'activate_at']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'activated_at')
+        self.activated_at = attributes[:'activated_at']
+      end
+
+      if attributes.key?(:'activated_by')
+        self.activated_by = attributes[:'activated_by']
+      end
+
+      if attributes.key?(:'current_version')
+        self.current_version = attributes[:'current_version']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @created_by.nil?
+        invalid_properties.push('invalid value for "created_by", created_by 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 @id.nil?
+      return false if @account_id.nil?
+      return false if @application_id.nil?
+      return false if @campaign_id.nil?
+      return false if @created.nil?
+      return false if @created_by.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 &&
+          id == o.id &&
+          activate_at == o.activate_at &&
+          account_id == o.account_id &&
+          application_id == o.application_id &&
+          campaign_id == o.campaign_id &&
+          created == o.created &&
+          created_by == o.created_by &&
+          activated_at == o.activated_at &&
+          activated_by == o.activated_by &&
+          current_version == o.current_version
+    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
+      [id, activate_at, account_id, application_id, campaign_id, created, created_by, activated_at, activated_by, current_version].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