talon_one 2.4.0 → 2.5.1

data/lib/talon_one/models/new_coupon_creation_job.rb

@@ -0,0 +1,353 @@
+=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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class NewCouponCreationJob
+    # 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
+
+    # The amount of discounts that can be given with this coupon code. 
+    attr_accessor :discount_limit
+
+    # Timestamp at which point the coupon becomes valid.
+    attr_accessor :start_date
+
+    # Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    attr_accessor :expiry_date
+
+    # The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000.
+    attr_accessor :number_of_coupons
+
+    attr_accessor :coupon_settings
+
+    # Arbitrary properties associated with coupons
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'usage_limit' => :'usageLimit',
+        :'discount_limit' => :'discountLimit',
+        :'start_date' => :'startDate',
+        :'expiry_date' => :'expiryDate',
+        :'number_of_coupons' => :'numberOfCoupons',
+        :'coupon_settings' => :'couponSettings',
+        :'attributes' => :'attributes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'usage_limit' => :'Integer',
+        :'discount_limit' => :'Float',
+        :'start_date' => :'DateTime',
+        :'expiry_date' => :'DateTime',
+        :'number_of_coupons' => :'Integer',
+        :'coupon_settings' => :'CodeGeneratorSettings',
+        :'attributes' => :'Object'
+      }
+    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::NewCouponCreationJob` 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::NewCouponCreationJob`. 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?(:'usage_limit')
+        self.usage_limit = attributes[:'usage_limit']
+      end
+
+      if attributes.key?(:'discount_limit')
+        self.discount_limit = attributes[:'discount_limit']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'number_of_coupons')
+        self.number_of_coupons = attributes[:'number_of_coupons']
+      end
+
+      if attributes.key?(:'coupon_settings')
+        self.coupon_settings = attributes[:'coupon_settings']
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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 @usage_limit.nil?
+        invalid_properties.push('invalid value for "usage_limit", usage_limit cannot be nil.')
+      end
+
+      if @usage_limit > 999999
+        invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.')
+      end
+
+      if @usage_limit < 0
+        invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
+      end
+
+      if !@discount_limit.nil? && @discount_limit > 999999
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      end
+
+      if !@discount_limit.nil? && @discount_limit < 0
+        invalid_properties.push('invalid value for "discount_limit", must be greater than or equal to 0.')
+      end
+
+      if @number_of_coupons.nil?
+        invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.')
+      end
+
+      if @number_of_coupons > 5000000
+        invalid_properties.push('invalid value for "number_of_coupons", must be smaller than or equal to 5000000.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @usage_limit.nil?
+      return false if @usage_limit > 999999
+      return false if @usage_limit < 0
+      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit < 0
+      return false if @number_of_coupons.nil?
+      return false if @number_of_coupons > 5000000
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_limit Value to be assigned
+    def usage_limit=(usage_limit)
+      if usage_limit.nil?
+        fail ArgumentError, 'usage_limit cannot be nil'
+      end
+
+      if usage_limit > 999999
+        fail ArgumentError, 'invalid value for "usage_limit", must be smaller than or equal to 999999.'
+      end
+
+      if usage_limit < 0
+        fail ArgumentError, 'invalid value for "usage_limit", must be greater than or equal to 0.'
+      end
+
+      @usage_limit = usage_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] discount_limit Value to be assigned
+    def discount_limit=(discount_limit)
+      if !discount_limit.nil? && discount_limit > 999999
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      end
+
+      if !discount_limit.nil? && discount_limit < 0
+        fail ArgumentError, 'invalid value for "discount_limit", must be greater than or equal to 0.'
+      end
+
+      @discount_limit = discount_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number_of_coupons Value to be assigned
+    def number_of_coupons=(number_of_coupons)
+      if number_of_coupons.nil?
+        fail ArgumentError, 'number_of_coupons cannot be nil'
+      end
+
+      if number_of_coupons > 5000000
+        fail ArgumentError, 'invalid value for "number_of_coupons", must be smaller than or equal to 5000000.'
+      end
+
+      @number_of_coupons = number_of_coupons
+    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 &&
+          usage_limit == o.usage_limit &&
+          discount_limit == o.discount_limit &&
+          start_date == o.start_date &&
+          expiry_date == o.expiry_date &&
+          number_of_coupons == o.number_of_coupons &&
+          coupon_settings == o.coupon_settings &&
+          attributes == o.attributes
+    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
+      [usage_limit, discount_limit, start_date, expiry_date, number_of_coupons, coupon_settings, attributes].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/new_coupons.rb

