talon_one 2.2.0 → 2.3.0

data/lib/talon_one/models/loyalty_program_ledgers.rb

@@ -15,6 +15,9 @@ require 'date'
 module TalonOne
   # Customer specific information about loyalty points.
   class LoyaltyProgramLedgers
+    # The internal ID of loyalty program
+    attr_accessor :id
+
     # Visible name of loyalty program
     attr_accessor :title
 
@@ -29,6 +32,7 @@ module TalonOne
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'title' => :'title',
         :'name' => :'name',
         :'ledger' => :'ledger',
@@ -39,6 +43,7 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'Integer',
         :'title' => :'String',
         :'name' => :'String',
         :'ledger' => :'LoyaltyProgramBalance',
@@ -67,6 +72,10 @@ module TalonOne
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
@@ -90,6 +99,10 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
       if @title.nil?
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
@@ -108,6 +121,7 @@ module TalonOne
     # 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 @id.nil?
       return false if @title.nil?
       return false if @name.nil?
       return false if @ledger.nil?
@@ -119,6 +133,7 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           title == o.title &&
           name == o.name &&
           ledger == o.ledger &&
@@ -134,7 +149,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, name, ledger, sub_ledgers].hash
+      [id, title, name, ledger, sub_ledgers].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_sub_ledger.rb

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # Ledger of Balance in Loyalty Program for a Customer
   class LoyaltySubLedger
-    # ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance 
+    # ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance 
     attr_accessor :total
 
     # Total amount of currently active and available points in the customer's balance

data/lib/talon_one/models/new_application.rb

@@ -42,6 +42,9 @@ module TalonOne
     # The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\"
     attr_accessor :exclusive_campaigns_strategy
 
+    # The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect.
+    attr_accessor :default_discount_scope
+
     # Flag indicating if discounts should cascade for this application
     attr_accessor :enable_cascading_discounts
 
@@ -90,6 +93,7 @@ module TalonOne
         :'limits' => :'limits',
         :'campaign_priority' => :'campaignPriority',
         :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy',
+        :'default_discount_scope' => :'defaultDiscountScope',
         :'enable_cascading_discounts' => :'enableCascadingDiscounts',
         :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
         :'attributes_settings' => :'attributesSettings',
@@ -110,6 +114,7 @@ module TalonOne
         :'limits' => :'Array<LimitConfig>',
         :'campaign_priority' => :'String',
         :'exclusive_campaigns_strategy' => :'String',
+        :'default_discount_scope' => :'String',
         :'enable_cascading_discounts' => :'Boolean',
         :'enable_flattened_cart_items' => :'Boolean',
         :'attributes_settings' => :'AttributesSettings',
@@ -177,6 +182,10 @@ module TalonOne
         self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
       end
 
+      if attributes.key?(:'default_discount_scope')
+        self.default_discount_scope = attributes[:'default_discount_scope']
+      end
+
       if attributes.key?(:'enable_cascading_discounts')
         self.enable_cascading_discounts = attributes[:'enable_cascading_discounts']
       end
@@ -249,6 +258,8 @@ module TalonOne
       return false unless campaign_priority_validator.valid?(@campaign_priority)
       exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
       return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
+      default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
+      return false unless default_discount_scope_validator.valid?(@default_discount_scope)
       return false if !@key.nil? && @key !~ Regexp.new(/^[a-fA-F0-9]{16}$/)
       true
     end
@@ -325,6 +336,16 @@ module TalonOne
       @exclusive_campaigns_strategy = exclusive_campaigns_strategy
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] default_discount_scope Object to be assigned
+    def default_discount_scope=(default_discount_scope)
+      validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
+      unless validator.valid?(default_discount_scope)
+        fail ArgumentError, "invalid value for \"default_discount_scope\", must be one of #{validator.allowable_values}."
+      end
+      @default_discount_scope = default_discount_scope
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] key Value to be assigned
     def key=(key)
@@ -350,6 +371,7 @@ module TalonOne
           limits == o.limits &&
           campaign_priority == o.campaign_priority &&
           exclusive_campaigns_strategy == o.exclusive_campaigns_strategy &&
