talon_one 1.4.0 → 2.3.0

data/lib/talon_one/models/coupon.rb

@@ -3,10 +3,10 @@
 
 #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 
 
-OpenAPI spec version: 1.0.0
+The version of the OpenAPI document: 1.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.7
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -30,6 +30,9 @@ module TalonOne
     # 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
 
@@ -39,13 +42,19 @@ module TalonOne
     # The number of times this coupon has been successfully used.
     attr_accessor :usage_counter
 
+    # The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon.
+    attr_accessor :discount_counter
+
+    # The remaining discount this coupon can give.
+    attr_accessor :discount_remainder
+
     # Arbitrary properties associated with this item
     attr_accessor :attributes
 
     # The integration ID of the referring customer (if any) for whom this coupon was created as an effect.
     attr_accessor :referral_id
 
-    # The integration ID of a referred customer profile.
+    # The Integration ID of the customer that is allowed to redeem this coupon.
     attr_accessor :recipient_integration_id
 
     # The ID of the Import which created this coupon.
@@ -65,9 +74,12 @@ module TalonOne
         :'campaign_id' => :'campaignId',
         :'value' => :'value',
         :'usage_limit' => :'usageLimit',
+        :'discount_limit' => :'discountLimit',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
         :'usage_counter' => :'usageCounter',
+        :'discount_counter' => :'discountCounter',
+        :'discount_remainder' => :'discountRemainder',
         :'attributes' => :'attributes',
         :'referral_id' => :'referralId',
         :'recipient_integration_id' => :'recipientIntegrationId',
@@ -78,87 +90,115 @@ module TalonOne
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'id' => :'Integer',
         :'created' => :'DateTime',
         :'campaign_id' => :'Integer',
         :'value' => :'String',
         :'usage_limit' => :'Integer',
+        :'discount_limit' => :'Float',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
         :'usage_counter' => :'Integer',
+        :'discount_counter' => :'Float',
+        :'discount_remainder' => :'Float',
         :'attributes' => :'Object',
         :'referral_id' => :'Integer',
         :'recipient_integration_id' => :'String',
         :'import_id' => :'Integer',
-        :'reservation' => :'BOOLEAN',
+        :'reservation' => :'Boolean',
         :'batch_id' => :'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 = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::Coupon` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::Coupon`. 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.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'created')
+      if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
 
-      if attributes.has_key?(:'campaignId')
-        self.campaign_id = attributes[:'campaignId']
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
       end
 
-      if attributes.has_key?(:'value')
+      if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
 
-      if attributes.has_key?(:'usageLimit')
-        self.usage_limit = attributes[:'usageLimit']
+      if attributes.key?(:'usage_limit')
+        self.usage_limit = attributes[:'usage_limit']
       end
 
-      if attributes.has_key?(:'startDate')
-        self.start_date = attributes[:'startDate']
+      if attributes.key?(:'discount_limit')
+        self.discount_limit = attributes[:'discount_limit']
       end
 
-      if attributes.has_key?(:'expiryDate')
-        self.expiry_date = attributes[:'expiryDate']
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
       end
 
-      if attributes.has_key?(:'usageCounter')
-        self.usage_counter = attributes[:'usageCounter']
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
       end
 
-      if attributes.has_key?(:'attributes')
+      if attributes.key?(:'usage_counter')
+        self.usage_counter = attributes[:'usage_counter']
+      end
+
+      if attributes.key?(:'discount_counter')
+        self.discount_counter = attributes[:'discount_counter']
+      end
+
+      if attributes.key?(:'discount_remainder')
+        self.discount_remainder = attributes[:'discount_remainder']
+      end
+
+      if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
 
-      if attributes.has_key?(:'referralId')
-        self.referral_id = attributes[:'referralId']
+      if attributes.key?(:'referral_id')
+        self.referral_id = attributes[:'referral_id']
       end
 
-      if attributes.has_key?(:'recipientIntegrationId')
-        self.recipient_integration_id = attributes[:'recipientIntegrationId']
+      if attributes.key?(:'recipient_integration_id')
+        self.recipient_integration_id = attributes[:'recipient_integration_id']
       end
 
