talon_one 7.0.0 → 8.0.0

data/lib/talon_one/models/achievement.rb

@@ -49,7 +49,7 @@ module TalonOne
     # 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
 
-    # ID of the campaign, to which the achievement belongs to
+    # The ID of the campaign the achievement belongs to.
     attr_accessor :campaign_id
 
     # ID of the user that created this achievement.
@@ -61,6 +61,9 @@ module TalonOne
     # Indicates if a customer has made progress in the achievement.
     attr_accessor :has_progress
 
+    # The status of the achievement.
+    attr_accessor :status
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -101,7 +104,8 @@ module TalonOne
         :'campaign_id' => :'campaignId',
         :'user_id' => :'userId',
         :'created_by' => :'createdBy',
-        :'has_progress' => :'hasProgress'
+        :'has_progress' => :'hasProgress',
+        :'status' => :'status'
       }
     end
 
@@ -123,7 +127,8 @@ module TalonOne
         :'campaign_id' => :'Integer',
         :'user_id' => :'Integer',
         :'created_by' => :'String',
-        :'has_progress' => :'Boolean'
+        :'has_progress' => :'Boolean',
+        :'status' => :'String'
       }
     end
 
@@ -211,6 +216,10 @@ module TalonOne
       if attributes.key?(:'has_progress')
         self.has_progress = attributes[:'has_progress']
       end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -254,10 +263,6 @@ module TalonOne
         invalid_properties.push('invalid value for "target", target cannot be nil.')
       end
 
-      if @period.nil?
-        invalid_properties.push('invalid value for "period", period cannot be nil.')
-      end
-
       if @campaign_id.nil?
         invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
       end
@@ -266,10 +271,6 @@ module TalonOne
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @created_by.nil?
-        invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -285,14 +286,14 @@ module TalonOne
       return false if @title.nil?
       return false if @description.nil?
       return false if @target.nil?
-      return false if @period.nil?
       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)
       return false if @campaign_id.nil?
       return false if @user_id.nil?
