talon_one 2.5.1 → 3.0.0

data/lib/talon_one/models/item_attribute.rb

@@ -0,0 +1,243 @@
+=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 ItemAttribute
+    # The ID of the attribute of the item.
+    attr_accessor :attributeid
+
+    # The name of the attribute.
+    attr_accessor :name
+
+    # The value of the attribute.
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributeid' => :'attributeid',
+        :'name' => :'name',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attributeid' => :'Integer',
+        :'name' => :'String',
+        :'value' => :'Object'
+      }
+    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::ItemAttribute` 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::ItemAttribute`. 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?(:'attributeid')
+        self.attributeid = attributes[:'attributeid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 @attributeid.nil?
+        invalid_properties.push('invalid value for "attributeid", attributeid cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value 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 @attributeid.nil?
+      return false if @name.nil?
+      return false if @value.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 &&
+          attributeid == o.attributeid &&
+          name == o.name &&
+          value == o.value
+    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
+      [attributeid, name, value].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/ledger_entry.rb

@@ -1,9 +1,9 @@
 =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}` 
+#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: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,34 +15,34 @@ require 'date'
 module TalonOne
   # 
   class LedgerEntry
-    # Unique ID for this entity.
+    # Internal ID of this entity.
     attr_accessor :id
 
-    # The exact moment this entity was created.
+    # The time this entity was created.
     attr_accessor :created
 
-    # ID of the customers profile as used within this Talon.One account.  **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. 
+    # ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. 
     attr_accessor :profile_id
 
     # The ID of the Talon.One account that owns this profile.
     attr_accessor :account_id
 
-    # ID of the ledger
+    # ID of the ledger.
     attr_accessor :loyalty_program_id
 
-    # ID of the related event
+    # ID of the related event.
     attr_accessor :event_id
 
-    # Amount of loyalty points
+    # Amount of loyalty points.
     attr_accessor :amount
 
-    # reason for awarding/deducting points
+    # reason for awarding/deducting points.
     attr_accessor :reason
 
-    # Expiry date of the points
+    # Expiration date of the points.
     attr_accessor :expiry_date
 
-    # The ID of the balancing ledgerEntry
+    # The ID of the balancing ledgerEntry.
     attr_accessor :reference_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/ledger_info.rb

@@ -1,9 +1,9 @@
 =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}` 
+#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: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,28 +15,29 @@ require 'date'
 module TalonOne
   # 
   class LedgerInfo
-    # Sum of currently active points
+    # Sum of currently active points.
     attr_accessor :current_balance
 
-    # Sum of pending points
+    # Sum of pending points.
     attr_accessor :pending_balance
 
-    # Sum of expired points
+    # **DEPRECATED** Value is shown as 0. 
     attr_accessor :expired_balance
 
-    # Sum of spent points
+    # **DEPRECATED** Value is shown as 0. 
     attr_accessor :spent_balance
 
-    # Sum of currently active points, including points added and deducted in open sessions
+    # Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied.
     attr_accessor :tentative_current_balance
 
+    # Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied.
+    attr_accessor :tentative_pending_balance
+
     attr_accessor :current_tier
 
     # Points required to move up a tier.
     attr_accessor :points_to_next_tier
 
-    attr_accessor :projection
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,9 +46,9 @@ module TalonOne
         :'expired_balance' => :'expiredBalance',
         :'spent_balance' => :'spentBalance',
         :'tentative_current_balance' => :'tentativeCurrentBalance',
+        :'tentative_pending_balance' => :'tentativePendingBalance',
         :'current_tier' => :'currentTier',
-        :'points_to_next_tier' => :'pointsToNextTier',
-        :'projection' => :'projection'
+        :'points_to_next_tier' => :'pointsToNextTier'
       }
     end
 
@@ -59,9 +60,9 @@ module TalonOne
         :'expired_balance' => :'Float',
         :'spent_balance' => :'Float',
         :'tentative_current_balance' => :'Float',
+        :'tentative_pending_balance' => :'Float',
         :'current_tier' => :'Tier',
-        :'points_to_next_tier' => :'Float',
-        :'projection' => :'LoyaltyProjection'
+        :'points_to_next_tier' => :'Float'
       }
     end
 
@@ -106,6 +107,10 @@ module TalonOne
         self.tentative_current_balance = attributes[:'tentative_current_balance']
       end
 
+      if attributes.key?(:'tentative_pending_balance')
+        self.tentative_pending_balance = attributes[:'tentative_pending_balance']
+      end
+
       if attributes.key?(:'current_tier')
         self.current_tier = attributes[:'current_tier']
       end
@@ -113,10 +118,6 @@ module TalonOne
       if attributes.key?(:'points_to_next_tier')
         self.points_to_next_tier = attributes[:'points_to_next_tier']
       end
-
-      if attributes.key?(:'projection')
-        self.projection = attributes[:'projection']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,9 +168,9 @@ module TalonOne
           expired_balance == o.expired_balance &&
           spent_balance == o.spent_balance &&
           tentative_current_balance == o.tentative_current_balance &&
+          tentative_pending_balance == o.tentative_pending_balance &&
           current_tier == o.current_tier &&
-          points_to_next_tier == o.points_to_next_tier &&
-          projection == o.projection
+          points_to_next_tier == o.points_to_next_tier
     end
 
     # @see the `==` method
@@ -181,7 +182,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [current_balance, pending_balance, expired_balance, spent_balance, tentative_current_balance, current_tier, points_to_next_tier, projection].hash
+      [current_balance, pending_balance, expired_balance, spent_balance, tentative_current_balance, tentative_pending_balance, current_tier, points_to_next_tier].hash
     end
 
     # Builds the object from hash