talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb

@@ -0,0 +1,269 @@
+=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 CardAddedDeductedPointsNotificationPolicy
+    # Notification name.
+    attr_accessor :name
+
+    attr_accessor :scopes
+
+    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
+      {
+        :'name' => :'name',
+        :'scopes' => :'scopes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'scopes' => :'Array<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::CardAddedDeductedPointsNotificationPolicy` 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::CardAddedDeductedPointsNotificationPolicy`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      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
+
+      if @scopes.nil?
+        invalid_properties.push('invalid value for "scopes", scopes 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 @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @scopes.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 < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = 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 &&
+          name == o.name &&
+          scopes == o.scopes
+    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
+      [name, scopes].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/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/cart_item.rb

@@ -52,7 +52,7 @@ module TalonOne
     # Position of the Cart Item in the Cart (calculated internally).
     attr_accessor :position
 
-    # Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. 
+    # Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property.  **Note:** Any previously defined attributes that you do not include in the array will be removed. 
     attr_accessor :attributes
 
     # Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). 

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

data/lib/talon_one/models/change.rb

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

data/lib/talon_one/models/code_generator_settings.rb

@@ -17,7 +17,7 @@ module TalonOne
     # List of characters used to generate the random parts of a code. 
     attr_accessor :valid_characters
 
-    # The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. 
+    # The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. 
     attr_accessor :coupon_pattern
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -88,6 +88,11 @@ module TalonOne
         invalid_properties.push('invalid value for "coupon_pattern", the character length must be great than or equal to 3.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_#-]*$/)
+      if @coupon_pattern !~ pattern
+        invalid_properties.push("invalid value for \"coupon_pattern\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -98,6 +103,7 @@ module TalonOne
       return false if @coupon_pattern.nil?
       return false if @coupon_pattern.to_s.length > 100
       return false if @coupon_pattern.to_s.length < 3
+      return false if @coupon_pattern !~ Regexp.new(/^[A-Za-z0-9_#-]*$/)
       true
     end
 
@@ -116,6 +122,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be great than or equal to 3.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_#-]*$/)
+      if coupon_pattern !~ pattern
+        fail ArgumentError, "invalid value for \"coupon_pattern\", must conform to the pattern #{pattern}."
+      end
+
       @coupon_pattern = coupon_pattern
     end
 

data/lib/talon_one/models/collection.rb

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

data/lib/talon_one/models/collection_item.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class CollectionItem
     attr_accessor :item
 

data/lib/talon_one/models/collection_without_payload.rb

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

data/lib/talon_one/models/coupon.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class Coupon
     # Internal ID of this entity.
     attr_accessor :id
@@ -39,7 +38,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/coupon_constraints.rb

@@ -26,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
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/coupon_creation_job.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class CouponCreationJob
     # Internal ID of this entity.
     attr_accessor :id
@@ -42,7 +41,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
 
     # The number of new coupon codes to generate for the campaign.