talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/store.rb

@@ -0,0 +1,381 @@
+=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 Store
+    # Internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created. The time this entity was created.
+    attr_accessor :created
+
+    # The name of the store.
+    attr_accessor :name
+
+    # The description of the store.
+    attr_accessor :description
+
+    # The attributes of the store.
+    attr_accessor :attributes
+
+    # The integration ID of the store. You choose this ID when you create a store.  **Note**: You cannot edit the `integrationId` after the store has been created. 
+    attr_accessor :integration_id
+
+    # The ID of the application that owns this entity.
+    attr_accessor :application_id
+
+    # Timestamp of the most recent update on this entity.
+    attr_accessor :updated
+
+    # A list of IDs of the campaigns that are linked with current store.
+    attr_accessor :linked_campaign_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'attributes' => :'attributes',
+        :'integration_id' => :'integrationId',
+        :'application_id' => :'applicationId',
+        :'updated' => :'updated',
+        :'linked_campaign_ids' => :'linkedCampaignIds'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'attributes' => :'Object',
+        :'integration_id' => :'String',
+        :'application_id' => :'Integer',
+        :'updated' => :'DateTime',
+        :'linked_campaign_ids' => :'Array<Integer>'
+      }
+    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::Store` 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::Store`. 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?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      end
+
+      if attributes.key?(:'linked_campaign_ids')
+        if (value = attributes[:'linked_campaign_ids']).is_a?(Array)
+          self.linked_campaign_ids = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      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
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @integration_id.to_s.length < 1
+        invalid_properties.push('invalid value for "integration_id", the character length must be great than or equal to 1.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @updated.nil?
+        invalid_properties.push('invalid value for "updated", updated 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 @created.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 200
+      return false if @name.to_s.length < 1
+      return false if @description.nil?
+      return false if @integration_id.nil?
+      return false if @integration_id.to_s.length > 1000
+      return false if @integration_id.to_s.length < 1
+      return false if @application_id.nil?
+      return false if @updated.nil?
+      true
+    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 > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] integration_id Value to be assigned
+    def integration_id=(integration_id)
+      if integration_id.nil?
+        fail ArgumentError, 'integration_id cannot be nil'
+      end
+
+      if integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      if integration_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "integration_id", the character length must be great than or equal to 1.'
+      end
+
+      @integration_id = integration_id
+    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 &&
+          created == o.created &&
+          name == o.name &&
+          description == o.description &&
+          attributes == o.attributes &&
+          integration_id == o.integration_id &&
+          application_id == o.application_id &&
+          updated == o.updated &&
+          linked_campaign_ids == o.linked_campaign_ids
+    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, created, name, description, attributes, integration_id, application_id, updated, linked_campaign_ids].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/talang_attribute.rb

@@ -186,7 +186,7 @@ module TalonOne
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      entity_validator = EnumAttributeValidator.new('String', ["AdvocateProfile", "Account", "Application", "AwardedGiveaway", "Bundle", "Campaign", "CartItem", "Coupon", "CustomerProfile", "CustomerSession", "Event", "Item", "Loyalty", "Profile", "Giveaway", "Referral", "Session"])
+      entity_validator = EnumAttributeValidator.new('String', ["AdvocateProfile", "Account", "Application", "AwardedGiveaway", "Bundle", "Campaign", "CartItem", "Coupon", "CustomerProfile", "CustomerSession", "Event", "Item", "Loyalty", "Profile", "Giveaway", "Referral", "Session", "Store", "Achievements"])
       return false unless entity_validator.valid?(@entity)
       return false if @name.nil?
       return false if @type.nil?
@@ -201,7 +201,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] entity Object to be assigned
     def entity=(entity)
-      validator = EnumAttributeValidator.new('String', ["AdvocateProfile", "Account", "Application", "AwardedGiveaway", "Bundle", "Campaign", "CartItem", "Coupon", "CustomerProfile", "CustomerSession", "Event", "Item", "Loyalty", "Profile", "Giveaway", "Referral", "Session"])
+      validator = EnumAttributeValidator.new('String', ["AdvocateProfile", "Account", "Application", "AwardedGiveaway", "Bundle", "Campaign", "CartItem", "Coupon", "CustomerProfile", "CustomerSession", "Event", "Item", "Loyalty", "Profile", "Giveaway", "Referral", "Session", "Store", "Achievements"])
       unless validator.valid?(entity)
         fail ArgumentError, "invalid value for \"entity\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/template_arg_def.rb

@@ -137,10 +137,6 @@ module TalonOne
         invalid_properties.push('invalid value for "type", the character length must be great than or equal to 1.')
       end
 
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
-      end
-
       if @title.nil?
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
@@ -163,7 +159,6 @@ module TalonOne
       type_validator = EnumAttributeValidator.new('String', ["string", "boolean", "number", "time", "(list string)"])
       return false unless type_validator.valid?(@type)
       return false if @type.to_s.length < 1
-      return false if @description.nil?
       return false if @title.nil?
       return false if @title.to_s.length < 1
       return false if @ui.nil?

data/lib/talon_one/models/tier.rb

@@ -20,11 +20,41 @@ module TalonOne
     # The name of the tier.
     attr_accessor :name
 
+    # Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone).
+    attr_accessor :expiry_date
+
+    # Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. 
+    attr_accessor :downgrade_policy
+
+    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
       {
         :'id' => :'id',
-        :'name' => :'name'
+        :'name' => :'name',
+        :'expiry_date' => :'expiryDate',
+        :'downgrade_policy' => :'downgradePolicy'
       }
     end
 
@@ -32,7 +62,9 @@ module TalonOne
     def self.openapi_types
       {
         :'id' => :'Integer',
-        :'name' => :'String'
+        :'name' => :'String',
+        :'expiry_date' => :'DateTime',
+        :'downgrade_policy' => :'String'
       }
     end
 
@@ -64,6 +96,14 @@ module TalonOne
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'downgrade_policy')
+        self.downgrade_policy = attributes[:'downgrade_policy']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -86,16 +126,30 @@ module TalonOne
     def valid?
       return false if @id.nil?
       return false if @name.nil?
+      downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      return false unless downgrade_policy_validator.valid?(@downgrade_policy)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] downgrade_policy Object to be assigned
+    def downgrade_policy=(downgrade_policy)
+      validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      unless validator.valid?(downgrade_policy)
+        fail ArgumentError, "invalid value for \"downgrade_policy\", must be one of #{validator.allowable_values}."
+      end
+      @downgrade_policy = downgrade_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 &&
           id == o.id &&
-          name == o.name
+          name == o.name &&
+          expiry_date == o.expiry_date &&
+          downgrade_policy == o.downgrade_policy
     end
 
     # @see the `==` method
@@ -107,7 +161,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name].hash
+      [id, name, expiry_date, downgrade_policy].hash
     end
 
     # Builds the object from hash