talon_one 8.0.0 → 10.0.0

data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb

@@ -0,0 +1,295 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class IntegrationCustomerProfileAudienceRequestItem
+    # Defines the action to perform: - `add`: Adds the customer profile to the audience.    **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application   until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. 
+    attr_accessor :action
+
+    # The ID of this customer profile in the third-party integration.
+    attr_accessor :profile_integration_id
+
+    # The ID of this audience in the third-party integration.
+    attr_accessor :integration_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'profile_integration_id' => :'profileIntegrationId',
+        :'integration_id' => :'integrationId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'action' => :'String',
+        :'profile_integration_id' => :'String',
+        :'integration_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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::IntegrationCustomerProfileAudienceRequestItem` 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::IntegrationCustomerProfileAudienceRequestItem`. 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?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'profile_integration_id')
+        self.profile_integration_id = attributes[:'profile_integration_id']
+      end
+
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      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 @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @profile_integration_id.nil?
+        invalid_properties.push('invalid value for "profile_integration_id", profile_integration_id cannot be nil.')
+      end
+
+      if @profile_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "profile_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id 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 @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["add", "delete"])
+      return false unless action_validator.valid?(@action)
+      return false if @profile_integration_id.nil?
+      return false if @profile_integration_id.to_s.length > 1000
+      return false if @integration_id.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["add", "delete"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
+      end
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] profile_integration_id Value to be assigned
+    def profile_integration_id=(profile_integration_id)
+      if profile_integration_id.nil?
+        fail ArgumentError, 'profile_integration_id cannot be nil'
+      end
+
+      if profile_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "profile_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @profile_integration_id = profile_integration_id
+    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 &&
+          action == o.action &&
+          profile_integration_id == o.profile_integration_id &&
+          integration_id == o.integration_id
+    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
+      [action, profile_integration_id, integration_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
+    # @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/integration_event_v2_request.rb

@@ -29,6 +29,9 @@ module TalonOne
     # Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
     attr_accessor :attributes
 
+    # Identifier of the loyalty card used during this event.
+    attr_accessor :loyalty_cards
+
     # Optional list of requested information to be present on the response related to the tracking custom event. 
     attr_accessor :response_content
 
@@ -62,6 +65,7 @@ module TalonOne
         :'evaluable_campaign_ids' => :'evaluableCampaignIds',
         :'type' => :'type',
         :'attributes' => :'attributes',
+        :'loyalty_cards' => :'loyaltyCards',
         :'response_content' => :'responseContent'
       }
     end
@@ -74,6 +78,7 @@ module TalonOne
         :'evaluable_campaign_ids' => :'Array<Integer>',
         :'type' => :'String',
         :'attributes' => :'Object',
+        :'loyalty_cards' => :'Array<String>',
         :'response_content' => :'Array<String>'
       }
     end
@@ -121,6 +126,12 @@ module TalonOne
         self.attributes = attributes[:'attributes']
       end
 
+      if attributes.key?(:'loyalty_cards')
+        if (value = attributes[:'loyalty_cards']).is_a?(Array)
+          self.loyalty_cards = value
+        end
+      end
+
       if attributes.key?(:'response_content')
         if (value = attributes[:'response_content']).is_a?(Array)
           self.response_content = value
@@ -199,6 +210,7 @@ module TalonOne
           evaluable_campaign_ids == o.evaluable_campaign_ids &&
           type == o.type &&
           attributes == o.attributes &&
+          loyalty_cards == o.loyalty_cards &&
           response_content == o.response_content
     end
 
@@ -211,7 +223,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, store_integration_id, evaluable_campaign_ids, type, attributes, response_content].hash
+      [profile_id, store_integration_id, evaluable_campaign_ids, type, attributes, loyalty_cards, response_content].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/inventory_coupon.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module TalonOne
   class InventoryCoupon
-    # Internal ID of this entity.
+    # The internal ID of the coupon.
     attr_accessor :id
 
-    # The time this entity was created.
+    # The time the coupon was created.
     attr_accessor :created
 
     # The ID of the campaign that owns this entity.
@@ -306,8 +306,8 @@ 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.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -352,7 +352,7 @@ 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 > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -398,8 +398,8 @@ module TalonOne
     # 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.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/inventory_referral.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class InventoryReferral
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/ledger_entry.rb

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # Entry in the point ledger.
   class LedgerEntry
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/ledger_info.rb

@@ -150,10 +150,6 @@ module TalonOne
         invalid_properties.push('invalid value for "pending_balance", pending_balance cannot be nil.')
       end
 
-      if @negative_balance.nil?
-        invalid_properties.push('invalid value for "negative_balance", negative_balance cannot be nil.')
-      end
-
       if @expired_balance.nil?
         invalid_properties.push('invalid value for "expired_balance", expired_balance cannot be nil.')
       end
@@ -166,10 +162,6 @@ module TalonOne
         invalid_properties.push('invalid value for "tentative_current_balance", tentative_current_balance cannot be nil.')
       end
 
-      if @tentative_negative_balance.nil?
-        invalid_properties.push('invalid value for "tentative_negative_balance", tentative_negative_balance cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -178,11 +170,9 @@ module TalonOne
     def valid?
       return false if @current_balance.nil?
       return false if @pending_balance.nil?
-      return false if @negative_balance.nil?
       return false if @expired_balance.nil?
       return false if @spent_balance.nil?
       return false if @tentative_current_balance.nil?
-      return false if @tentative_negative_balance.nil?
       true
     end
 

data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb

@@ -51,6 +51,8 @@ module TalonOne
     # The name of the rule that triggered this effect.
     attr_accessor :rule_name
 
+    attr_accessor :flags
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -87,7 +89,8 @@ module TalonOne
         :'amount' => :'amount',
         :'id' => :'id',
         :'ruleset_id' => :'rulesetId',
-        :'rule_name' => :'ruleName'
+        :'rule_name' => :'ruleName',
+        :'flags' => :'flags'
       }
     end
 
@@ -105,7 +108,8 @@ module TalonOne
         :'amount' => :'Float',
         :'id' => :'Integer',
         :'ruleset_id' => :'Integer',
-        :'rule_name' => :'String'
+        :'rule_name' => :'String',
+        :'flags' => :'LoyaltyLedgerEntryFlags'
       }
     end
 
@@ -177,6 +181,10 @@ module TalonOne
       if attributes.key?(:'rule_name')
         self.rule_name = attributes[:'rule_name']
       end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -342,7 +350,8 @@ module TalonOne
           amount == o.amount &&
           id == o.id &&
           ruleset_id == o.ruleset_id &&
-          rule_name == o.rule_name
+          rule_name == o.rule_name &&
+          flags == o.flags
     end
 
     # @see the `==` method
@@ -354,7 +363,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created, program_id, customer_session_id, type, name, start_date, expiry_date, subledger_id, amount, id, ruleset_id, rule_name].hash
+      [created, program_id, customer_session_id, type, name, start_date, expiry_date, subledger_id, amount, id, ruleset_id, rule_name, flags].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_card.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class LoyaltyCard
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.