talon_one 2.4.0 → 2.5.1

data/lib/talon_one/models/new_invitation.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
 
@@ -20,7 +20,7 @@ module TalonOne
 
     attr_accessor :email
 
-    # a blob of acl json
+    # The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` 
     attr_accessor :acl
 
     # An array of roleIDs to assign the new user to

data/lib/talon_one/models/new_invite_email.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
 

data/lib/talon_one/models/new_loyalty_program.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
 
@@ -13,11 +13,8 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # A new loyalty program
+  # 
   class NewLoyaltyProgram
-    # The internal name for the Loyalty Program. This is an immutable value.
-    attr_accessor :name
-
     # The display title for the Loyalty Program.
     attr_accessor :title
 
@@ -36,29 +33,52 @@ module TalonOne
     # Indicates if this program supports subledgers inside the program
     attr_accessor :allow_subledger
 
+    # The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. 
+    attr_accessor :users_per_card_limit
+
+    # The internal name for the Loyalty Program. This is an immutable value.
+    attr_accessor :name
+
+    # The tiers in this loyalty program
+    attr_accessor :tiers
+
+    # A string containing an IANA timezone descriptor.
+    attr_accessor :timezone
+
+    # Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. 
+    attr_accessor :card_based
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
         :'title' => :'title',
         :'description' => :'description',
         :'subscribed_applications' => :'subscribedApplications',
         :'default_validity' => :'defaultValidity',
         :'default_pending' => :'defaultPending',
-        :'allow_subledger' => :'allowSubledger'
+        :'allow_subledger' => :'allowSubledger',
+        :'users_per_card_limit' => :'usersPerCardLimit',
+        :'name' => :'name',
+        :'tiers' => :'tiers',
+        :'timezone' => :'timezone',
+        :'card_based' => :'cardBased'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
         :'title' => :'String',
         :'description' => :'String',
         :'subscribed_applications' => :'Array<Integer>',
         :'default_validity' => :'String',
         :'default_pending' => :'String',
-        :'allow_subledger' => :'Boolean'
+        :'allow_subledger' => :'Boolean',
+        :'users_per_card_limit' => :'Integer',
+        :'name' => :'String',
+        :'tiers' => :'Array<NewLoyaltyTier>',
+        :'timezone' => :'String',
+        :'card_based' => :'Boolean'
       }
     end
 
@@ -83,10 +103,6 @@ module TalonOne
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
       if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
@@ -112,16 +128,36 @@ module TalonOne
       if attributes.key?(:'allow_subledger')
         self.allow_subledger = attributes[:'allow_subledger']
       end
+
+      if attributes.key?(:'users_per_card_limit')
+        self.users_per_card_limit = attributes[:'users_per_card_limit']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'tiers')
+        if (value = attributes[:'tiers']).is_a?(Array)
+          self.tiers = value
+        end
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'card_based')
+        self.card_based = attributes[:'card_based']
+      else
+        self.card_based = 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 @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
       if @title.nil?
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
@@ -138,32 +174,84 @@ module TalonOne
         invalid_properties.push('invalid value for "allow_subledger", allow_subledger cannot be nil.')
       end
 
+      if !@users_per_card_limit.nil? && @users_per_card_limit < 0
+        invalid_properties.push('invalid value for "users_per_card_limit", must be greater than or equal to 0.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
+      end
+
+      if @timezone.to_s.length < 1
+        invalid_properties.push('invalid value for "timezone", the character length must be great than or equal to 1.')
+      end
+
+      if @card_based.nil?
+        invalid_properties.push('invalid value for "card_based", card_based 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 @title.nil?
       return false if @default_validity.nil?
       return false if @default_pending.nil?
       return false if @allow_subledger.nil?
+      return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
+      return false if @name.nil?
+      return false if @timezone.nil?
+      return false if @timezone.to_s.length < 1
+      return false if @card_based.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] users_per_card_limit Value to be assigned
+    def users_per_card_limit=(users_per_card_limit)
+      if !users_per_card_limit.nil? && users_per_card_limit < 0
+        fail ArgumentError, 'invalid value for "users_per_card_limit", must be greater than or equal to 0.'
+      end
+
+      @users_per_card_limit = users_per_card_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timezone Value to be assigned
+    def timezone=(timezone)
+      if timezone.nil?
+        fail ArgumentError, 'timezone cannot be nil'
+      end
+
+      if timezone.to_s.length < 1
+        fail ArgumentError, 'invalid value for "timezone", the character length must be great than or equal to 1.'
+      end
+
+      @timezone = timezone
+    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 &&
           title == o.title &&
           description == o.description &&
           subscribed_applications == o.subscribed_applications &&
           default_validity == o.default_validity &&
           default_pending == o.default_pending &&
-          allow_subledger == o.allow_subledger
+          allow_subledger == o.allow_subledger &&
+          users_per_card_limit == o.users_per_card_limit &&
+          name == o.name &&
+          tiers == o.tiers &&
+          timezone == o.timezone &&
+          card_based == o.card_based
     end
 
     # @see the `==` method
@@ -175,7 +263,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, title, description, subscribed_applications, default_validity, default_pending, allow_subledger].hash
+      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, name, tiers, timezone, card_based].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_loyalty_tier.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
 
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # A new loyalty tier
+  # A tier in a loyalty program
   class NewLoyaltyTier
     # The name of the tier
     attr_accessor :name