+          default_discount_scope == o.default_discount_scope &&
           enable_cascading_discounts == o.enable_cascading_discounts &&
           enable_flattened_cart_items == o.enable_flattened_cart_items &&
           attributes_settings == o.attributes_settings &&
@@ -366,7 +388,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, key].hash
+      [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, key].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_application_api_key.rb

@@ -196,7 +196,7 @@ module TalonOne
     def valid?
       return false if @title.nil?
       return false if @expires.nil?
-      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle"])
+      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent"])
       return false unless platform_validator.valid?(@platform)
       return false if @id.nil?
       return false if @created_by.nil?
@@ -210,7 +210,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] platform Object to be assigned
     def platform=(platform)
-      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle"])
+      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent"])
       unless validator.valid?(platform)
         fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/new_coupons.rb

@@ -27,12 +27,6 @@ module TalonOne
     # Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
     attr_accessor :expiry_date
 
-    # Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp).
-    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. 
-    attr_accessor :coupon_pattern
-
     # The number of new coupon codes to generate for the campaign. Must be at least 1.
     attr_accessor :number_of_coupons
 
@@ -45,6 +39,12 @@ 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).
+    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. 
+    attr_accessor :coupon_pattern
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,12 +52,12 @@ module TalonOne
         :'discount_limit' => :'discountLimit',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
-        :'valid_characters' => :'validCharacters',
-        :'coupon_pattern' => :'couponPattern',
         :'number_of_coupons' => :'numberOfCoupons',
         :'unique_prefix' => :'uniquePrefix',
         :'attributes' => :'attributes',
-        :'recipient_integration_id' => :'recipientIntegrationId'
+        :'recipient_integration_id' => :'recipientIntegrationId',
+        :'valid_characters' => :'validCharacters',
+        :'coupon_pattern' => :'couponPattern'
       }
     end
 
@@ -68,12 +68,12 @@ module TalonOne
         :'discount_limit' => :'Float',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
-        :'valid_characters' => :'Array<String>',
-        :'coupon_pattern' => :'String',
         :'number_of_coupons' => :'Integer',
         :'unique_prefix' => :'String',
         :'attributes' => :'Object',
-        :'recipient_integration_id' => :'String'
+        :'recipient_integration_id' => :'String',
+        :'valid_characters' => :'Array<String>',
+        :'coupon_pattern' => :'String'
       }
     end
 
@@ -114,16 +114,6 @@ module TalonOne
         self.expiry_date = attributes[:'expiry_date']
       end
 
-      if attributes.key?(:'valid_characters')
-        if (value = attributes[:'valid_characters']).is_a?(Array)
-          self.valid_characters = value
-        end
-      end
-
-      if attributes.key?(:'coupon_pattern')
-        self.coupon_pattern = attributes[:'coupon_pattern']
-      end
-
       if attributes.key?(:'number_of_coupons')
         self.number_of_coupons = attributes[:'number_of_coupons']
       end
@@ -139,6 +129,16 @@ module TalonOne
       if attributes.key?(:'recipient_integration_id')
         self.recipient_integration_id = attributes[:'recipient_integration_id']
       end
+
+      if attributes.key?(:'valid_characters')
+        if (value = attributes[:'valid_characters']).is_a?(Array)
+          self.valid_characters = value
+        end
+      end
+
+      if attributes.key?(:'coupon_pattern')
+        self.coupon_pattern = attributes[:'coupon_pattern']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -165,22 +165,18 @@ module TalonOne
         invalid_properties.push('invalid value for "discount_limit", must be greater than or equal to 0.')
       end
 
-      if @valid_characters.nil?
-        invalid_properties.push('invalid value for "valid_characters", valid_characters cannot be nil.')
+      if @number_of_coupons.nil?
+        invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.')
       end
 
-      if @coupon_pattern.nil?
-        invalid_properties.push('invalid value for "coupon_pattern", coupon_pattern cannot be nil.')
+      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
 
-      if @coupon_pattern.to_s.length < 3
+      if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3
         invalid_properties.push('invalid value for "coupon_pattern", the character length must be great than or equal to 3.')
       end
 
-      if @number_of_coupons.nil?
-        invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -192,10 +188,9 @@ module TalonOne
       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 @valid_characters.nil?
