talon_one 9.0.0 → 11.0.0

data/lib/talon_one/models/added_deducted_points_notification.rb

@@ -0,0 +1,478 @@
+=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 AddedDeductedPointsNotification
+    # The integration ID of the customer profile to whom points were added or deducted.
+    attr_accessor :profile_integration_id
+
+    # The ID of the loyalty program.
+    attr_accessor :loyalty_program_id
+
+    # The ID of the subledger within the loyalty program where these points were added.
+    attr_accessor :subledger_id
+
+    # The amount of added or deducted loyalty points.
+    attr_accessor :amount
+
+    # The reason for the points addition or deduction.
+    attr_accessor :reason
+
+    # The notification source, that is, it indicates whether the points were added or deducted via one of the following routes:  - [The Campaign Manager](/docs/product/getting-started)  - [Management API](/management-api#tag/Loyalty)  - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters) 
+    attr_accessor :type_of_change
+
+    # The name of the employee who added or deducted points.
+    attr_accessor :employee_name
+
+    # The ID of the employee who added or deducted points.
+    attr_accessor :user_id
+
+    # The action (addition or deduction) made with loyalty points.
+    attr_accessor :operation
+
+    # The start date for loyalty points.
+    attr_accessor :start_date
+
+    # The expiration date for loyalty points.
+    attr_accessor :expiry_date
+
+    # The integration ID of the session through which the points were earned or lost.
+    attr_accessor :session_integration_id
+
+    # The type of notification.
+    attr_accessor :notification_type
+
+    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
+      {
+        :'profile_integration_id' => :'ProfileIntegrationID',
+        :'loyalty_program_id' => :'LoyaltyProgramID',
+        :'subledger_id' => :'SubledgerID',
+        :'amount' => :'Amount',
+        :'reason' => :'Reason',
+        :'type_of_change' => :'TypeOfChange',
+        :'employee_name' => :'EmployeeName',
+        :'user_id' => :'UserID',
+        :'operation' => :'Operation',
+        :'start_date' => :'StartDate',
+        :'expiry_date' => :'ExpiryDate',
+        :'session_integration_id' => :'SessionIntegrationID',
+        :'notification_type' => :'NotificationType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'profile_integration_id' => :'String',
+        :'loyalty_program_id' => :'Integer',
+        :'subledger_id' => :'String',
+        :'amount' => :'Float',
+        :'reason' => :'String',
+        :'type_of_change' => :'String',
+        :'employee_name' => :'String',
+        :'user_id' => :'Integer',
+        :'operation' => :'String',
+        :'start_date' => :'DateTime',
+        :'expiry_date' => :'DateTime',
+        :'session_integration_id' => :'String',
+        :'notification_type' => :'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::AddedDeductedPointsNotification` 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::AddedDeductedPointsNotification`. 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?(:'profile_integration_id')
+        self.profile_integration_id = attributes[:'profile_integration_id']
+      end
+
+      if attributes.key?(:'loyalty_program_id')
+        self.loyalty_program_id = attributes[:'loyalty_program_id']
+      end
+
+      if attributes.key?(:'subledger_id')
+        self.subledger_id = attributes[:'subledger_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'type_of_change')
+        self.type_of_change = attributes[:'type_of_change']
+      end
+
+      if attributes.key?(:'employee_name')
+        self.employee_name = attributes[:'employee_name']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'operation')
+        self.operation = attributes[:'operation']
+      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?(:'session_integration_id')
+        self.session_integration_id = attributes[:'session_integration_id']
+      end
+
+      if attributes.key?(:'notification_type')
+        self.notification_type = attributes[:'notification_type']
+      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 @profile_integration_id.nil?
+        invalid_properties.push('invalid value for "profile_integration_id", profile_integration_id cannot be nil.')
+      end
+
+      if @loyalty_program_id.nil?
+        invalid_properties.push('invalid value for "loyalty_program_id", loyalty_program_id cannot be nil.')
+      end
+
+      if @loyalty_program_id < 1
+        invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
+      end
+
+      if @subledger_id.nil?
+        invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @reason.nil?
+        invalid_properties.push('invalid value for "reason", reason cannot be nil.')
+      end
+
+      if @type_of_change.nil?
+        invalid_properties.push('invalid value for "type_of_change", type_of_change cannot be nil.')
+      end
+
+      if @employee_name.nil?
+        invalid_properties.push('invalid value for "employee_name", employee_name cannot be nil.')
+      end
+
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @user_id < 1
+        invalid_properties.push('invalid value for "user_id", must be greater than or equal to 1.')
+      end
+
+      if @operation.nil?
+        invalid_properties.push('invalid value for "operation", operation cannot be nil.')
+      end
+
+      if @session_integration_id.nil?
+        invalid_properties.push('invalid value for "session_integration_id", session_integration_id cannot be nil.')
+      end
+
+      if @notification_type.nil?
+        invalid_properties.push('invalid value for "notification_type", notification_type 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 @profile_integration_id.nil?
+      return false if @loyalty_program_id.nil?
+      return false if @loyalty_program_id < 1
+      return false if @subledger_id.nil?
+      return false if @amount.nil?
+      return false if @reason.nil?
+      return false if @type_of_change.nil?
+      type_of_change_validator = EnumAttributeValidator.new('String', ["campaign_manager", "rule_engine", "management_api"])
+      return false unless type_of_change_validator.valid?(@type_of_change)
+      return false if @employee_name.nil?
+      return false if @user_id.nil?
+      return false if @user_id < 1
+      return false if @operation.nil?
+      operation_validator = EnumAttributeValidator.new('String', ["addition", "deduction"])
+      return false unless operation_validator.valid?(@operation)
+      return false if @session_integration_id.nil?
+      return false if @notification_type.nil?
+      notification_type_validator = EnumAttributeValidator.new('String', ["LoyaltyPointsDeducted", "LoyaltyPointsAdded"])
+      return false unless notification_type_validator.valid?(@notification_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] loyalty_program_id Value to be assigned
+    def loyalty_program_id=(loyalty_program_id)
+      if loyalty_program_id.nil?
+        fail ArgumentError, 'loyalty_program_id cannot be nil'
+      end
+
+      if loyalty_program_id < 1
+        fail ArgumentError, 'invalid value for "loyalty_program_id", must be greater than or equal to 1.'
+      end
+
+      @loyalty_program_id = loyalty_program_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type_of_change Object to be assigned
+    def type_of_change=(type_of_change)
+      validator = EnumAttributeValidator.new('String', ["campaign_manager", "rule_engine", "management_api"])
+      unless validator.valid?(type_of_change)
+        fail ArgumentError, "invalid value for \"type_of_change\", must be one of #{validator.allowable_values}."
+      end
+      @type_of_change = type_of_change
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_id Value to be assigned
+    def user_id=(user_id)
+      if user_id.nil?
+        fail ArgumentError, 'user_id cannot be nil'
+      end
+
+      if user_id < 1
+        fail ArgumentError, 'invalid value for "user_id", must be greater than or equal to 1.'
+      end
+
+      @user_id = user_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operation Object to be assigned
+    def operation=(operation)
+      validator = EnumAttributeValidator.new('String', ["addition", "deduction"])
+      unless validator.valid?(operation)
+        fail ArgumentError, "invalid value for \"operation\", must be one of #{validator.allowable_values}."
+      end
+      @operation = operation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] notification_type Object to be assigned
+    def notification_type=(notification_type)
+      validator = EnumAttributeValidator.new('String', ["LoyaltyPointsDeducted", "LoyaltyPointsAdded"])
+      unless validator.valid?(notification_type)
+        fail ArgumentError, "invalid value for \"notification_type\", must be one of #{validator.allowable_values}."
+      end
+      @notification_type = notification_type
+    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 &&
+          profile_integration_id == o.profile_integration_id &&
+          loyalty_program_id == o.loyalty_program_id &&
+          subledger_id == o.subledger_id &&
+          amount == o.amount &&
+          reason == o.reason &&
+          type_of_change == o.type_of_change &&
+          employee_name == o.employee_name &&
+          user_id == o.user_id &&
+          operation == o.operation &&
+          start_date == o.start_date &&
+          expiry_date == o.expiry_date &&
+          session_integration_id == o.session_integration_id &&
+          notification_type == o.notification_type
+    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
+      [profile_integration_id, loyalty_program_id, subledger_id, amount, reason, type_of_change, employee_name, user_id, operation, start_date, expiry_date, session_integration_id, notification_type].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/analytics_sku.rb

@@ -14,15 +14,21 @@ require 'date'
 
 module TalonOne
   class AnalyticsSKU
-    # The ID of the SKU linked to the application.
+    # The ID of the SKU linked to the Application.
     attr_accessor :id
 
-    # The SKU linked to the application.
+    # The SKU linked to the Application.
     attr_accessor :sku
 
     # Values in UTC for the date the SKU linked to the product was last updated.
     attr_accessor :last_updated
 
+    # The ID of the catalog that contains the SKU.
+    attr_accessor :catalog_id
+
+    # The ID of the product that the SKU belongs to.
+    attr_accessor :product_id
+
     attr_accessor :units_sold
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -31,6 +37,8 @@ module TalonOne
         :'id' => :'id',
         :'sku' => :'sku',
         :'last_updated' => :'lastUpdated',
+        :'catalog_id' => :'catalogId',
+        :'product_id' => :'productId',
         :'units_sold' => :'unitsSold'
       }
     end
