talon_one 7.0.0 → 9.0.0

data/lib/talon_one/models/ledger_info.rb

@@ -21,6 +21,9 @@ module TalonOne
     # Sum of pending points.
     attr_accessor :pending_balance
 
+    # Sum of negative points. This implies that `currentBalance` is `0`.
+    attr_accessor :negative_balance
+
     # **DEPRECATED** Value is shown as 0. 
     attr_accessor :expired_balance
 
@@ -33,6 +36,9 @@ module TalonOne
     # The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. 
     attr_accessor :tentative_pending_balance
 
+    # The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. 
+    attr_accessor :tentative_negative_balance
+
     attr_accessor :current_tier
 
     # Points required to move up a tier.
@@ -43,10 +49,12 @@ module TalonOne
       {
         :'current_balance' => :'currentBalance',
         :'pending_balance' => :'pendingBalance',
+        :'negative_balance' => :'negativeBalance',
         :'expired_balance' => :'expiredBalance',
         :'spent_balance' => :'spentBalance',
         :'tentative_current_balance' => :'tentativeCurrentBalance',
         :'tentative_pending_balance' => :'tentativePendingBalance',
+        :'tentative_negative_balance' => :'tentativeNegativeBalance',
         :'current_tier' => :'currentTier',
         :'points_to_next_tier' => :'pointsToNextTier'
       }
@@ -57,10 +65,12 @@ module TalonOne
       {
         :'current_balance' => :'Float',
         :'pending_balance' => :'Float',
+        :'negative_balance' => :'Float',
         :'expired_balance' => :'Float',
         :'spent_balance' => :'Float',
         :'tentative_current_balance' => :'Float',
         :'tentative_pending_balance' => :'Float',
+        :'tentative_negative_balance' => :'Float',
         :'current_tier' => :'Tier',
         :'points_to_next_tier' => :'Float'
       }
@@ -95,6 +105,10 @@ module TalonOne
         self.pending_balance = attributes[:'pending_balance']
       end
 
+      if attributes.key?(:'negative_balance')
+        self.negative_balance = attributes[:'negative_balance']
+      end
+
       if attributes.key?(:'expired_balance')
         self.expired_balance = attributes[:'expired_balance']
       end
@@ -111,6 +125,10 @@ module TalonOne
         self.tentative_pending_balance = attributes[:'tentative_pending_balance']
       end
 
+      if attributes.key?(:'tentative_negative_balance')
+        self.tentative_negative_balance = attributes[:'tentative_negative_balance']
+      end
+
       if attributes.key?(:'current_tier')
         self.current_tier = attributes[:'current_tier']
       end
@@ -132,6 +150,10 @@ module TalonOne
         invalid_properties.push('invalid value for "pending_balance", pending_balance cannot be nil.')
       end
 
+      if @negative_balance.nil?
+        invalid_properties.push('invalid value for "negative_balance", negative_balance cannot be nil.')
+      end
+
       if @expired_balance.nil?
         invalid_properties.push('invalid value for "expired_balance", expired_balance cannot be nil.')
       end
@@ -144,6 +166,10 @@ module TalonOne
         invalid_properties.push('invalid value for "tentative_current_balance", tentative_current_balance cannot be nil.')
       end
 
+      if @tentative_negative_balance.nil?
+        invalid_properties.push('invalid value for "tentative_negative_balance", tentative_negative_balance cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -152,9 +178,11 @@ module TalonOne
     def valid?
       return false if @current_balance.nil?
       return false if @pending_balance.nil?
+      return false if @negative_balance.nil?
       return false if @expired_balance.nil?
       return false if @spent_balance.nil?
       return false if @tentative_current_balance.nil?
+      return false if @tentative_negative_balance.nil?
       true
     end
 
@@ -165,10 +193,12 @@ module TalonOne
       self.class == o.class &&
           current_balance == o.current_balance &&
           pending_balance == o.pending_balance &&
+          negative_balance == o.negative_balance &&
           expired_balance == o.expired_balance &&
           spent_balance == o.spent_balance &&
           tentative_current_balance == o.tentative_current_balance &&
           tentative_pending_balance == o.tentative_pending_balance &&
+          tentative_negative_balance == o.tentative_negative_balance &&
           current_tier == o.current_tier &&
           points_to_next_tier == o.points_to_next_tier
     end
@@ -182,7 +212,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [current_balance, pending_balance, expired_balance, spent_balance, tentative_current_balance, tentative_pending_balance, current_tier, points_to_next_tier].hash
+      [current_balance, pending_balance, negative_balance, expired_balance, spent_balance, tentative_current_balance, tentative_pending_balance, tentative_negative_balance, current_tier, points_to_next_tier].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb

@@ -51,6 +51,8 @@ module TalonOne
     # The name of the rule that triggered this effect.
     attr_accessor :rule_name
 
+    attr_accessor :flags
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -87,7 +89,8 @@ module TalonOne
         :'amount' => :'amount',
         :'id' => :'id',
         :'ruleset_id' => :'rulesetId',
-        :'rule_name' => :'ruleName'
+        :'rule_name' => :'ruleName',
+        :'flags' => :'flags'
       }
     end
 
