talon_one 6.0.0 → 8.0.0

data/lib/talon_one/models/loyalty_program.rb

@@ -13,9 +13,9 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # A Loyalty Program
   class LoyaltyProgram
-    # The ID of loyalty program. Internal ID of this entity.
+    # The ID of loyalty program.
     attr_accessor :id
 
     # The time this entity was created.
@@ -62,6 +62,9 @@ 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. - `unlimited`: Allows negative balance without any limit. 
+    attr_accessor :return_policy
+
     # The ID of the Talon.One account that owns this program.
     attr_accessor :account_id
 
@@ -133,6 +136,7 @@ module TalonOne
         :'tiers_expire_in' => :'tiersExpireIn',
         :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
         :'card_code_settings' => :'cardCodeSettings',
+        :'return_policy' => :'returnPolicy',
         :'account_id' => :'accountID',
         :'name' => :'name',
         :'tiers' => :'tiers',
@@ -165,6 +169,7 @@ module TalonOne
         :'tiers_expire_in' => :'String',
         :'tiers_downgrade_policy' => :'String',
         :'card_code_settings' => :'CodeGeneratorSettings',
+        :'return_policy' => :'String',
         :'account_id' => :'Integer',
         :'name' => :'String',
         :'tiers' => :'Array<LoyaltyTier>',
@@ -265,6 +270,10 @@ module TalonOne
         self.card_code_settings = attributes[:'card_code_settings']
       end
 
+      if attributes.key?(:'return_policy')
+        self.return_policy = attributes[:'return_policy']
+      end
+
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -402,6 +411,8 @@ 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", "unlimited"])
+      return false unless return_policy_validator.valid?(@return_policy)
       return false if @account_id.nil?
       return false if @name.nil?
       return false if @timezone.nil?
@@ -450,6 +461,16 @@ module TalonOne
       @tiers_downgrade_policy = tiers_downgrade_policy
     end
 
+    # 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", "unlimited"])
+      unless validator.valid?(return_policy)
+        fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
+      end
+      @return_policy = return_policy
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] timezone Value to be assigned
     def timezone=(timezone)
@@ -485,6 +506,7 @@ module TalonOne
           tiers_expire_in == o.tiers_expire_in &&
           tiers_downgrade_policy == o.tiers_downgrade_policy &&
           card_code_settings == o.card_code_settings &&
+          return_policy == o.return_policy &&
           account_id == o.account_id &&
           name == o.name &&
           tiers == o.tiers &&
@@ -506,7 +528,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, 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, account_id, name, tiers, timezone, card_based, can_update_tiers, can_update_join_policy, can_update_tier_expiration_policy, can_upgrade_to_advanced_tiers, can_update_subledgers].hash
+      [id, created, 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, account_id, name, tiers, timezone, card_based, can_update_tiers, can_update_join_policy, can_update_tier_expiration_policy, can_upgrade_to_advanced_tiers, can_update_subledgers].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_program_balance.rb

@@ -21,27 +21,35 @@ 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
 
     # **DEPRECATED** Value is shown as 0. 
     attr_accessor :spent_balance
 
-    # Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied.
+    # The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` 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_current_balance
 
-    # Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied.
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'current_balance' => :'currentBalance',
         :'pending_balance' => :'pendingBalance',
+        :'negative_balance' => :'negativeBalance',
         :'expired_balance' => :'expiredBalance',
         :'spent_balance' => :'spentBalance',
         :'tentative_current_balance' => :'tentativeCurrentBalance',
-        :'tentative_pending_balance' => :'tentativePendingBalance'
+        :'tentative_pending_balance' => :'tentativePendingBalance',
+        :'tentative_negative_balance' => :'tentativeNegativeBalance'
       }
     end
 
@@ -50,10 +58,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_pending_balance' => :'Float',
+        :'tentative_negative_balance' => :'Float'
       }
     end
 
@@ -86,6 +96,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
@@ -101,6 +115,10 @@ module TalonOne
       if attributes.key?(:'tentative_pending_balance')
         self.tentative_pending_balance = attributes[:'tentative_pending_balance']
       end
+
+      if attributes.key?(:'tentative_negative_balance')
+        self.tentative_negative_balance = attributes[:'tentative_negative_balance']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,6 +133,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
@@ -127,6 +149,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
 
@@ -135,9 +161,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
 
@@ -148,10 +176,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_pending_balance == o.tentative_pending_balance &&
+          tentative_negative_balance == o.tentative_negative_balance
     end
 
     # @see the `==` method