@@ -1,7 +1,7 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # 
   class NewCoupons
-    # The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    # 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
 
     # The amount of discounts that can be given with this coupon code. 
@@ -27,10 +27,13 @@ module TalonOne
     # Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
     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. 
+    attr_accessor :limits
+
     # The number of new coupon codes to generate for the campaign. Must be at least 1.
     attr_accessor :number_of_coupons
 
-    # A unique prefix to prepend to all generated coupons.
+    # **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). 
     attr_accessor :unique_prefix
 
     # Arbitrary properties associated with this item
@@ -39,10 +42,10 @@ module TalonOne
     # The integration ID for this coupon's beneficiary's profile
     attr_accessor :recipient_integration_id
 
-    # Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp).
+    # List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. 
     attr_accessor :valid_characters
 
-    # The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. 
+    # The pattern used to generate coupon codes. 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.
@@ -52,6 +55,7 @@ module TalonOne
         :'discount_limit' => :'discountLimit',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
+        :'limits' => :'limits',
         :'number_of_coupons' => :'numberOfCoupons',
         :'unique_prefix' => :'uniquePrefix',
         :'attributes' => :'attributes',
@@ -68,6 +72,7 @@ module TalonOne
         :'discount_limit' => :'Float',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
+        :'limits' => :'Array<LimitConfig>',
         :'number_of_coupons' => :'Integer',
         :'unique_prefix' => :'String',
         :'attributes' => :'Object',
@@ -114,6 +119,12 @@ module TalonOne
         self.expiry_date = attributes[:'expiry_date']
       end
 
+      if attributes.key?(:'limits')
+        if (value = attributes[:'limits']).is_a?(Array)
+          self.limits = value
+        end
+      end
+
       if attributes.key?(:'number_of_coupons')
         self.number_of_coupons = attributes[:'number_of_coupons']
       end
@@ -169,6 +180,10 @@ module TalonOne
         invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.')
       end
 
+      if !@recipient_integration_id.nil? && @recipient_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if !@coupon_pattern.nil? && @coupon_pattern.to_s.length > 100
         invalid_properties.push('invalid value for "coupon_pattern", the character length must be smaller than or equal to 100.')
       end
@@ -189,6 +204,7 @@ module TalonOne
       return false if !@discount_limit.nil? && @discount_limit > 999999
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if @number_of_coupons.nil?
+      return false if !@recipient_integration_id.nil? && @recipient_integration_id.to_s.length > 1000
       return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length > 100
       return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3
       true
@@ -226,6 +242,16 @@ module TalonOne
       @discount_limit = discount_limit
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_integration_id Value to be assigned
+    def recipient_integration_id=(recipient_integration_id)
+      if !recipient_integration_id.nil? && recipient_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @recipient_integration_id = recipient_integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] coupon_pattern Value to be assigned
     def coupon_pattern=(coupon_pattern)
@@ -249,6 +275,7 @@ module TalonOne
           discount_limit == o.discount_limit &&
           start_date == o.start_date &&
           expiry_date == o.expiry_date &&
+          limits == o.limits &&
           number_of_coupons == o.number_of_coupons &&
           unique_prefix == o.unique_prefix &&
           attributes == o.attributes &&
@@ -266,7 +293,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [usage_limit, discount_limit, start_date, expiry_date, number_of_coupons, unique_prefix, attributes, recipient_integration_id, valid_characters, coupon_pattern].hash
+      [usage_limit, discount_limit, start_date, expiry_date, limits, number_of_coupons, unique_prefix, attributes, recipient_integration_id, valid_characters, coupon_pattern].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb

@@ -1,7 +1,7 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # 
   class NewCouponsForMultipleRecipients
-    # The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    # 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
 
     # The amount of discounts that can be given with this coupon code. 
@@ -33,10 +33,10 @@ module TalonOne
     # The integration IDs for recipients
     attr_accessor :recipients_integration_ids
 
-    # Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp).
+    # List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. 
     attr_accessor :valid_characters
 
-    # The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. 
+    # The pattern used to generate coupon codes. 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.