-      if attributes.has_key?(:'importId')
-        self.import_id = attributes[:'importId']
+      if attributes.key?(:'import_id')
+        self.import_id = attributes[:'import_id']
       end
 
-      if attributes.has_key?(:'reservation')
+      if attributes.key?(:'reservation')
         self.reservation = attributes[:'reservation']
       end
 
-      if attributes.has_key?(:'batchId')
-        self.batch_id = attributes[:'batchId']
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
       end
     end
 
@@ -198,6 +238,14 @@ module TalonOne
         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 @usage_counter.nil?
         invalid_properties.push('invalid value for "usage_counter", usage_counter cannot be nil.')
       end
@@ -216,6 +264,8 @@ module TalonOne
       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 @usage_counter.nil?
       true
     end
@@ -252,6 +302,20 @@ module TalonOne
       @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
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -262,9 +326,12 @@ module TalonOne
           campaign_id == o.campaign_id &&
           value == o.value &&
           usage_limit == o.usage_limit &&
+          discount_limit == o.discount_limit &&
           start_date == o.start_date &&
           expiry_date == o.expiry_date &&
           usage_counter == o.usage_counter &&
+          discount_counter == o.discount_counter &&
+          discount_remainder == o.discount_remainder &&
           attributes == o.attributes &&
           referral_id == o.referral_id &&
           recipient_integration_id == o.recipient_integration_id &&
@@ -280,9 +347,16 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, created, campaign_id, value, usage_limit, start_date, expiry_date, usage_counter, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id].hash
+      [id, created, campaign_id, value, usage_limit, discount_limit, start_date, expiry_date, usage_counter, discount_counter, discount_remainder, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id].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
@@ -290,9 +364,9 @@ module TalonOne
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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) })
@@ -321,7 +395,7 @@ module TalonOne
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -342,8 +416,7 @@ module TalonOne
           end
         end
       else # model
-        temp_model = TalonOne.const_get(type).new
-        temp_model.build_from_hash(value)
+        TalonOne.const_get(type).build_from_hash(value)
       end
     end
 
@@ -365,7 +438,11 @@ module TalonOne
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/talon_one/models/coupon_constraints.rb

@@ -3,10 +3,10 @@
 
 #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 
 
-OpenAPI spec version: 1.0.0
+The version of the OpenAPI document: 1.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.7
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -17,6 +17,9 @@ module TalonOne
     # 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
 
@@ -27,38 +30,57 @@ module TalonOne
     def self.attribute_map
       {
         :'usage_limit' => :'usageLimit',
+        :'discount_limit' => :'discountLimit',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'usage_limit' => :'Integer',
+        :'discount_limit' => :'Float',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CouponConstraints` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::CouponConstraints`. 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.has_key?(:'usageLimit')
-        self.usage_limit = attributes[:'usageLimit']
+      if attributes.key?(:'usage_limit')
+        self.usage_limit = attributes[:'usage_limit']
       end
 
-      if attributes.has_key?(:'startDate')
-        self.start_date = attributes[:'startDate']
+      if attributes.key?(:'discount_limit')
+        self.discount_limit = attributes[:'discount_limit']
       end
 
-      if attributes.has_key?(:'expiryDate')
-        self.expiry_date = attributes[:'expiryDate']
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
       end
     end
 
@@ -74,6 +96,14 @@ module TalonOne
         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
+
       invalid_properties
     end
 
@@ -82,6 +112,8 @@ module TalonOne
     def valid?
       return false if !@usage_limit.nil? && @usage_limit > 999999
       return false if !@usage_limit.nil? && @usage_limit < 0
+      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit < 0
       true
     end
 
@@ -99,12 +131,27 @@ module TalonOne
       @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
+
     # 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
     end
@@ -116,9 +163,16 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [usage_limit, start_date, expiry_date].hash
+      [usage_limit, discount_limit, start_date, expiry_date].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
@@ -126,9 +180,9 @@ module TalonOne
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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) })
@@ -157,7 +211,7 @@ module TalonOne
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -178,8 +232,7 @@ module TalonOne
           end
         end
       else # model
-        temp_model = TalonOne.const_get(type).new
-        temp_model.build_from_hash(value)
+        TalonOne.const_get(type).build_from_hash(value)
       end
     end
 
@@ -201,7 +254,11 @@ module TalonOne
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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