talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/summary_campaign_store_budget.rb

@@ -0,0 +1,280 @@
+=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 SummaryCampaignStoreBudget
+    attr_accessor :action
+
+    attr_accessor :period
+
+    attr_accessor :store_count
+
+    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
+      {
+        :'action' => :'action',
+        :'period' => :'period',
+        :'store_count' => :'storeCount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'action' => :'String',
+        :'period' => :'String',
+        :'store_count' => :'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::SummaryCampaignStoreBudget` 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::SummaryCampaignStoreBudget`. 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?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      end
+
+      if attributes.key?(:'store_count')
+        self.store_count = attributes[:'store_count']
+      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 @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @store_count.nil?
+        invalid_properties.push('invalid value for "store_count", store_count 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 @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["redeemCoupon", "redeemReferral", "setDiscount", "setDiscountEffect", "createCoupon", "createReferral", "createLoyaltyPoints", "redeemLoyaltyPoints", "customEffect", "createLoyaltyPointsEffect", "redeemLoyaltyPointsEffect", "callApi", "awardGiveaway", "addFreeItemEffect", "reserveCoupon"])
+      return false unless action_validator.valid?(@action)
+      period_validator = EnumAttributeValidator.new('String', ["overall", "daily", "weekly", "monthly", "yearly"])
+      return false unless period_validator.valid?(@period)
+      return false if @store_count.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["redeemCoupon", "redeemReferral", "setDiscount", "setDiscountEffect", "createCoupon", "createReferral", "createLoyaltyPoints", "redeemLoyaltyPoints", "customEffect", "createLoyaltyPointsEffect", "redeemLoyaltyPointsEffect", "callApi", "awardGiveaway", "addFreeItemEffect", "reserveCoupon"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
+      end
+      @action = action
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] period Object to be assigned
+    def period=(period)
+      validator = EnumAttributeValidator.new('String', ["overall", "daily", "weekly", "monthly", "yearly"])
+      unless validator.valid?(period)
+        fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}."
+      end
+      @period = period
+    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 &&
+          action == o.action &&
+          period == o.period &&
+          store_count == o.store_count
+    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
+      [action, period, store_count].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

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class TalangAttribute
     # The name of the entity of the attribute.
     attr_accessor :entity

data/lib/talon_one/models/template_arg_def.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class TemplateArgDef
     # The type of value this argument expects.
     attr_accessor :type
@@ -27,6 +26,9 @@ module TalonOne
     # Arbitrary metadata that may be used to render an input for this argument.
     attr_accessor :ui
 
+    # The identifier for the associated value within the JSON object.
+    attr_accessor :key
+
     # ID of the picklist linked to a template.
     attr_accessor :picklist_id
 
@@ -62,6 +64,7 @@ module TalonOne
         :'description' => :'description',
         :'title' => :'title',
         :'ui' => :'ui',
+        :'key' => :'key',
         :'picklist_id' => :'picklistID',
         :'restricted_by_picklist' => :'restrictedByPicklist'
       }
@@ -74,6 +77,7 @@ module TalonOne
         :'description' => :'String',
         :'title' => :'String',
         :'ui' => :'Object',
+        :'key' => :'String',
         :'picklist_id' => :'Integer',
         :'restricted_by_picklist' => :'Boolean'
       }
@@ -116,6 +120,10 @@ module TalonOne
         self.ui = attributes[:'ui']
       end
 
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+
       if attributes.key?(:'picklist_id')
         self.picklist_id = attributes[:'picklist_id']
       end
@@ -198,6 +206,7 @@ module TalonOne
           description == o.description &&
           title == o.title &&
           ui == o.ui &&
+          key == o.key &&
           picklist_id == o.picklist_id &&
           restricted_by_picklist == o.restricted_by_picklist
     end
@@ -211,7 +220,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, description, title, ui, picklist_id, restricted_by_picklist].hash
+      [type, description, title, ui, key, picklist_id, restricted_by_picklist].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/template_def.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class TemplateDef
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/template_limit_config.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class TemplateLimitConfig
     # The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` 
     attr_accessor :action

data/lib/talon_one/models/tier.rb

@@ -20,10 +20,13 @@ module TalonOne
     # The name of the tier.
     attr_accessor :name
 
+    # Date and time when the customer moved to this tier. This value uses the loyalty program's time zone setting.
+    attr_accessor :start_date
+
     # 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. 
+    # The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. 
     attr_accessor :downgrade_policy
 
     class EnumAttributeValidator
@@ -53,6 +56,7 @@ module TalonOne
       {
         :'id' => :'id',
         :'name' => :'name',
+        :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
         :'downgrade_policy' => :'downgradePolicy'
       }
@@ -63,6 +67,7 @@ module TalonOne
       {
         :'id' => :'Integer',
         :'name' => :'String',
+        :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
         :'downgrade_policy' => :'String'
       }
@@ -97,6 +102,10 @@ module TalonOne
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
       if attributes.key?(:'expiry_date')
         self.expiry_date = attributes[:'expiry_date']
       end
@@ -148,6 +157,7 @@ module TalonOne
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          start_date == o.start_date &&
           expiry_date == o.expiry_date &&
           downgrade_policy == o.downgrade_policy
     end