@@ -105,7 +108,8 @@ module TalonOne
         :'amount' => :'Float',
         :'id' => :'Integer',
         :'ruleset_id' => :'Integer',
-        :'rule_name' => :'String'
+        :'rule_name' => :'String',
+        :'flags' => :'LoyaltyLedgerEntryFlags'
       }
     end
 
@@ -177,6 +181,10 @@ module TalonOne
       if attributes.key?(:'rule_name')
         self.rule_name = attributes[:'rule_name']
       end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -342,7 +350,8 @@ module TalonOne
           amount == o.amount &&
           id == o.id &&
           ruleset_id == o.ruleset_id &&
-          rule_name == o.rule_name
+          rule_name == o.rule_name &&
+          flags == o.flags
     end
 
     # @see the `==` method
@@ -354,7 +363,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created, program_id, customer_session_id, type, name, start_date, expiry_date, subledger_id, amount, id, ruleset_id, rule_name].hash
+      [created, program_id, customer_session_id, type, name, start_date, expiry_date, subledger_id, amount, id, ruleset_id, rule_name, flags].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/limit_counter.rb

@@ -17,7 +17,7 @@ module TalonOne
     # The ID of the campaign that owns this entity.
     attr_accessor :campaign_id
 
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # The ID of the account that owns this entity.

data/lib/talon_one/models/loyalty_balance.rb

@@ -27,13 +27,17 @@ module TalonOne
     # Total amount of points awarded but never redeemed. They cannot be used anymore.
     attr_accessor :expired_points
 
+    # Total amount of negative points. This implies that `activePoints` is `0`.
+    attr_accessor :negative_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'active_points' => :'activePoints',
         :'pending_points' => :'pendingPoints',
         :'spent_points' => :'spentPoints',
-        :'expired_points' => :'expiredPoints'
+        :'expired_points' => :'expiredPoints',
+        :'negative_points' => :'negativePoints'
       }
     end
 
@@ -43,7 +47,8 @@ module TalonOne
         :'active_points' => :'Float',
         :'pending_points' => :'Float',
         :'spent_points' => :'Float',
-        :'expired_points' => :'Float'
+        :'expired_points' => :'Float',
+        :'negative_points' => :'Float'
       }
     end
 
@@ -83,6 +88,10 @@ module TalonOne
       if attributes.key?(:'expired_points')
         self.expired_points = attributes[:'expired_points']
       end
