talon_one 6.0.0 → 8.0.0

data/lib/talon_one/models/template_arg_def.rb

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

data/lib/talon_one/models/template_def.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class TemplateDef
     # Internal ID of this entity.
     attr_accessor :id
@@ -21,7 +20,7 @@ module TalonOne
     # The time this entity was created.
     attr_accessor :created
 
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # Campaigner-friendly name for the template that will be shown in the rule editor.

data/lib/talon_one/models/template_limit_config.rb

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

data/lib/talon_one/models/tier_downgrade_notification_policy.rb

@@ -20,11 +20,15 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'batching_enabled' => :'batchingEnabled'
+        :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize'
       }
     end
 
@@ -32,7 +36,8 @@ module TalonOne
     def self.openapi_types
       {
         :'name' => :'String',
-        :'batching_enabled' => :'Boolean'
+        :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer'
       }
     end
 
@@ -66,6 +71,10 @@ module TalonOne
       else
         self.batching_enabled = true
       end
+
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +120,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          batching_enabled == o.batching_enabled
+          batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size
     end
 
     # @see the `==` method
@@ -123,7 +133,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled].hash
+      [name, batching_enabled, batch_size].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/tier_upgrade_notification_policy.rb

@@ -20,11 +20,15 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'batching_enabled' => :'batchingEnabled'
+        :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize'
       }
     end
 
@@ -32,7 +36,8 @@ module TalonOne
     def self.openapi_types
       {
         :'name' => :'String',
-        :'batching_enabled' => :'Boolean'
+        :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer'
       }
     end
 
@@ -66,6 +71,10 @@ module TalonOne
       else
         self.batching_enabled = true
       end
+
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +120,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          batching_enabled == o.batching_enabled
+          batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size
     end
 
     # @see the `==` method
@@ -123,7 +133,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled].hash
+      [name, batching_enabled, batch_size].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb

@@ -20,6 +20,9 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     attr_accessor :triggers
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -27,6 +30,7 @@ module TalonOne
       {
         :'name' => :'name',
         :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize',
         :'triggers' => :'triggers'
       }
     end
@@ -36,6 +40,7 @@ module TalonOne
       {
         :'name' => :'String',
         :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer',
         :'triggers' => :'Array<TierWillDowngradeNotificationTrigger>'
       }
     end
@@ -71,6 +76,10 @@ module TalonOne
         self.batching_enabled = true
       end
 
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
+
       if attributes.key?(:'triggers')
         if (value = attributes[:'triggers']).is_a?(Array)
           self.triggers = value
@@ -127,6 +136,7 @@ module TalonOne
       self.class == o.class &&
           name == o.name &&
           batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size &&
           triggers == o.triggers
     end
 
@@ -139,7 +149,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled, triggers].hash
+      [name, batching_enabled, batch_size, triggers].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/transfer_loyalty_card.rb

@@ -78,6 +78,11 @@ module TalonOne
         invalid_properties.push('invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if @new_card_identifier !~ pattern
+        invalid_properties.push("invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -86,6 +91,7 @@ module TalonOne
     def valid?
       return false if @new_card_identifier.nil?
       return false if @new_card_identifier.to_s.length > 108
+      return false if @new_card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       true
     end
 
@@ -100,6 +106,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if new_card_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}."
+      end
+
       @new_card_identifier = new_card_identifier
     end
 

data/lib/talon_one/models/update_achievement.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class UpdateAchievement
-    # The internal name of the achievement used in API requests. 
+    # The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. 
     attr_accessor :name
 
     # The display name for the achievement in the Campaign Manager.
@@ -26,11 +26,45 @@ module TalonOne
     # The required number of actions or the transactional milestone to complete the achievement.
     attr_accessor :target
 
-    # The relative duration after which the achievement ends and resets for a particular customer profile. 
+    # The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** 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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period. 
     attr_accessor :period
 
     attr_accessor :period_end_override
 
+    # The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. 
+    attr_accessor :recurrence_policy
+
+    # The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. 
+    attr_accessor :activation_policy
+
+    # The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string. 
+    attr_accessor :fixed_start_date
+
+    # The achievement's end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It must be an RFC3339 timestamp string. 
+    attr_accessor :end_date
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,7 +73,11 @@ module TalonOne
         :'description' => :'description',
         :'target' => :'target',
         :'period' => :'period',
-        :'period_end_override' => :'periodEndOverride'
+        :'period_end_override' => :'periodEndOverride',
+        :'recurrence_policy' => :'recurrencePolicy',
+        :'activation_policy' => :'activationPolicy',
+        :'fixed_start_date' => :'fixedStartDate',
+        :'end_date' => :'endDate'
       }
     end
 
@@ -51,7 +89,11 @@ module TalonOne
         :'description' => :'String',
         :'target' => :'Float',
         :'period' => :'String',
-        :'period_end_override' => :'TimePoint'
+        :'period_end_override' => :'TimePoint',
+        :'recurrence_policy' => :'String',
+        :'activation_policy' => :'String',
+        :'fixed_start_date' => :'DateTime',
+        :'end_date' => :'DateTime'
       }
     end
 
@@ -99,6 +141,22 @@ module TalonOne
       if attributes.key?(:'period_end_override')
         self.period_end_override = attributes[:'period_end_override']
       end
