talon_one 7.0.0 → 9.0.0

data/lib/talon_one/models/base_loyalty_program.rb

@@ -55,7 +55,7 @@ module TalonOne
 
     attr_accessor :card_code_settings
 
-    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. 
+    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit. 
     attr_accessor :return_policy
 
     class EnumAttributeValidator
@@ -227,7 +227,7 @@ module TalonOne
       return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
       tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
       return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
-      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       return false unless return_policy_validator.valid?(@return_policy)
       true
     end
@@ -275,7 +275,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] return_policy Object to be assigned
     def return_policy=(return_policy)
-      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       unless validator.valid?(return_policy)
         fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/campaign.rb

@@ -20,7 +20,7 @@ module TalonOne
     # The exact moment 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
 
     # The ID of the user associated with this entity.
@@ -138,6 +138,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
+
     # The campaign revision state displayed in the Campaign Manager.
     attr_accessor :revision_frontend_state
 
@@ -226,6 +229,7 @@ module TalonOne
         :'template_id' => :'templateId',
         :'frontend_state' => :'frontendState',
         :'stores_imported' => :'storesImported',
+        :'value_maps_ids' => :'valueMapsIds',
         :'revision_frontend_state' => :'revisionFrontendState',
         :'active_revision_id' => :'activeRevisionId',
         :'active_revision_version_id' => :'activeRevisionVersionId',
@@ -281,6 +285,7 @@ module TalonOne
         :'template_id' => :'Integer',
         :'frontend_state' => :'String',
         :'stores_imported' => :'Boolean',
+        :'value_maps_ids' => :'Array<Integer>',
         :'revision_frontend_state' => :'String',
         :'active_revision_id' => :'Integer',
         :'active_revision_version_id' => :'Integer',
@@ -496,6 +501,12 @@ module TalonOne
         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
+
       if attributes.key?(:'revision_frontend_state')
         self.revision_frontend_state = attributes[:'revision_frontend_state']
       end
@@ -579,10 +590,6 @@ module TalonOne
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      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
@@ -613,7 +620,6 @@ module TalonOne
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
       return false unless type_validator.valid?(@type)
-      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)
@@ -724,6 +730,7 @@ module TalonOne
           template_id == o.template_id &&
           frontend_state == o.frontend_state &&
           stores_imported == o.stores_imported &&
+          value_maps_ids == o.value_maps_ids &&
           revision_frontend_state == o.revision_frontend_state &&
           active_revision_id == o.active_revision_id &&
           active_revision_version_id == o.active_revision_version_id &&
@@ -742,7 +749,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, application_id, user_id, name, description, start_time, end_time, attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, campaign_groups, type, linked_store_ids, 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, revision_frontend_state, active_revision_id, active_revision_version_id, version, current_revision_id, current_revision_version_id, stage_revision].hash
+      [id, created, application_id, user_id, name, description, start_time, end_time, attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, campaign_groups, type, linked_store_ids, 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, revision_frontend_state, active_revision_id, active_revision_version_id, version, current_revision_id, current_revision_version_id, stage_revision].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_detail.rb

@@ -0,0 +1,232 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class CampaignDetail
+    # The ID of the campaign that references the application cart item filter.
+    attr_accessor :campaign_id
+
+    # A user-facing name for this campaign.
+    attr_accessor :campaign_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignId',
+        :'campaign_name' => :'campaignName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'campaign_id' => :'Integer',
+        :'campaign_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CampaignDetail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CampaignDetail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'campaign_name')
+        self.campaign_name = attributes[:'campaign_name']
+      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 !@campaign_name.nil? && @campaign_name.to_s.length < 1
+        invalid_properties.push('invalid value for "campaign_name", the character length must be great than or equal to 1.')
+      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 !@campaign_name.nil? && @campaign_name.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_name Value to be assigned
+    def campaign_name=(campaign_name)
+      if !campaign_name.nil? && campaign_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "campaign_name", the character length must be great than or equal to 1.'
+      end
+
+      @campaign_name = campaign_name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          campaign_id == o.campaign_id &&
+          campaign_name == o.campaign_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [campaign_id, campaign_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/talon_one/models/campaign_evaluation_group.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignEvaluationGroup
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # The name of the campaign evaluation group.

data/lib/talon_one/models/campaign_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/campaign_set.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignSet
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # Internal ID of this entity.

data/lib/talon_one/models/campaign_store_budget.rb

@@ -47,7 +47,7 @@ module TalonOne
         :'created' => :'DateTime',
         :'campaign_id' => :'Integer',
         :'store_id' => :'Integer',
-        :'limits' => :'Array<LimitConfig>'
+        :'limits' => :'Array<CampaignStoreBudgetLimitConfig>'
       }
     end