talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/update_application.rb

@@ -58,6 +58,12 @@ module TalonOne
     # The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign.
     attr_accessor :default_evaluation_group_id
 
+    # The ID of the default Cart-Item-Filter for this application.
+    attr_accessor :default_cart_item_filter_id
+
+    # Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled. 
+    attr_accessor :enable_campaign_state_management
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -97,7 +103,9 @@ module TalonOne
         :'sandbox' => :'sandbox',
         :'enable_partial_discounts' => :'enablePartialDiscounts',
         :'default_discount_additional_cost_per_item_scope' => :'defaultDiscountAdditionalCostPerItemScope',
-        :'default_evaluation_group_id' => :'defaultEvaluationGroupId'
+        :'default_evaluation_group_id' => :'defaultEvaluationGroupId',
+        :'default_cart_item_filter_id' => :'defaultCartItemFilterId',
+        :'enable_campaign_state_management' => :'enableCampaignStateManagement'
       }
     end
 
@@ -118,7 +126,9 @@ module TalonOne
         :'sandbox' => :'Boolean',
         :'enable_partial_discounts' => :'Boolean',
         :'default_discount_additional_cost_per_item_scope' => :'String',
-        :'default_evaluation_group_id' => :'Integer'
+        :'default_evaluation_group_id' => :'Integer',
+        :'default_cart_item_filter_id' => :'Integer',
+        :'enable_campaign_state_management' => :'Boolean'
       }
     end
 
@@ -204,6 +214,14 @@ module TalonOne
       if attributes.key?(:'default_evaluation_group_id')
         self.default_evaluation_group_id = attributes[:'default_evaluation_group_id']
       end
+
+      if attributes.key?(:'default_cart_item_filter_id')
+        self.default_cart_item_filter_id = attributes[:'default_cart_item_filter_id']
+      end
+
+      if attributes.key?(:'enable_campaign_state_management')
+        self.enable_campaign_state_management = attributes[:'enable_campaign_state_management']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -346,7 +364,9 @@ module TalonOne
           sandbox == o.sandbox &&
           enable_partial_discounts == o.enable_partial_discounts &&
           default_discount_additional_cost_per_item_scope == o.default_discount_additional_cost_per_item_scope &&
-          default_evaluation_group_id == o.default_evaluation_group_id
+          default_evaluation_group_id == o.default_evaluation_group_id &&
+          default_cart_item_filter_id == o.default_cart_item_filter_id &&
+          enable_campaign_state_management == o.enable_campaign_state_management
     end
 
     # @see the `==` method
@@ -358,7 +378,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id].hash
+      [name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id, default_cart_item_filter_id, enable_campaign_state_management].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_application_cif.rb

@@ -0,0 +1,237 @@
+=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 UpdateApplicationCIF
+    # A short description of the Application cart item filter.
+    attr_accessor :description
+
+    # The ID of the expression that the Application cart item filter uses.
+    attr_accessor :active_expression_id
+
+    # The ID of the user who last updated the Application cart item filter.
+    attr_accessor :modified_by
+
+    # Timestamp of the most recent update to the Application cart item filter.
+    attr_accessor :modified
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'active_expression_id' => :'activeExpressionId',
+        :'modified_by' => :'modifiedBy',
+        :'modified' => :'modified'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'active_expression_id' => :'Integer',
+        :'modified_by' => :'Integer',
+        :'modified' => :'DateTime'
+      }
+    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::UpdateApplicationCIF` 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::UpdateApplicationCIF`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'active_expression_id')
+        self.active_expression_id = attributes[:'active_expression_id']
+      end
+
+      if attributes.key?(:'modified_by')
+        self.modified_by = attributes[:'modified_by']
+      end
+
+      if attributes.key?(:'modified')
+        self.modified = attributes[:'modified']
+      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
+      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?
+      true
+    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 &&
+          description == o.description &&
+          active_expression_id == o.active_expression_id &&
+          modified_by == o.modified_by &&
+          modified == o.modified
+    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
+      [description, active_expression_id, modified_by, modified].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/update_campaign.rb

@@ -57,7 +57,7 @@ module TalonOne
     # The campaign type. Possible type values:   - `cartItem`: Type of campaign that can apply effects only to cart items.   - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. 
     attr_accessor :type
 
-    # A list of store IDs that you want to link to the campaign.  **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. 
+    # A list of store IDs that you want to link to the campaign.  **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. 
     attr_accessor :linked_store_ids
 
     class EnumAttributeValidator

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
@@ -27,7 +26,7 @@ module TalonOne
     # Timestamp at which point the coupon becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    # Expiration date of the coupon. Coupon never expires if this is omitted.
     attr_accessor :expiry_date
 
     # Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. 

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
@@ -27,7 +26,7 @@ module TalonOne
     # Timestamp at which point the coupon becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    # Expiration date of the coupon. Coupon never expires if this is omitted.
     attr_accessor :expiry_date
 
     # Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes).  Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. 

data/lib/talon_one/models/update_loyalty_card.rb

@@ -14,20 +14,25 @@ require 'date'
 
 module TalonOne
   class UpdateLoyaltyCard
-    # Status of the loyalty card. Can be one of: ['active', 'inactive'] 
+    # Status of the loyalty card. Can be `active` or `inactive`. 
     attr_accessor :status
 
+    # Reason for transferring and blocking the loyalty card. 
+    attr_accessor :block_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status' => :'status'
+        :'status' => :'status',
+        :'block_reason' => :'blockReason'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'status' => :'String'
+        :'status' => :'String',
+        :'block_reason' => :'String'
       }
     end
 
@@ -55,6 +60,10 @@ module TalonOne
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'block_reason')
+        self.block_reason = attributes[:'block_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +89,8 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          status == o.status
+          status == o.status &&
+          block_reason == o.block_reason
     end
 
     # @see the `==` method
@@ -92,7 +102,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status].hash
+      [status, block_reason].hash
     end
 
     # Builds the object from hash