talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/update_loyalty_program.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # An updated loyalty program.
   class UpdateLoyaltyProgram
     # The display title for the Loyalty Program.
     attr_accessor :title
@@ -39,17 +39,25 @@ module TalonOne
     # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
     attr_accessor :sandbox
 
-    # The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. 
+    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
+    attr_accessor :program_join_policy
+
+    # The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. 
     attr_accessor :tiers_expiration_policy
 
-    # The amount of time after which the tier expires.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. 
+    # Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. 
+    attr_accessor :tier_cycle_start_date
+
+    # The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. 
     attr_accessor :tiers_expire_in
 
-    # 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 :tiers_downgrade_policy
 
-    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
-    attr_accessor :program_join_policy
+    attr_accessor :card_code_settings
+
+    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. 
+    attr_accessor :return_policy
 
     # The tiers in this loyalty program.
     attr_accessor :tiers
@@ -87,10 +95,13 @@ module TalonOne
         :'allow_subledger' => :'allowSubledger',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'sandbox' => :'sandbox',
+        :'program_join_policy' => :'programJoinPolicy',
         :'tiers_expiration_policy' => :'tiersExpirationPolicy',
+        :'tier_cycle_start_date' => :'tierCycleStartDate',
         :'tiers_expire_in' => :'tiersExpireIn',
         :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
-        :'program_join_policy' => :'programJoinPolicy',
+        :'card_code_settings' => :'cardCodeSettings',
+        :'return_policy' => :'returnPolicy',
         :'tiers' => :'tiers'
       }
     end
@@ -106,10 +117,13 @@ module TalonOne
         :'allow_subledger' => :'Boolean',
         :'users_per_card_limit' => :'Integer',
         :'sandbox' => :'Boolean',
+        :'program_join_policy' => :'String',
         :'tiers_expiration_policy' => :'String',
+        :'tier_cycle_start_date' => :'DateTime',
         :'tiers_expire_in' => :'String',
         :'tiers_downgrade_policy' => :'String',
-        :'program_join_policy' => :'String',
+        :'card_code_settings' => :'CodeGeneratorSettings',
+        :'return_policy' => :'String',
         :'tiers' => :'Array<NewLoyaltyTier>'
       }
     end
@@ -169,10 +183,18 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'program_join_policy')
+        self.program_join_policy = attributes[:'program_join_policy']
+      end
+
       if attributes.key?(:'tiers_expiration_policy')
         self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
       end
 
+      if attributes.key?(:'tier_cycle_start_date')
+        self.tier_cycle_start_date = attributes[:'tier_cycle_start_date']
+      end
+
       if attributes.key?(:'tiers_expire_in')
         self.tiers_expire_in = attributes[:'tiers_expire_in']
       end
@@ -181,8 +203,12 @@ module TalonOne
         self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
       end
 
-      if attributes.key?(:'program_join_policy')
-        self.program_join_policy = attributes[:'program_join_policy']
+      if attributes.key?(:'card_code_settings')
+        self.card_code_settings = attributes[:'card_code_settings']
+      end
+
+      if attributes.key?(:'return_policy')
+        self.return_policy = attributes[:'return_policy']
       end
 
       if attributes.key?(:'tiers')
@@ -207,12 +233,14 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
-      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      return false unless program_join_policy_validator.valid?(@program_join_policy)
+      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
       return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
       tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
       return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
-      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
-      return false unless program_join_policy_validator.valid?(@program_join_policy)
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return false unless return_policy_validator.valid?(@return_policy)
       true
     end
 
@@ -226,10 +254,20 @@ module TalonOne
       @users_per_card_limit = users_per_card_limit
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] program_join_policy Object to be assigned
+    def program_join_policy=(program_join_policy)
+      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      unless validator.valid?(program_join_policy)
+        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
+      end
+      @program_join_policy = program_join_policy
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] tiers_expiration_policy Object to be assigned
     def tiers_expiration_policy=(tiers_expiration_policy)
-      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
       unless validator.valid?(tiers_expiration_policy)
         fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
       end
@@ -247,13 +285,13 @@ module TalonOne
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] program_join_policy Object to be assigned
-    def program_join_policy=(program_join_policy)
-      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
-      unless validator.valid?(program_join_policy)
-        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
+    # @param [Object] return_policy Object to be assigned
+    def return_policy=(return_policy)
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      unless validator.valid?(return_policy)
+        fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
       end
-      @program_join_policy = program_join_policy
+      @return_policy = return_policy
     end
 
     # Checks equality by comparing each attribute.
@@ -269,10 +307,13 @@ module TalonOne
           allow_subledger == o.allow_subledger &&
           users_per_card_limit == o.users_per_card_limit &&
           sandbox == o.sandbox &&
+          program_join_policy == o.program_join_policy &&
           tiers_expiration_policy == o.tiers_expiration_policy &&
