talon_one 6.0.0 → 8.0.0

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

@@ -13,9 +13,8 @@ OpenAPI Generator version: 4.3.1
 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

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class CampaignStoreBudget
     # Internal ID of this entity.
     attr_accessor :id
@@ -48,7 +47,7 @@ module TalonOne
         :'created' => :'DateTime',
         :'campaign_id' => :'Integer',
         :'store_id' => :'Integer',
-        :'limits' => :'Array<LimitConfig>'
+        :'limits' => :'Array<CampaignStoreBudgetLimitConfig>'
       }
     end
 

data/lib/talon_one/models/campaign_template.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class CampaignTemplate
     # Internal ID of this entity.
     attr_accessor :id
@@ -56,6 +55,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.
@@ -124,6 +125,7 @@ module TalonOne
         :'tags' => :'tags',
         :'features' => :'features',
         :'coupon_settings' => :'couponSettings',
+        :'coupon_reservation_settings' => :'couponReservationSettings',
         :'referral_settings' => :'referralSettings',
         :'limits' => :'limits',
         :'template_params' => :'templateParams',
@@ -154,6 +156,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>',
@@ -248,6 +251,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
@@ -431,6 +438,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 &&
@@ -452,7 +460,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, account_id, user_id, 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, updated, updated_by, valid_application_ids].hash
+      [id, created, account_id, user_id, 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, updated, updated_by, valid_application_ids].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_template_coupon_reservation_settings.rb

@@ -0,0 +1,243 @@
+=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 CampaignTemplateCouponReservationSettings
+    # The number of reservations that can be made with this coupon code. 
+    attr_accessor :reservation_limit
+
+    # An indication of whether the code can be redeemed only if it has been reserved first.
+    attr_accessor :is_reservation_mandatory
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reservation_limit' => :'reservationLimit',
+        :'is_reservation_mandatory' => :'isReservationMandatory'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'reservation_limit' => :'Integer',
+        :'is_reservation_mandatory' => :'Boolean'
+      }
+    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::CampaignTemplateCouponReservationSettings` 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::CampaignTemplateCouponReservationSettings`. 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?(:'reservation_limit')
+        self.reservation_limit = attributes[:'reservation_limit']
+      end
+
+      if attributes.key?(:'is_reservation_mandatory')
+        self.is_reservation_mandatory = attributes[:'is_reservation_mandatory']
+      else
+        self.is_reservation_mandatory = false
+      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 !@reservation_limit.nil? && @reservation_limit > 999999
+        invalid_properties.push('invalid value for "reservation_limit", must be smaller than or equal to 999999.')
+      end
+
+      if !@reservation_limit.nil? && @reservation_limit < 0
+        invalid_properties.push('invalid value for "reservation_limit", must be greater than or equal to 0.')
+      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 !@reservation_limit.nil? && @reservation_limit > 999999
+      return false if !@reservation_limit.nil? && @reservation_limit < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reservation_limit Value to be assigned
+    def reservation_limit=(reservation_limit)
+      if !reservation_limit.nil? && reservation_limit > 999999
+        fail ArgumentError, 'invalid value for "reservation_limit", must be smaller than or equal to 999999.'
+      end
+
+      if !reservation_limit.nil? && reservation_limit < 0
+        fail ArgumentError, 'invalid value for "reservation_limit", must be greater than or equal to 0.'
+      end
+
+      @reservation_limit = reservation_limit
+    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 &&
+          reservation_limit == o.reservation_limit &&
+          is_reservation_mandatory == o.is_reservation_mandatory
+    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
+      [reservation_limit, is_reservation_mandatory].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_versions.rb

@@ -14,6 +14,9 @@ require 'date'
 
 module TalonOne
   class CampaignVersions
+    # The campaign revision state displayed in the Campaign Manager.
+    attr_accessor :revision_frontend_state
+
     # ID of the revision that was last activated on this campaign. 
     attr_accessor :active_revision_id
 
@@ -32,9 +35,32 @@ module TalonOne
     # Flag for determining whether we use current revision when sending requests with staging API key. 
     attr_accessor :stage_revision
 
+    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
       {
+        :'revision_frontend_state' => :'revisionFrontendState',
         :'active_revision_id' => :'activeRevisionId',
         :'active_revision_version_id' => :'activeRevisionVersionId',
         :'version' => :'version',
@@ -47,6 +73,7 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'revision_frontend_state' => :'String',
         :'active_revision_id' => :'Integer',
         :'active_revision_version_id' => :'Integer',
         :'version' => :'Integer',
@@ -77,6 +104,10 @@ module TalonOne
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'revision_frontend_state')
+        self.revision_frontend_state = attributes[:'revision_frontend_state']
+      end
+
       if attributes.key?(:'active_revision_id')
         self.active_revision_id = attributes[:'active_revision_id']
       end
@@ -114,14 +145,27 @@ module TalonOne
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      revision_frontend_state_validator = EnumAttributeValidator.new('String', ["revised", "pending"])
+      return false unless revision_frontend_state_validator.valid?(@revision_frontend_state)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] revision_frontend_state Object to be assigned
+    def revision_frontend_state=(revision_frontend_state)
+      validator = EnumAttributeValidator.new('String', ["revised", "pending"])
+      unless validator.valid?(revision_frontend_state)
+        fail ArgumentError, "invalid value for \"revision_frontend_state\", must be one of #{validator.allowable_values}."
+      end
+      @revision_frontend_state = revision_frontend_state
+    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 &&
+          revision_frontend_state == o.revision_frontend_state &&
           active_revision_id == o.active_revision_id &&
           active_revision_version_id == o.active_revision_version_id &&
           version == o.version &&
@@ -139,7 +183,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [active_revision_id, active_revision_version_id, version, current_revision_id, current_revision_version_id, stage_revision].hash
+      [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/card_expiring_points_notification_policy.rb

@@ -22,12 +22,16 @@ 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',
         :'triggers' => :'triggers',
-        :'batching_enabled' => :'batchingEnabled'
+        :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize'
       }
     end
 
@@ -36,7 +40,8 @@ module TalonOne
       {
         :'name' => :'String',
         :'triggers' => :'Array<CardExpiringPointsNotificationTrigger>',
-        :'batching_enabled' => :'Boolean'
+        :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer'
       }
     end
 
@@ -76,6 +81,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?
@@ -127,7 +136,8 @@ module TalonOne
       self.class == o.class &&
           name == o.name &&
           triggers == o.triggers &&
-          batching_enabled == o.batching_enabled
+          batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size
     end
 
     # @see the `==` method
@@ -139,7 +149,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, triggers, batching_enabled].hash
+      [name, triggers, batching_enabled, batch_size].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/card_ledger_transaction_log_entry.rb

@@ -208,6 +208,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 !~ pattern
+        invalid_properties.push("invalid value for \"card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
         invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.')
       end
@@ -266,6 +271,7 @@ module TalonOne
       return false if @program_id.nil?
       return false if @card_identifier.nil?
       return false if @card_identifier.to_s.length > 108
+      return false if @card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["addition", "subtraction"])
@@ -294,6 +300,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 !~ 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/card_ledger_transaction_log_entry_integration_api.rb

@@ -208,6 +208,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 !~ pattern
+        invalid_properties.push("invalid value for \"card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
         invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.')
       end
@@ -266,6 +271,7 @@ module TalonOne
       return false if @program_id.nil?
       return false if @card_identifier.nil?
       return false if @card_identifier.to_s.length > 108
+      return false if @card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["addition", "subtraction"])
@@ -294,6 +300,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 !~ 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/catalog.rb

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

data/lib/talon_one/models/catalog_item.rb

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