-      return false if @coupon_pattern.nil?
-      return false if @coupon_pattern.to_s.length < 3
       return false if @number_of_coupons.nil?
+      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
     end
 
@@ -234,11 +229,11 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] coupon_pattern Value to be assigned
     def coupon_pattern=(coupon_pattern)
-      if coupon_pattern.nil?
-        fail ArgumentError, 'coupon_pattern cannot be nil'
+      if !coupon_pattern.nil? && coupon_pattern.to_s.length > 100
+        fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be smaller than or equal to 100.'
       end
 
-      if coupon_pattern.to_s.length < 3
+      if !coupon_pattern.nil? && coupon_pattern.to_s.length < 3
         fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be great than or equal to 3.'
       end
 
@@ -254,12 +249,12 @@ module TalonOne
           discount_limit == o.discount_limit &&
           start_date == o.start_date &&
           expiry_date == o.expiry_date &&
-          valid_characters == o.valid_characters &&
-          coupon_pattern == o.coupon_pattern &&
           number_of_coupons == o.number_of_coupons &&
           unique_prefix == o.unique_prefix &&
           attributes == o.attributes &&
-          recipient_integration_id == o.recipient_integration_id
+          recipient_integration_id == o.recipient_integration_id &&
+          valid_characters == o.valid_characters &&
+          coupon_pattern == o.coupon_pattern
     end
 
     # @see the `==` method
@@ -271,7 +266,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [usage_limit, discount_limit, start_date, expiry_date, valid_characters, coupon_pattern, number_of_coupons, unique_prefix, attributes, recipient_integration_id].hash
+      [usage_limit, discount_limit, start_date, expiry_date, 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

@@ -0,0 +1,368 @@
+=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 
+
+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 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. 
+    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
+
+    # Arbitrary properties associated with this item
+    attr_accessor :attributes
+
+    # 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).
+    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. 
+    attr_accessor :coupon_pattern
+
+    # 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',
+        :'attributes' => :'attributes',
+        :'recipients_integration_ids' => :'recipientsIntegrationIds',
+        :'valid_characters' => :'validCharacters',
+        :'coupon_pattern' => :'couponPattern'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'usage_limit' => :'Integer',
+        :'discount_limit' => :'Float',
+        :'start_date' => :'DateTime',
+        :'expiry_date' => :'DateTime',
+        :'attributes' => :'Object',
+        :'recipients_integration_ids' => :'Array<String>',
+        :'valid_characters' => :'Array<String>',
+        :'coupon_pattern' => :'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::NewCouponsForMultipleRecipients` 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::NewCouponsForMultipleRecipients`. 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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'recipients_integration_ids')
+        if (value = attributes[:'recipients_integration_ids']).is_a?(Array)
+          self.recipients_integration_ids = value
+        end
+      end
+
+      if attributes.key?(:'valid_characters')
+        if (value = attributes[:'valid_characters']).is_a?(Array)
+          self.valid_characters = value
+        end
+      end
+
+      if attributes.key?(:'coupon_pattern')
+        self.coupon_pattern = attributes[:'coupon_pattern']
+      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 @recipients_integration_ids.nil?
+        invalid_properties.push('invalid value for "recipients_integration_ids", recipients_integration_ids cannot be nil.')
+      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
+
+      if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3
+        invalid_properties.push('invalid value for "coupon_pattern", the character length must be great than or equal to 3.')
+      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 @recipients_integration_ids.nil?
+      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
+    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] coupon_pattern Value to be assigned
+    def coupon_pattern=(coupon_pattern)
+      if !coupon_pattern.nil? && coupon_pattern.to_s.length > 100
+        fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be smaller than or equal to 100.'
+      end
+
+      if !coupon_pattern.nil? && coupon_pattern.to_s.length < 3
+        fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be great than or equal to 3.'
+      end
+
+      @coupon_pattern = coupon_pattern
+    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 &&
+          attributes == o.attributes &&
+          recipients_integration_ids == o.recipients_integration_ids &&
+          valid_characters == o.valid_characters &&
+          coupon_pattern == o.coupon_pattern
+    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, attributes, recipients_integration_ids, valid_characters, coupon_pattern].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