+
+      if attributes.key?(:'recurrence_policy')
+        self.recurrence_policy = attributes[:'recurrence_policy']
+      end
+
+      if attributes.key?(:'activation_policy')
+        self.activation_policy = attributes[:'activation_policy']
+      end
+
+      if attributes.key?(:'fixed_start_date')
+        self.fixed_start_date = attributes[:'fixed_start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -127,6 +185,10 @@ module TalonOne
       return false if !@name.nil? && @name.to_s.length > 1000
       return false if !@name.nil? && @name.to_s.length < 1
       return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
+      recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      return false unless recurrence_policy_validator.valid?(@recurrence_policy)
+      activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      return false unless activation_policy_validator.valid?(@activation_policy)
       true
     end
 
@@ -149,6 +211,26 @@ module TalonOne
       @name = name
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] recurrence_policy Object to be assigned
+    def recurrence_policy=(recurrence_policy)
+      validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      unless validator.valid?(recurrence_policy)
+        fail ArgumentError, "invalid value for \"recurrence_policy\", must be one of #{validator.allowable_values}."
+      end
+      @recurrence_policy = recurrence_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] activation_policy Object to be assigned
+    def activation_policy=(activation_policy)
+      validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
+      unless validator.valid?(activation_policy)
+        fail ArgumentError, "invalid value for \"activation_policy\", must be one of #{validator.allowable_values}."
+      end
+      @activation_policy = activation_policy
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -159,7 +241,11 @@ module TalonOne
           description == o.description &&
           target == o.target &&
           period == o.period &&
-          period_end_override == o.period_end_override
+          period_end_override == o.period_end_override &&
+          recurrence_policy == o.recurrence_policy &&
+          activation_policy == o.activation_policy &&
+          fixed_start_date == o.fixed_start_date &&
+          end_date == o.end_date
     end
 
     # @see the `==` method
@@ -171,7 +257,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, title, description, target, period, period_end_override].hash
+      [name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_campaign_evaluation_group.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class UpdateCampaignEvaluationGroup
     # The name of the campaign evaluation group.
     attr_accessor :name

data/lib/talon_one/models/update_campaign_group.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class UpdateCampaignGroup
     # The name of the campaign access group.
     attr_accessor :name

data/lib/talon_one/models/update_campaign_template.rb

@@ -43,6 +43,8 @@ module TalonOne
 
     attr_accessor :coupon_settings
 
+    attr_accessor :coupon_reservation_settings
+
     attr_accessor :referral_settings
 
     # The set of limits that operate for this campaign template.
@@ -98,6 +100,7 @@ module TalonOne
         :'tags' => :'tags',
         :'features' => :'features',
         :'coupon_settings' => :'couponSettings',
+        :'coupon_reservation_settings' => :'couponReservationSettings',
         :'referral_settings' => :'referralSettings',
         :'limits' => :'limits',
         :'template_params' => :'templateParams',
@@ -121,6 +124,7 @@ module TalonOne
         :'tags' => :'Array<String>',
         :'features' => :'Array<String>',
         :'coupon_settings' => :'CodeGeneratorSettings',
+        :'coupon_reservation_settings' => :'CampaignTemplateCouponReservationSettings',
         :'referral_settings' => :'CodeGeneratorSettings',
         :'limits' => :'Array<TemplateLimitConfig>',
         :'template_params' => :'Array<CampaignTemplateParams>',
@@ -196,6 +200,10 @@ module TalonOne
         self.coupon_settings = attributes[:'coupon_settings']
       end
 
+      if attributes.key?(:'coupon_reservation_settings')
+        self.coupon_reservation_settings = attributes[:'coupon_reservation_settings']
+      end
+
       if attributes.key?(:'referral_settings')
         self.referral_settings = attributes[:'referral_settings']
       end
@@ -331,6 +339,7 @@ module TalonOne
           tags == o.tags &&
           features == o.features &&
           coupon_settings == o.coupon_settings &&
+          coupon_reservation_settings == o.coupon_reservation_settings &&
           referral_settings == o.referral_settings &&
           limits == o.limits &&
           template_params == o.template_params &&
@@ -349,7 +358,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, campaign_type].hash
+      [name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, features, coupon_settings, coupon_reservation_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, campaign_type].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_coupon.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class UpdateCoupon
     # The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. 
     attr_accessor :usage_limit

data/lib/talon_one/models/update_coupon_batch.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class UpdateCouponBatch
     # The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. 
     attr_accessor :usage_limit

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
@@ -56,6 +56,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 tiers in this loyalty program.
     attr_accessor :tiers
 
@@ -98,6 +101,7 @@ module TalonOne
         :'tiers_expire_in' => :'tiersExpireIn',
         :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
         :'card_code_settings' => :'cardCodeSettings',
+        :'return_policy' => :'returnPolicy',
         :'tiers' => :'tiers'
       }
     end
@@ -119,6 +123,7 @@ module TalonOne
         :'tiers_expire_in' => :'String',
         :'tiers_downgrade_policy' => :'String',
         :'card_code_settings' => :'CodeGeneratorSettings',
+        :'return_policy' => :'String',
         :'tiers' => :'Array<NewLoyaltyTier>'
       }
     end
@@ -202,6 +207,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?(:'tiers')
         if (value = attributes[:'tiers']).is_a?(Array)
           self.tiers = value
@@ -230,6 +239,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)
       true
     end
 
@@ -273,6 +284,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
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -292,6 +313,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 &&
           tiers == o.tiers
     end
 
@@ -304,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, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, 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