@@ -79,8 +79,8 @@ module TalonOne
         invalid_properties.push('invalid value for "min_points", min_points cannot be nil.')
       end
 
-      if @min_points >= 1E+8
-        invalid_properties.push('invalid value for "min_points", must be smaller than 1E+8.')
+      if @min_points > 999999999999.99
+        invalid_properties.push('invalid value for "min_points", must be smaller than or equal to 999999999999.99.')
       end
 
       if @min_points < 0
@@ -95,7 +95,7 @@ module TalonOne
     def valid?
       return false if @name.nil?
       return false if @min_points.nil?
-      return false if @min_points >= 1E+8
+      return false if @min_points > 999999999999.99
       return false if @min_points < 0
       true
     end
@@ -107,8 +107,8 @@ module TalonOne
         fail ArgumentError, 'min_points cannot be nil'
       end
 
-      if min_points >= 1E+8
-        fail ArgumentError, 'invalid value for "min_points", must be smaller than 1E+8.'
+      if min_points > 999999999999.99
+        fail ArgumentError, 'invalid value for "min_points", must be smaller than or equal to 999999999999.99.'
       end
 
       if min_points < 0

data/lib/talon_one/models/new_notification_webhook.rb

@@ -0,0 +1,229 @@
+=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 NewNotificationWebhook
+    # API url for this notification webhook
+    attr_accessor :url
+
+    # List of API HTTP headers for this notification webhook
+    attr_accessor :headers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'url',
+        :'headers' => :'headers'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'url' => :'String',
+        :'headers' => :'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::NewNotificationWebhook` 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::NewNotificationWebhook`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Array)
+          self.headers = 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 @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @headers.nil?
+        invalid_properties.push('invalid value for "headers", headers 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 @url.nil?
+      return false if @headers.nil?
+      true
+    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 &&
+          url == o.url &&
+          headers == o.headers
+    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
+      [url, headers].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_password.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
 

data/lib/talon_one/models/new_password_email.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
 

data/lib/talon_one/models/new_referral.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
 
@@ -21,7 +21,7 @@ module TalonOne
     # Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative.
     attr_accessor :expiry_date
 
-    # The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 
     attr_accessor :usage_limit
 
     # ID of the campaign from which the referral received the referral code.
@@ -132,6 +132,10 @@ module TalonOne
         invalid_properties.push('invalid value for "advocate_profile_integration_id", advocate_profile_integration_id cannot be nil.')
       end
 
+      if @advocate_profile_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "advocate_profile_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       invalid_properties
     end
 
@@ -142,6 +146,7 @@ module TalonOne
       return false if !@usage_limit.nil? && @usage_limit < 0
       return false if @campaign_id.nil?
       return false if @advocate_profile_integration_id.nil?
+      return false if @advocate_profile_integration_id.to_s.length > 1000
       true
     end
 
@@ -159,6 +164,20 @@ module TalonOne
       @usage_limit = usage_limit
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] advocate_profile_integration_id Value to be assigned
+    def advocate_profile_integration_id=(advocate_profile_integration_id)
+      if advocate_profile_integration_id.nil?
+        fail ArgumentError, 'advocate_profile_integration_id cannot be nil'
+      end
+
+      if advocate_profile_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "advocate_profile_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @advocate_profile_integration_id = advocate_profile_integration_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/talon_one/models/new_referrals_for_multiple_advocates.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
 
@@ -21,7 +21,7 @@ module TalonOne
     # Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative.
     attr_accessor :expiry_date
 
-    # The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 
     attr_accessor :usage_limit
 
     # The ID of the campaign from which the referral received the referral code.
@@ -33,10 +33,10 @@ module TalonOne
     # Arbitrary properties associated with this item.
     attr_accessor :attributes
 
-    # 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 referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. 
+    # The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. 
     attr_accessor :referral_pattern
 
     # Attribute mapping from ruby-style variable name to JSON key.