-      return false if @created_by.nil?
+      status_validator = EnumAttributeValidator.new('String', ["inprogress", "expired", "not_started", "completed"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
@@ -339,6 +340,16 @@ module TalonOne
       @activation_policy = activation_policy
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["inprogress", "expired", "not_started", "completed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -359,7 +370,8 @@ module TalonOne
           campaign_id == o.campaign_id &&
           user_id == o.user_id &&
           created_by == o.created_by &&
-          has_progress == o.has_progress
+          has_progress == o.has_progress &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -371,7 +383,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date, campaign_id, user_id, created_by, has_progress].hash
+      [id, created, name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date, campaign_id, user_id, created_by, has_progress, status].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/achievement_additional_properties.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class AchievementAdditionalProperties
-    # ID of the campaign, to which the achievement belongs to
+    # The ID of the campaign the achievement belongs to.
     attr_accessor :campaign_id
 
     # ID of the user that created this achievement.
@@ -26,13 +26,39 @@ module TalonOne
     # Indicates if a customer has made progress in the achievement.
     attr_accessor :has_progress
 
+    # The status of the achievement.
+    attr_accessor :status
+
+    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
       {
         :'campaign_id' => :'campaignId',
         :'user_id' => :'userId',
         :'created_by' => :'createdBy',
-        :'has_progress' => :'hasProgress'
+        :'has_progress' => :'hasProgress',
+        :'status' => :'status'
       }
     end
 
@@ -42,7 +68,8 @@ module TalonOne
         :'campaign_id' => :'Integer',
         :'user_id' => :'Integer',
         :'created_by' => :'String',
-        :'has_progress' => :'Boolean'
+        :'has_progress' => :'Boolean',
+        :'status' => :'String'
       }
     end
 
@@ -82,6 +109,10 @@ module TalonOne
       if attributes.key?(:'has_progress')
         self.has_progress = attributes[:'has_progress']
       end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -96,10 +127,6 @@ module TalonOne
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @created_by.nil?
-        invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -108,10 +135,21 @@ module TalonOne
     def valid?
       return false if @campaign_id.nil?
       return false if @user_id.nil?
-      return false if @created_by.nil?
+      status_validator = EnumAttributeValidator.new('String', ["inprogress", "expired", "not_started", "completed"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["inprogress", "expired", "not_started", "completed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -120,7 +158,8 @@ module TalonOne
           campaign_id == o.campaign_id &&
           user_id == o.user_id &&
           created_by == o.created_by &&
-          has_progress == o.has_progress
+          has_progress == o.has_progress &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -132,7 +171,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, user_id, created_by, has_progress].hash
+      [campaign_id, user_id, created_by, has_progress, status].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/achievement_progress.rb

@@ -13,28 +13,11 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
+  # The current progress of the customer in the achievement.
   class AchievementProgress
-    # The internal ID of the achievement.
-    attr_accessor :achievement_id
-
-    # The internal name of the achievement used in API requests. 
-    attr_accessor :name
-
-    # The display name of the achievement in the Campaign Manager.
-    attr_accessor :title
-
-    # The description of the achievement in the Campaign Manager.
-    attr_accessor :description
-
-    # The ID of the campaign the achievement belongs to.
-    attr_accessor :campaign_id
-
     # The status of the achievement.
     attr_accessor :status
 
-    # The required number of actions or the transactional milestone to complete the achievement.
-    attr_accessor :target
-
     # The current progress of the customer in the achievement.
     attr_accessor :progress
 
@@ -72,13 +55,7 @@ module TalonOne
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'achievement_id' => :'achievementId',
-        :'name' => :'name',
-        :'title' => :'title',
-        :'description' => :'description',
-        :'campaign_id' => :'campaignId',
         :'status' => :'status',
-        :'target' => :'target',
         :'progress' => :'progress',
         :'start_date' => :'startDate',
         :'completion_date' => :'completionDate',
@@ -89,13 +66,7 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'achievement_id' => :'Integer',
-        :'name' => :'String',
-        :'title' => :'String',
-        :'description' => :'String',
-        :'campaign_id' => :'Integer',
         :'status' => :'String',
-        :'target' => :'Float',
         :'progress' => :'Float',
         :'start_date' => :'DateTime',
         :'completion_date' => :'DateTime',
@@ -124,34 +95,10 @@ module TalonOne
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'achievement_id')
-        self.achievement_id = attributes[:'achievement_id']
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
-      end
-
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
-      end
-
-      if attributes.key?(:'campaign_id')
-        self.campaign_id = attributes[:'campaign_id']
-      end
-
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'target')
-        self.target = attributes[:'target']
-      end
-
       if attributes.key?(:'progress')
         self.progress = attributes[:'progress']
       end
@@ -173,39 +120,6 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @achievement_id.nil?
-        invalid_properties.push('invalid value for "achievement_id", achievement_id cannot be nil.')
-      end
-
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
-      if @name.to_s.length > 1000
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
-      end
-
-      if @name.to_s.length < 1
-        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
-      end
-
-      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
-      if @name !~ pattern
-        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
-      end
-
-      if @title.nil?
-        invalid_properties.push('invalid value for "title", title cannot be nil.')
-      end
-
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
-      end
-
-      if @campaign_id.nil?
-        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
-      end
-
       if @status.nil?
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
@@ -214,64 +128,23 @@ module TalonOne
         invalid_properties.push('invalid value for "progress", progress cannot be nil.')
       end
 
-      if @start_date.nil?
-        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
-      end
-
-      if @end_date.nil?
-        invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
-      end
-
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @achievement_id.nil?
-      return false if @name.nil?
-      return false if @name.to_s.length > 1000
-      return false if @name.to_s.length < 1
-      return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
-      return false if @title.nil?
-      return false if @description.nil?
-      return false if @campaign_id.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired"])
+      status_validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired", "not_started"])
       return false unless status_validator.valid?(@status)
       return false if @progress.nil?
-      return false if @start_date.nil?
-      return false if @end_date.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      if name.to_s.length > 1000
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1000.'
-      end
-
-      if name.to_s.length < 1
-        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
-      end
-
-      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
-      if name !~ pattern
-        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
-      end
-
-      @name = name
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired"])
+      validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired", "not_started"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -283,13 +156,7 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          achievement_id == o.achievement_id &&
-          name == o.name &&
-          title == o.title &&
-          description == o.description &&
-          campaign_id == o.campaign_id &&
           status == o.status &&
-          target == o.target &&
           progress == o.progress &&
           start_date == o.start_date &&
           completion_date == o.completion_date &&
@@ -305,7 +172,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [achievement_id, name, title, description, campaign_id, status, target, progress, start_date, completion_date, end_date].hash
+      [status, progress, start_date, completion_date, end_date].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/add_free_item_effect_props.rb

@@ -21,11 +21,15 @@ module TalonOne
     # The name / description of the effect
     attr_accessor :name
 
+    # The original quantity in case a partial reward was applied.
+    attr_accessor :desired_quantity
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'sku' => :'sku',
-        :'name' => :'name'
+        :'name' => :'name',
+        :'desired_quantity' => :'desiredQuantity'
       }
     end
 