@@ -163,7 +193,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].hash
+      [current_balance, pending_balance, negative_balance, expired_balance, spent_balance, tentative_current_balance, tentative_pending_balance, tentative_negative_balance].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_program_entity.rb

@@ -17,17 +17,27 @@ module TalonOne
     # The ID of the loyalty program that owns this entity.
     attr_accessor :program_id
 
+    # The integration name of the loyalty program that owns this entity.
+    attr_accessor :program_name
+
+    # The Campaign Manager-displayed name of the loyalty program that owns this entity.
+    attr_accessor :program_title
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'program_id' => :'programID'
+        :'program_id' => :'programID',
+        :'program_name' => :'programName',
+        :'program_title' => :'programTitle'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'program_id' => :'Integer'
+        :'program_id' => :'Integer',
+        :'program_name' => :'String',
+        :'program_title' => :'String'
       }
     end
 
@@ -55,6 +65,14 @@ module TalonOne
       if attributes.key?(:'program_id')
         self.program_id = attributes[:'program_id']
       end
+
+      if attributes.key?(:'program_name')
+        self.program_name = attributes[:'program_name']
+      end
+
+      if attributes.key?(:'program_title')
+        self.program_title = attributes[:'program_title']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +98,9 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          program_id == o.program_id
+          program_id == o.program_id &&
+          program_name == o.program_name &&
+          program_title == o.program_title
     end
 
     # @see the `==` method
@@ -92,7 +112,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [program_id].hash
+      [program_id, program_name, program_title].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_program_transaction.rb

@@ -288,6 +288,11 @@ module TalonOne
         invalid_properties.push('invalid value for "card_identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !@card_identifier.nil? && @card_identifier !~ pattern
+        invalid_properties.push("invalid value for \"card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       if @subledger_id.nil?
         invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
       end
@@ -321,6 +326,7 @@ module TalonOne
       return false if @expiry_date.nil?
       return false if !@customer_profile_id.nil? && @customer_profile_id.to_s.length > 255
       return false if !@card_identifier.nil? && @card_identifier.to_s.length > 108
+      return false if !@card_identifier.nil? && @card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       return false if @subledger_id.nil?
       return false if @subledger_id.to_s.length > 64
       return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
@@ -382,6 +388,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "card_identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !card_identifier.nil? && card_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"card_identifier\", must conform to the pattern #{pattern}."
+      end
+
       @card_identifier = card_identifier
     end
 

data/lib/talon_one/models/loyalty_sub_ledger.rb

@@ -30,6 +30,9 @@ module TalonOne
     # Total amount of points, that expired without ever being spent.
     attr_accessor :total_expired_points
 
+    # Total amount of negative points. This implies that `totalActivePoints` is `0`.
+    attr_accessor :total_negative_points
+
     # List of all events that have happened such as additions, subtractions and expiries.
     attr_accessor :transactions
 
@@ -55,6 +58,7 @@ module TalonOne
         :'total_pending_points' => :'totalPendingPoints',
         :'total_spent_points' => :'totalSpentPoints',
         :'total_expired_points' => :'totalExpiredPoints',
+        :'total_negative_points' => :'totalNegativePoints',
         :'transactions' => :'transactions',
         :'expiring_points' => :'expiringPoints',
         :'active_points' => :'activePoints',
@@ -72,6 +76,7 @@ module TalonOne
         :'total_pending_points' => :'Float',
         :'total_spent_points' => :'Float',
         :'total_expired_points' => :'Float',
+        :'total_negative_points' => :'Float',
         :'transactions' => :'Array<LoyaltyLedgerEntry>',
         :'expiring_points' => :'Array<LoyaltyLedgerEntry>',
         :'active_points' => :'Array<LoyaltyLedgerEntry>',
@@ -122,6 +127,10 @@ module TalonOne
         self.total_expired_points = attributes[:'total_expired_points']
       end
 
+      if attributes.key?(:'total_negative_points')
+        self.total_negative_points = attributes[:'total_negative_points']
+      end
+
       if attributes.key?(:'transactions')
         if (value = attributes[:'transactions']).is_a?(Array)
           self.transactions = value
@@ -181,6 +190,10 @@ module TalonOne
         invalid_properties.push('invalid value for "total_expired_points", total_expired_points cannot be nil.')
       end
 
+      if @total_negative_points.nil?
+        invalid_properties.push('invalid value for "total_negative_points", total_negative_points cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -192,6 +205,7 @@ module TalonOne
       return false if @total_pending_points.nil?
       return false if @total_spent_points.nil?
       return false if @total_expired_points.nil?
+      return false if @total_negative_points.nil?
       true
     end
 
@@ -205,6 +219,7 @@ module TalonOne
           total_pending_points == o.total_pending_points &&
           total_spent_points == o.total_spent_points &&
           total_expired_points == o.total_expired_points &&
+          total_negative_points == o.total_negative_points &&
           transactions == o.transactions &&
           expiring_points == o.expiring_points &&
           active_points == o.active_points &&
@@ -222,7 +237,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total, total_active_points, total_pending_points, total_spent_points, total_expired_points, transactions, expiring_points, active_points, pending_points, expired_points, current_tier].hash
+      [total, total_active_points, total_pending_points, total_spent_points, total_expired_points, total_negative_points, transactions, expiring_points, active_points, pending_points, expired_points, current_tier].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_tier.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # A tier in a loyalty program.
   class LoyaltyTier
     # Internal ID of this entity.
     attr_accessor :id
@@ -24,10 +24,16 @@ module TalonOne
     # The ID of the loyalty program that owns this entity.
     attr_accessor :program_id
 
-    # The name of the tier
+    # The integration name of the loyalty program that owns this entity.
+    attr_accessor :program_name
+
+    # The Campaign Manager-displayed name of the loyalty program that owns this entity.
+    attr_accessor :program_title
+
+    # The name of the tier.
     attr_accessor :name
 
-    # The minimum amount of points required to be eligible for the tier.
+    # The minimum amount of points required to enter the tier.
     attr_accessor :min_points
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,6 +42,8 @@ module TalonOne
         :'id' => :'id',
         :'created' => :'created',
         :'program_id' => :'programID',
+        :'program_name' => :'programName',
+        :'program_title' => :'programTitle',
         :'name' => :'name',
         :'min_points' => :'minPoints'
       }
@@ -47,6 +55,8 @@ module TalonOne
         :'id' => :'Integer',
         :'created' => :'DateTime',
         :'program_id' => :'Integer',
+        :'program_name' => :'String',
+        :'program_title' => :'String',
         :'name' => :'String',
         :'min_points' => :'Float'
       }