+          tier_cycle_start_date == o.tier_cycle_start_date &&
           tiers_expire_in == o.tiers_expire_in &&
           tiers_downgrade_policy == o.tiers_downgrade_policy &&
-          program_join_policy == o.program_join_policy &&
+          card_code_settings == o.card_code_settings &&
+          return_policy == o.return_policy &&
           tiers == o.tiers
     end
 
@@ -285,7 +326,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, tiers].hash
+      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, return_policy, tiers].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_loyalty_program_tier.rb

@@ -0,0 +1,257 @@
+=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
+  # Update a tier in a specified loyalty program.
+  class UpdateLoyaltyProgramTier
+    # The internal ID of the tier.
+    attr_accessor :id
+
+    # The name of the tier.
+    attr_accessor :name
+
+    # The minimum amount of points required to enter the tier.
+    attr_accessor :min_points
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'min_points' => :'minPoints'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'name' => :'String',
+        :'min_points' => :'Float'
+      }
+    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::UpdateLoyaltyProgramTier` 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::UpdateLoyaltyProgramTier`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'min_points')
+        self.min_points = attributes[:'min_points']
+      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 !@min_points.nil? && @min_points > 999999999999.99
+        invalid_properties.push('invalid value for "min_points", must be smaller than or equal to 999999999999.99.')
+      end
+
+      if !@min_points.nil? && @min_points < 0
+        invalid_properties.push('invalid value for "min_points", must be greater than or equal to 0.')
+      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 !@min_points.nil? && @min_points > 999999999999.99
+      return false if !@min_points.nil? && @min_points < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_points Value to be assigned
+    def min_points=(min_points)
+      if !min_points.nil? && min_points > 999999999999.99
+        fail ArgumentError, 'invalid value for "min_points", must be smaller than or equal to 999999999999.99.'
+      end
+
+      if !min_points.nil? && min_points < 0
+        fail ArgumentError, 'invalid value for "min_points", must be greater than or equal to 0.'
+      end
+
+      @min_points = min_points
+    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 &&
+          min_points == o.min_points
+    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, name, min_points].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/update_picklist.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class UpdatePicklist
     # The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string.
     attr_accessor :type

data/lib/talon_one/models/update_referral.rb

@@ -20,7 +20,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. This can be set to 0 for no limit, but any campaign usage limits will still apply. 

data/lib/talon_one/models/update_referral_batch.rb

@@ -23,7 +23,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. This can be set to 0 for no limit, but any campaign usage limits will still apply. 

data/lib/talon_one/models/user.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class User
     # Internal ID of this entity.
     attr_accessor :id
@@ -63,6 +62,9 @@ module TalonOne
     # Timestamp when the user was notified for feed.
     attr_accessor :latest_feed_timestamp
 
+    # Additional user attributes, created and used by external identity providers.
+    attr_accessor :additional_attributes
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -103,7 +105,8 @@ module TalonOne
         :'application_notification_subscriptions' => :'applicationNotificationSubscriptions',
         :'last_signed_in' => :'lastSignedIn',
         :'last_accessed' => :'lastAccessed',
-        :'latest_feed_timestamp' => :'latestFeedTimestamp'
+        :'latest_feed_timestamp' => :'latestFeedTimestamp',
+        :'additional_attributes' => :'additionalAttributes'
       }
     end
 
@@ -125,7 +128,8 @@ module TalonOne
         :'application_notification_subscriptions' => :'Object',
         :'last_signed_in' => :'DateTime',
         :'last_accessed' => :'DateTime',
-        :'latest_feed_timestamp' => :'DateTime'
+        :'latest_feed_timestamp' => :'DateTime',
+        :'additional_attributes' => :'Object'
       }
     end
 
@@ -215,6 +219,10 @@ module TalonOne
       if attributes.key?(:'latest_feed_timestamp')
         self.latest_feed_timestamp = attributes[:'latest_feed_timestamp']
       end
+
+      if attributes.key?(:'additional_attributes')
+        self.additional_attributes = attributes[:'additional_attributes']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -307,7 +315,8 @@ module TalonOne
           application_notification_subscriptions == o.application_notification_subscriptions &&
           last_signed_in == o.last_signed_in &&
           last_accessed == o.last_accessed &&
-          latest_feed_timestamp == o.latest_feed_timestamp
+          latest_feed_timestamp == o.latest_feed_timestamp &&
+          additional_attributes == o.additional_attributes
     end
 
     # @see the `==` method
@@ -319,7 +328,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, modified, email, account_id, name, state, invite_token, is_admin, policy, roles, auth_method, application_notification_subscriptions, last_signed_in, last_accessed, latest_feed_timestamp].hash
+      [id, created, modified, email, account_id, name, state, invite_token, is_admin, policy, roles, auth_method, application_notification_subscriptions, last_signed_in, last_accessed, latest_feed_timestamp, additional_attributes].hash
     end
 
     # Builds the object from hash