@@ -41,6 +49,8 @@ module TalonOne
         :'id' => :'Integer',
         :'sku' => :'String',
         :'last_updated' => :'DateTime',
+        :'catalog_id' => :'Integer',
+        :'product_id' => :'Integer',
         :'units_sold' => :'AnalyticsDataPointWithTrend'
       }
     end
@@ -78,6 +88,14 @@ module TalonOne
         self.last_updated = attributes[:'last_updated']
       end
 
+      if attributes.key?(:'catalog_id')
+        self.catalog_id = attributes[:'catalog_id']
+      end
+
+      if attributes.key?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      end
+
       if attributes.key?(:'units_sold')
         self.units_sold = attributes[:'units_sold']
       end
@@ -114,6 +132,8 @@ module TalonOne
           id == o.id &&
           sku == o.sku &&
           last_updated == o.last_updated &&
+          catalog_id == o.catalog_id &&
+          product_id == o.product_id &&
           units_sold == o.units_sold
     end
 
@@ -126,7 +146,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, sku, last_updated, units_sold].hash
+      [id, sku, last_updated, catalog_id, product_id, units_sold].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Application
-    # 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/application_cif.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationCIF
-    # 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/application_cif_expression.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationCIFExpression
-    # 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/application_customer.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationCustomer
-    # Internal ID of this entity.
+    # The internal ID of the customer profile.
     attr_accessor :id
 
     # The time this entity was created.
@@ -29,13 +29,13 @@ module TalonOne
     # The ID of the Talon.One account that owns this profile.
     attr_accessor :account_id
 
-    # The total amount of closed sessions by a customer. A closed session is a successful purchase.
+    # The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
     attr_accessor :closed_sessions
 
     # The total amount of money spent by the customer **before** discounts are applied.  The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. 
     attr_accessor :total_sales
 
-    # **DEPRECATED** A list of loyalty programs joined by the customer. 
+    # **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. 
     attr_accessor :loyalty_memberships
 
     # The audiences the customer belongs to.

data/lib/talon_one/models/application_event.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationEvent
-    # 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/application_session.rb

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