@@ -85,6 +95,14 @@ module TalonOne
         self.program_id = attributes[:'program_id']
       end
 
+      if attributes.key?(:'program_name')
+        self.program_name = attributes[:'program_name']
+      end
+
+      if attributes.key?(:'program_title')
+        self.program_title = attributes[:'program_title']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -168,6 +186,8 @@ module TalonOne
           id == o.id &&
           created == o.created &&
           program_id == o.program_id &&
+          program_name == o.program_name &&
+          program_title == o.program_title &&
           name == o.name &&
           min_points == o.min_points
     end
@@ -181,7 +201,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, program_id, name, min_points].hash
+      [id, created, program_id, program_name, program_title, name, min_points].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/management_key.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ManagementKey
     # Name for management key.
     attr_accessor :name
@@ -39,6 +38,9 @@ module TalonOne
     # The date the management key was created.
     attr_accessor :created
 
+    # The management key is disabled (this property is set to `true`) when the user who created the key is disabled or deleted.
+    attr_accessor :disabled
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,7 +51,8 @@ module TalonOne
         :'id' => :'id',
         :'created_by' => :'createdBy',
         :'account_id' => :'accountID',
-        :'created' => :'created'
+        :'created' => :'created',
+        :'disabled' => :'disabled'
       }
     end
 
@@ -63,7 +66,8 @@ module TalonOne
         :'id' => :'Integer',
         :'created_by' => :'Integer',
         :'account_id' => :'Integer',
-        :'created' => :'DateTime'
+        :'created' => :'DateTime',
+        :'disabled' => :'Boolean'
       }
     end
 
@@ -123,6 +127,10 @@ module TalonOne
       if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
+
+      if attributes.key?(:'disabled')
+        self.disabled = attributes[:'disabled']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -185,7 +193,8 @@ module TalonOne
           id == o.id &&
           created_by == o.created_by &&
           account_id == o.account_id &&
-          created == o.created
+          created == o.created &&
+          disabled == o.disabled
     end
 
     # @see the `==` method
@@ -197,7 +206,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, expiry_date, endpoints, allowed_application_ids, id, created_by, account_id, created].hash
+      [name, expiry_date, endpoints, allowed_application_ids, id, created_by, account_id, created, disabled].hash
     end
 
     # Builds the object from hash