+
+      if attributes.key?(:'negative_points')
+        self.negative_points = attributes[:'negative_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +115,8 @@ module TalonOne
           active_points == o.active_points &&
           pending_points == o.pending_points &&
           spent_points == o.spent_points &&
-          expired_points == o.expired_points
+          expired_points == o.expired_points &&
+          negative_points == o.negative_points
     end
 
     # @see the `==` method
@@ -118,7 +128,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [active_points, pending_points, spent_points, expired_points].hash
+      [active_points, pending_points, spent_points, expired_points, negative_points].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_balance_with_tier.rb

@@ -27,6 +27,9 @@ module TalonOne
     # Total amount of points awarded but never redeemed. They cannot be used anymore.
     attr_accessor :expired_points
 
+    # Total amount of negative points. This implies that `activePoints` is `0`.
+    attr_accessor :negative_points
+
     attr_accessor :current_tier
 
     attr_accessor :projected_tier
@@ -44,6 +47,7 @@ module TalonOne
         :'pending_points' => :'pendingPoints',
         :'spent_points' => :'spentPoints',
         :'expired_points' => :'expiredPoints',
+        :'negative_points' => :'negativePoints',
         :'current_tier' => :'currentTier',
         :'projected_tier' => :'projectedTier',
         :'points_to_next_tier' => :'pointsToNextTier',
@@ -58,6 +62,7 @@ module TalonOne
         :'pending_points' => :'Float',
         :'spent_points' => :'Float',
         :'expired_points' => :'Float',
+        :'negative_points' => :'Float',
         :'current_tier' => :'Tier',
         :'projected_tier' => :'ProjectedTier',
         :'points_to_next_tier' => :'Float',
@@ -102,6 +107,10 @@ module TalonOne
         self.expired_points = attributes[:'expired_points']
       end
 
+      if attributes.key?(:'negative_points')
+        self.negative_points = attributes[:'negative_points']
+      end
+
       if attributes.key?(:'current_tier')
         self.current_tier = attributes[:'current_tier']
       end
@@ -141,6 +150,7 @@ module TalonOne
           pending_points == o.pending_points &&
           spent_points == o.spent_points &&
           expired_points == o.expired_points &&
+          negative_points == o.negative_points &&
           current_tier == o.current_tier &&
           projected_tier == o.projected_tier &&
           points_to_next_tier == o.points_to_next_tier &&
@@ -156,7 +166,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [active_points, pending_points, spent_points, expired_points, current_tier, projected_tier, points_to_next_tier, next_tier_name].hash
+      [active_points, pending_points, spent_points, expired_points, negative_points, current_tier, projected_tier, points_to_next_tier, next_tier_name].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_ledger_entry.rb

@@ -48,6 +48,8 @@ module TalonOne
     # Indicates if the entry belongs to the archived session.
     attr_accessor :archived
 
+    attr_accessor :flags
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +66,8 @@ module TalonOne
         :'name' => :'name',
         :'sub_ledger_id' => :'subLedgerID',
         :'user_id' => :'userID',
-        :'archived' => :'archived'
+        :'archived' => :'archived',
+        :'flags' => :'flags'
       }
     end
 
@@ -84,7 +87,8 @@ module TalonOne
         :'name' => :'String',
         :'sub_ledger_id' => :'String',
         :'user_id' => :'Integer',
-        :'archived' => :'Boolean'
+        :'archived' => :'Boolean',
+        :'flags' => :'LoyaltyLedgerEntryFlags'
       }
     end
 
@@ -164,6 +168,10 @@ module TalonOne
       if attributes.key?(:'archived')
         self.archived = attributes[:'archived']
       end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -227,7 +235,8 @@ module TalonOne
           name == o.name &&
           sub_ledger_id == o.sub_ledger_id &&
           user_id == o.user_id &&
-          archived == o.archived
+          archived == o.archived &&
+          flags == o.flags
     end
 
     # @see the `==` method
@@ -239,7 +248,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created, program_id, customer_profile_id, card_id, customer_session_id, event_id, type, amount, start_date, expiry_date, name, sub_ledger_id, user_id, archived].hash
+      [created, program_id, customer_profile_id, card_id, customer_session_id, event_id, type, amount, start_date, expiry_date, name, sub_ledger_id, user_id, archived, flags].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_ledger_entry_flags.rb

@@ -0,0 +1,208 @@
+=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
+  # A map of flags providing additional details about the entry.
+  class LoyaltyLedgerEntryFlags
+    # Set to true if the entry creates negative balance.
+    attr_accessor :creates_negative_balance
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'creates_negative_balance' => :'createsNegativeBalance'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'creates_negative_balance' => :'Boolean'
+      }
+    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::LoyaltyLedgerEntryFlags` 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::LoyaltyLedgerEntryFlags`. 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?(:'creates_negative_balance')
+        self.creates_negative_balance = attributes[:'creates_negative_balance']
+      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
+      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?
+      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 &&
+          creates_negative_balance == o.creates_negative_balance
+    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
+      [creates_negative_balance].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/loyalty_program.rb

@@ -62,7 +62,7 @@ module TalonOne
 
     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. 
+    # 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. - `unlimited`: Allows negative balance without any limit. 
     attr_accessor :return_policy
 
     # The ID of the Talon.One account that owns this program.
@@ -411,7 +411,7 @@ module TalonOne
       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)
-      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       return false unless return_policy_validator.valid?(@return_policy)
       return false if @account_id.nil?
       return false if @name.nil?
@@ -464,7 +464,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] return_policy Object to be assigned
     def return_policy=(return_policy)
-      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       unless validator.valid?(return_policy)
         fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
       end