talon_one 7.0.0 → 9.0.0

data/lib/talon_one/models/achievement_progress_with_definition.rb

@@ -0,0 +1,490 @@
+=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
+  # The current progress of the customer in the achievement.
+  class AchievementProgressWithDefinition
+    # The status of the achievement.
+    attr_accessor :status
+
+    # The current progress of the customer in the achievement.
+    attr_accessor :progress
+
+    # Timestamp at which the customer started the achievement.
+    attr_accessor :start_date
+
+    # Timestamp at which point the customer completed the achievement.
+    attr_accessor :completion_date
+
+    # Timestamp at which point the achievement ends and resets for the customer.
+    attr_accessor :end_date
+
+    # The internal ID of the achievement.
+    attr_accessor :achievement_id
+
+    # The internal name of the achievement used in API requests. 
+    attr_accessor :name
+
+    # The display name of the achievement in the Campaign Manager.
+    attr_accessor :title
+
+    # The description of the achievement in the Campaign Manager.
+    attr_accessor :description
+
+    # The ID of the campaign the achievement belongs to.
+    attr_accessor :campaign_id
+
+    # The required number of actions or the transactional milestone to complete the achievement.
+    attr_accessor :target
+
+    # The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. 
+    attr_accessor :achievement_recurrence_policy
+
+    # The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. 
+    attr_accessor :achievement_activation_policy
+
+    # The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`.  **Note:** It is an RFC3339 timestamp string. 
+    attr_accessor :achievement_fixed_start_date
+
+    # The achievement's end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It is an RFC3339 timestamp string. 
+    attr_accessor :achievement_end_date
+
+    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
+      {
+        :'status' => :'status',
+        :'progress' => :'progress',
+        :'start_date' => :'startDate',
+        :'completion_date' => :'completionDate',
+        :'end_date' => :'endDate',
+        :'achievement_id' => :'achievementId',
+        :'name' => :'name',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'campaign_id' => :'campaignId',
+        :'target' => :'target',
+        :'achievement_recurrence_policy' => :'achievementRecurrencePolicy',
+        :'achievement_activation_policy' => :'achievementActivationPolicy',
+        :'achievement_fixed_start_date' => :'achievementFixedStartDate',
+        :'achievement_end_date' => :'achievementEndDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'status' => :'String',
+        :'progress' => :'Float',
+        :'start_date' => :'DateTime',
+        :'completion_date' => :'DateTime',
+        :'end_date' => :'DateTime',
+        :'achievement_id' => :'Integer',
+        :'name' => :'String',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'campaign_id' => :'Integer',
+        :'target' => :'Float',
+        :'achievement_recurrence_policy' => :'String',
+        :'achievement_activation_policy' => :'String',
+        :'achievement_fixed_start_date' => :'DateTime',
+        :'achievement_end_date' => :'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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::AchievementProgressWithDefinition` 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::AchievementProgressWithDefinition`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'progress')
+        self.progress = attributes[:'progress']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'completion_date')
+        self.completion_date = attributes[:'completion_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'achievement_id')
+        self.achievement_id = attributes[:'achievement_id']
+      end
+
+      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?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'achievement_recurrence_policy')
+        self.achievement_recurrence_policy = attributes[:'achievement_recurrence_policy']
+      end
+
+      if attributes.key?(:'achievement_activation_policy')
+        self.achievement_activation_policy = attributes[:'achievement_activation_policy']
+      end
+
+      if attributes.key?(:'achievement_fixed_start_date')
+        self.achievement_fixed_start_date = attributes[:'achievement_fixed_start_date']
+      end
+
+      if attributes.key?(:'achievement_end_date')
+        self.achievement_end_date = attributes[:'achievement_end_date']
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @progress.nil?
+        invalid_properties.push('invalid value for "progress", progress cannot be nil.')
+      end
+
+      if @achievement_id.nil?
+        invalid_properties.push('invalid value for "achievement_id", achievement_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 1000
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      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
+
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @achievement_recurrence_policy.nil?
+        invalid_properties.push('invalid value for "achievement_recurrence_policy", achievement_recurrence_policy cannot be nil.')
+      end
+
+      if @achievement_activation_policy.nil?
+        invalid_properties.push('invalid value for "achievement_activation_policy", achievement_activation_policy 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 @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired", "not_started"])
+      return false unless status_validator.valid?(@status)
+      return false if @progress.nil?
+      return false if @achievement_id.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 1000
+      return false if @name.to_s.length < 1
+      return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
+      return false if @title.nil?
+      return false if @description.nil?
+      return false if @campaign_id.nil?
+      return false if @achievement_recurrence_policy.nil?
+      achievement_recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      return false unless achievement_recurrence_policy_validator.valid?(@achievement_recurrence_policy)
+      return false if @achievement_activation_policy.nil?
+      achievement_activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      return false unless achievement_activation_policy_validator.valid?(@achievement_activation_policy)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired", "not_started"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1000.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] achievement_recurrence_policy Object to be assigned
+    def achievement_recurrence_policy=(achievement_recurrence_policy)
+      validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      unless validator.valid?(achievement_recurrence_policy)
+        fail ArgumentError, "invalid value for \"achievement_recurrence_policy\", must be one of #{validator.allowable_values}."
+      end
+      @achievement_recurrence_policy = achievement_recurrence_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] achievement_activation_policy Object to be assigned
+    def achievement_activation_policy=(achievement_activation_policy)
+      validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      unless validator.valid?(achievement_activation_policy)
+        fail ArgumentError, "invalid value for \"achievement_activation_policy\", must be one of #{validator.allowable_values}."
+      end
+      @achievement_activation_policy = achievement_activation_policy
+    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 &&
+          status == o.status &&
+          progress == o.progress &&
+          start_date == o.start_date &&
+          completion_date == o.completion_date &&
+          end_date == o.end_date &&
+          achievement_id == o.achievement_id &&
+          name == o.name &&
+          title == o.title &&
+          description == o.description &&
+          campaign_id == o.campaign_id &&
+          target == o.target &&
+          achievement_recurrence_policy == o.achievement_recurrence_policy &&
+          achievement_activation_policy == o.achievement_activation_policy &&
+          achievement_fixed_start_date == o.achievement_fixed_start_date &&
+          achievement_end_date == o.achievement_end_date
+    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
+      [status, progress, start_date, completion_date, end_date, achievement_id, name, title, description, campaign_id, target, achievement_recurrence_policy, achievement_activation_policy, achievement_fixed_start_date, achievement_end_date].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