talon_one 6.0.0 → 7.0.0

data/lib/talon_one/models/loyalty_card_batch.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class LoyaltyCardBatch
     # Number of loyalty cards in the batch.
     attr_accessor :number_of_cards
@@ -24,6 +23,8 @@ module TalonOne
     # Status of the loyalty cards in the batch.
     attr_accessor :status
 
+    attr_accessor :card_code_settings
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +52,8 @@ module TalonOne
       {
         :'number_of_cards' => :'numberOfCards',
         :'batch_id' => :'batchId',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'card_code_settings' => :'cardCodeSettings'
       }
     end
 
@@ -60,7 +62,8 @@ module TalonOne
       {
         :'number_of_cards' => :'Integer',
         :'batch_id' => :'String',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'card_code_settings' => :'CodeGeneratorSettings'
       }
     end
 
@@ -98,6 +101,10 @@ module TalonOne
       else
         self.status = 'active'
       end
+
+      if attributes.key?(:'card_code_settings')
+        self.card_code_settings = attributes[:'card_code_settings']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -172,7 +179,8 @@ module TalonOne
       self.class == o.class &&
           number_of_cards == o.number_of_cards &&
           batch_id == o.batch_id &&
-          status == o.status
+          status == o.status &&
+          card_code_settings == o.card_code_settings
     end
 
     # @see the `==` method
@@ -184,7 +192,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [number_of_cards, batch_id, status].hash
+      [number_of_cards, batch_id, status, card_code_settings].hash
     end
 
     # Builds the object from hash

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. 
+    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"])
+      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"])
+      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

@@ -27,10 +27,10 @@ module TalonOne
     # **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
 
     # Attribute mapping from ruby-style variable name to JSON key.

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_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

data/lib/talon_one/models/message_log_entry.rb

@@ -30,6 +30,12 @@ module TalonOne
     # The name of the notification.
     attr_accessor :notification_name
 
+    # ID of the webhook.
+    attr_accessor :webhook_id
+
+    # The name of the webhook.
+    attr_accessor :webhook_name
+
     attr_accessor :request
 
     attr_accessor :response
@@ -37,15 +43,21 @@ module TalonOne
     # Timestamp when the log entry was created.
     attr_accessor :created_at
 
-    # The entity type the notification is related to. 
+    # The entity type the log is related to. 
     attr_accessor :entity_type
 
+    # The target URL of the request.
+    attr_accessor :url
+
     # Identifier of the Application.
     attr_accessor :application_id
 
     # Identifier of the loyalty program.
     attr_accessor :loyalty_program_id
 
+    # Identifier of the campaign.
+    attr_accessor :campaign_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -76,12 +88,16 @@ module TalonOne
         :'change_type' => :'changeType',
         :'notification_id' => :'notificationId',
         :'notification_name' => :'notificationName',
+        :'webhook_id' => :'webhookId',
+        :'webhook_name' => :'webhookName',
         :'request' => :'request',
         :'response' => :'response',
         :'created_at' => :'createdAt',
         :'entity_type' => :'entityType',
+        :'url' => :'url',
         :'application_id' => :'applicationId',
-        :'loyalty_program_id' => :'loyaltyProgramId'
+        :'loyalty_program_id' => :'loyaltyProgramId',
+        :'campaign_id' => :'campaignId'
       }
     end
 
@@ -93,12 +109,16 @@ module TalonOne
         :'change_type' => :'String',
         :'notification_id' => :'Integer',
         :'notification_name' => :'String',
+        :'webhook_id' => :'Integer',
+        :'webhook_name' => :'String',
         :'request' => :'MessageLogRequest',
         :'response' => :'MessageLogResponse',
         :'created_at' => :'DateTime',
         :'entity_type' => :'String',
+        :'url' => :'String',
         :'application_id' => :'Integer',
-        :'loyalty_program_id' => :'Integer'
+        :'loyalty_program_id' => :'Integer',
+        :'campaign_id' => :'Integer'
       }
     end
 
@@ -143,6 +163,14 @@ module TalonOne
         self.notification_name = attributes[:'notification_name']
       end
 
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      end
+
       if attributes.key?(:'request')
         self.request = attributes[:'request']
       end
@@ -159,6 +187,10 @@ module TalonOne
         self.entity_type = attributes[:'entity_type']
       end
 
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
       if attributes.key?(:'application_id')
         self.application_id = attributes[:'application_id']
       end