@@ -161,7 +171,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, expiry_date, downgrade_policy].hash
+      [id, name, start_date, expiry_date, downgrade_policy].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/transfer_loyalty_card.rb

@@ -17,17 +17,22 @@ module TalonOne
     # The alphanumeric identifier of the loyalty card. 
     attr_accessor :new_card_identifier
 
+    # Reason for transferring and blocking the loyalty card. 
+    attr_accessor :block_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'new_card_identifier' => :'newCardIdentifier'
+        :'new_card_identifier' => :'newCardIdentifier',
+        :'block_reason' => :'blockReason'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'new_card_identifier' => :'String'
+        :'new_card_identifier' => :'String',
+        :'block_reason' => :'String'
       }
     end
 
@@ -55,6 +60,10 @@ module TalonOne
       if attributes.key?(:'new_card_identifier')
         self.new_card_identifier = attributes[:'new_card_identifier']
       end
+
+      if attributes.key?(:'block_reason')
+        self.block_reason = attributes[:'block_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -69,6 +78,11 @@ module TalonOne
         invalid_properties.push('invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if @new_card_identifier !~ pattern
+        invalid_properties.push("invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -77,6 +91,7 @@ module TalonOne
     def valid?
       return false if @new_card_identifier.nil?
       return false if @new_card_identifier.to_s.length > 108
+      return false if @new_card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       true
     end
 
@@ -91,6 +106,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if new_card_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}."
+      end
+
       @new_card_identifier = new_card_identifier
     end
 
@@ -99,7 +119,8 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          new_card_identifier == o.new_card_identifier
+          new_card_identifier == o.new_card_identifier &&
+          block_reason == o.block_reason
     end
 
     # @see the `==` method
@@ -111,7 +132,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [new_card_identifier].hash
+      [new_card_identifier, block_reason].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_achievement.rb

@@ -31,6 +31,40 @@ module TalonOne
 
     attr_accessor :period_end_override
 
+    # 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 :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 :activation_policy
+
+    # The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string. 
+    attr_accessor :fixed_start_date
+
+    # The achievement's end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It must be an RFC3339 timestamp string. 
+    attr_accessor :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
       {
@@ -39,7 +73,11 @@ module TalonOne
         :'description' => :'description',
         :'target' => :'target',
         :'period' => :'period',
-        :'period_end_override' => :'periodEndOverride'
+        :'period_end_override' => :'periodEndOverride',
+        :'recurrence_policy' => :'recurrencePolicy',
+        :'activation_policy' => :'activationPolicy',
+        :'fixed_start_date' => :'fixedStartDate',
+        :'end_date' => :'endDate'
       }
     end
 
@@ -51,7 +89,11 @@ module TalonOne
         :'description' => :'String',
         :'target' => :'Float',
         :'period' => :'String',
-        :'period_end_override' => :'TimePoint'
+        :'period_end_override' => :'TimePoint',
+        :'recurrence_policy' => :'String',
+        :'activation_policy' => :'String',
+        :'fixed_start_date' => :'DateTime',
+        :'end_date' => :'DateTime'
       }
     end
 
@@ -99,6 +141,22 @@ module TalonOne
       if attributes.key?(:'period_end_override')
         self.period_end_override = attributes[:'period_end_override']
       end
+
+      if attributes.key?(:'recurrence_policy')
+        self.recurrence_policy = attributes[:'recurrence_policy']
+      end
+
+      if attributes.key?(:'activation_policy')
+        self.activation_policy = attributes[:'activation_policy']
+      end
+
+      if attributes.key?(:'fixed_start_date')
+        self.fixed_start_date = attributes[:'fixed_start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -127,6 +185,10 @@ module TalonOne
       return false if !@name.nil? && @name.to_s.length > 1000
       return false if !@name.nil? && @name.to_s.length < 1
       return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
+      recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      return false unless recurrence_policy_validator.valid?(@recurrence_policy)
+      activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      return false unless activation_policy_validator.valid?(@activation_policy)
       true
     end
 
@@ -149,6 +211,26 @@ module TalonOne
       @name = name
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] recurrence_policy Object to be assigned
+    def recurrence_policy=(recurrence_policy)
+      validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      unless validator.valid?(recurrence_policy)
+        fail ArgumentError, "invalid value for \"recurrence_policy\", must be one of #{validator.allowable_values}."
+      end
+      @recurrence_policy = recurrence_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] activation_policy Object to be assigned
+    def activation_policy=(activation_policy)
+      validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      unless validator.valid?(activation_policy)
+        fail ArgumentError, "invalid value for \"activation_policy\", must be one of #{validator.allowable_values}."
+      end
+      @activation_policy = activation_policy
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -159,7 +241,11 @@ module TalonOne
           description == o.description &&
           target == o.target &&
           period == o.period &&
-          period_end_override == o.period_end_override
+          period_end_override == o.period_end_override &&
+          recurrence_policy == o.recurrence_policy &&
+          activation_policy == o.activation_policy &&
+          fixed_start_date == o.fixed_start_date &&
+          end_date == o.end_date
     end
 
     # @see the `==` method
@@ -171,7 +257,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, title, description, target, period, period_end_override].hash
+      [name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date].hash
     end
 
     # Builds the object from hash