@@ -33,7 +37,8 @@ module TalonOne
     def self.openapi_types
       {
         :'sku' => :'String',
-        :'name' => :'String'
+        :'name' => :'String',
+        :'desired_quantity' => :'Integer'
       }
     end
 
@@ -65,6 +70,10 @@ module TalonOne
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
+
+      if attributes.key?(:'desired_quantity')
+        self.desired_quantity = attributes[:'desired_quantity']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -96,7 +105,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           sku == o.sku &&
-          name == o.name
+          name == o.name &&
+          desired_quantity == o.desired_quantity
     end
 
     # @see the `==` method
@@ -108,7 +118,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sku, name].hash
+      [sku, name, desired_quantity].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/additional_campaign_properties.rb

@@ -83,6 +83,9 @@ module TalonOne
     # Indicates whether the linked stores were imported via a CSV file.
     attr_accessor :stores_imported
 
+    # A list of value map IDs for the campaign.
+    attr_accessor :value_maps_ids
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -130,7 +133,8 @@ module TalonOne
         :'updated_by' => :'updatedBy',
         :'template_id' => :'templateId',
         :'frontend_state' => :'frontendState',
-        :'stores_imported' => :'storesImported'
+        :'stores_imported' => :'storesImported',
+        :'value_maps_ids' => :'valueMapsIds'
       }
     end
 
@@ -159,7 +163,8 @@ module TalonOne
         :'updated_by' => :'String',
         :'template_id' => :'Integer',
         :'frontend_state' => :'String',
-        :'stores_imported' => :'Boolean'
+        :'stores_imported' => :'Boolean',
+        :'value_maps_ids' => :'Array<Integer>'
       }
     end
 
@@ -277,16 +282,18 @@ module TalonOne
       if attributes.key?(:'stores_imported')
         self.stores_imported = attributes[:'stores_imported']
       end
+
+      if attributes.key?(:'value_maps_ids')
+        if (value = attributes[:'value_maps_ids']).is_a?(Array)
+          self.value_maps_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @budgets.nil?
-        invalid_properties.push('invalid value for "budgets", budgets cannot be nil.')
-      end
-
       if @frontend_state.nil?
         invalid_properties.push('invalid value for "frontend_state", frontend_state cannot be nil.')
       end
@@ -301,7 +308,6 @@ module TalonOne
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @budgets.nil?
       return false if @frontend_state.nil?
       frontend_state_validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived", "staged"])
       return false unless frontend_state_validator.valid?(@frontend_state)
@@ -346,7 +352,8 @@ module TalonOne
           updated_by == o.updated_by &&
           template_id == o.template_id &&
           frontend_state == o.frontend_state &&
-          stores_imported == o.stores_imported
+          stores_imported == o.stores_imported &&
+          value_maps_ids == o.value_maps_ids
     end
 
     # @see the `==` method
@@ -358,7 +365,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [budgets, coupon_redemption_count, referral_redemption_count, discount_count, discount_effect_count, coupon_creation_count, custom_effect_count, referral_creation_count, add_free_item_effect_count, awarded_giveaways_count, created_loyalty_points_count, created_loyalty_points_effect_count, redeemed_loyalty_points_count, redeemed_loyalty_points_effect_count, call_api_effect_count, reservecoupon_effect_count, last_activity, updated, created_by, updated_by, template_id, frontend_state, stores_imported].hash
+      [budgets, coupon_redemption_count, referral_redemption_count, discount_count, discount_effect_count, coupon_creation_count, custom_effect_count, referral_creation_count, add_free_item_effect_count, awarded_giveaways_count, created_loyalty_points_count, created_loyalty_points_effect_count, redeemed_loyalty_points_count, redeemed_loyalty_points_effect_count, call_api_effect_count, reservecoupon_effect_count, last_activity, updated, created_by, updated_by, template_id, frontend_state, stores_imported, value_maps_ids].hash
     end
 
     # Builds the object from hash