@@ -166,6 +198,10 @@ module TalonOne
       if attributes.key?(:'loyalty_program_id')
         self.loyalty_program_id = attributes[:'loyalty_program_id']
       end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -184,6 +220,10 @@ module TalonOne
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
       if !@application_id.nil? && @application_id < 1
         invalid_properties.push('invalid value for "application_id", must be greater than or equal to 1.')
       end
@@ -192,6 +232,10 @@ module TalonOne
         invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
       end
 
+      if !@campaign_id.nil? && @campaign_id < 1
+        invalid_properties.push('invalid value for "campaign_id", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -201,17 +245,19 @@ module TalonOne
       return false if @id.nil?
       return false if @service.nil?
       return false if @created_at.nil?
-      entity_type_validator = EnumAttributeValidator.new('String', ["application", "loyalty_program"])
+      return false if @entity_type.nil?
+      entity_type_validator = EnumAttributeValidator.new('String', ["application", "loyalty_program", "webhook"])
       return false unless entity_type_validator.valid?(@entity_type)
       return false if !@application_id.nil? && @application_id < 1
       return false if !@loyalty_program_id.nil? && @loyalty_program_id < 1
+      return false if !@campaign_id.nil? && @campaign_id < 1
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] entity_type Object to be assigned
     def entity_type=(entity_type)
-      validator = EnumAttributeValidator.new('String', ["application", "loyalty_program"])
+      validator = EnumAttributeValidator.new('String', ["application", "loyalty_program", "webhook"])
       unless validator.valid?(entity_type)
         fail ArgumentError, "invalid value for \"entity_type\", must be one of #{validator.allowable_values}."
       end
@@ -238,6 +284,16 @@ module TalonOne
       @loyalty_program_id = loyalty_program_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      if !campaign_id.nil? && campaign_id < 1
+        fail ArgumentError, 'invalid value for "campaign_id", must be greater than or equal to 1.'
+      end
+
+      @campaign_id = campaign_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -248,12 +304,16 @@ module TalonOne
           change_type == o.change_type &&
           notification_id == o.notification_id &&
           notification_name == o.notification_name &&
+          webhook_id == o.webhook_id &&
+          webhook_name == o.webhook_name &&
           request == o.request &&
           response == o.response &&
           created_at == o.created_at &&
           entity_type == o.entity_type &&
+          url == o.url &&
           application_id == o.application_id &&
-          loyalty_program_id == o.loyalty_program_id
+          loyalty_program_id == o.loyalty_program_id &&
+          campaign_id == o.campaign_id
     end
 
     # @see the `==` method
@@ -265,7 +325,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, service, change_type, notification_id, notification_name, request, response, created_at, entity_type, application_id, loyalty_program_id].hash
+      [id, service, change_type, notification_id, notification_name, webhook_id, webhook_name, request, response, created_at, entity_type, url, application_id, loyalty_program_id, campaign_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/model_return.rb

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

data/lib/talon_one/models/multiple_audiences_item.rb

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

data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. 
   class MultipleCustomerProfileIntegrationRequestItem
     # Arbitrary properties associated with this item.
     attr_accessor :attributes

data/lib/talon_one/models/new_account_sign_up.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAccountSignUp
     # The email address associated with the user profile.
     attr_accessor :email

data/lib/talon_one/models/new_additional_cost.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAdditionalCost
     # The internal name used in API requests.
     attr_accessor :name

data/lib/talon_one/models/new_application_api_key.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewApplicationAPIKey
     # Title of the API key.
     attr_accessor :title

data/lib/talon_one/models/new_attribute.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAttribute
     # The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type.
     attr_accessor :entity

data/lib/talon_one/models/new_audience.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAudience
     # The human-friendly display name for this audience.
     attr_accessor :name

data/lib/talon_one/models/new_base_notification.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewBaseNotification
     # Indicates which notification properties to apply.
     attr_accessor :policy

data/lib/talon_one/models/new_campaign.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewCampaign
     # A user-facing name for this campaign.
     attr_accessor :name

data/lib/talon_one/models/new_campaign_collection.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewCampaignCollection
     # A short description of the purpose of this collection.
     attr_accessor :description

data/lib/talon_one/models/new_campaign_set.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewCampaignSet
     # The ID of the application that owns this entity.
     attr_accessor :application_id