talon_one 1.3.0 → 2.2.0

data/lib/talon_one/models/loyalty_program_ledgers.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
 
@@ -15,13 +15,12 @@ require 'date'
 module TalonOne
   # Customer specific information about loyalty points.
   class LoyaltyProgramLedgers
-    # Visable name of loyalty program
+    # Visible name of loyalty program
     attr_accessor :title
 
     # Internal name of loyalty program
     attr_accessor :name
 
-    # The balance of the main ledger in the loyalty program
     attr_accessor :ledger
 
     # A map containing a list of all loyalty subledger balances
@@ -38,7 +37,7 @@ module TalonOne
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'title' => :'String',
         :'name' => :'String',
@@ -47,28 +46,41 @@ module TalonOne
       }
     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::LoyaltyProgramLedgers` 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::LoyaltyProgramLedgers`. 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?(:'title')
+      if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
 
-      if attributes.has_key?(:'name')
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'ledger')
+      if attributes.key?(:'ledger')
         self.ledger = attributes[:'ledger']
       end
 
-      if attributes.has_key?(:'subLedgers')
-        if (value = attributes[:'subLedgers']).is_a?(Hash)
+      if attributes.key?(:'sub_ledgers')
+        if (value = attributes[:'sub_ledgers']).is_a?(Hash)
           self.sub_ledgers = value
         end
       end
@@ -120,19 +132,26 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [title, name, ledger, sub_ledgers].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.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) })
@@ -161,7 +180,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
@@ -182,8 +201,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
 
@@ -205,7 +223,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/loyalty_statistics.rb

@@ -0,0 +1,258 @@
+=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 
+
+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 LoyaltyStatistics
+    # Total of active points for this loyalty program
+    attr_accessor :total_active_points
+
+    # Total of pending points for this loyalty program
+    attr_accessor :total_pending_points
+
+    # Total of spent points for this loyalty program
+    attr_accessor :total_spent_points
+
+    # Total of expired points for this loyalty program
+    attr_accessor :total_expired_points
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total_active_points' => :'totalActivePoints',
+        :'total_pending_points' => :'totalPendingPoints',
+        :'total_spent_points' => :'totalSpentPoints',
+        :'total_expired_points' => :'totalExpiredPoints'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total_active_points' => :'Float',
+        :'total_pending_points' => :'Float',
+        :'total_spent_points' => :'Float',
+        :'total_expired_points' => :'Float'
+      }
+    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::LoyaltyStatistics` 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::LoyaltyStatistics`. 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?(:'total_active_points')
+        self.total_active_points = attributes[:'total_active_points']
+      end
+
+      if attributes.key?(:'total_pending_points')
+        self.total_pending_points = attributes[:'total_pending_points']
+      end
+
+      if attributes.key?(:'total_spent_points')
+        self.total_spent_points = attributes[:'total_spent_points']
+      end
+
+      if attributes.key?(:'total_expired_points')
+        self.total_expired_points = attributes[:'total_expired_points']
+      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 @total_active_points.nil?
+        invalid_properties.push('invalid value for "total_active_points", total_active_points cannot be nil.')
+      end
+
+      if @total_pending_points.nil?
+        invalid_properties.push('invalid value for "total_pending_points", total_pending_points cannot be nil.')
+      end
+
+      if @total_spent_points.nil?
+        invalid_properties.push('invalid value for "total_spent_points", total_spent_points cannot be nil.')
+      end
+
+      if @total_expired_points.nil?
+        invalid_properties.push('invalid value for "total_expired_points", total_expired_points 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 @total_active_points.nil?
+      return false if @total_pending_points.nil?
+      return false if @total_spent_points.nil?
+      return false if @total_expired_points.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 &&
+          total_active_points == o.total_active_points &&
+          total_pending_points == o.total_pending_points &&
+          total_spent_points == o.total_spent_points &&
+          total_expired_points == o.total_expired_points
+    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
+      [total_active_points, total_pending_points, total_spent_points, total_expired_points].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/loyalty_sub_ledger.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
 
@@ -15,55 +15,138 @@ require 'date'
 module TalonOne
   # Ledger of Balance in Loyalty Program for a Customer
   class LoyaltySubLedger
+    # ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance 
     attr_accessor :total
 
-    # Transactions contains a list of all events that have happened such as additions, subtractions and expiries
+    # Total amount of currently active and available points in the customer's balance
+    attr_accessor :total_active_points
+
+    # Total amount of pending points, which are not active yet but will become active in the future
+    attr_accessor :total_pending_points
+
+    # Total amount of points already spent by this customer
+    attr_accessor :total_spent_points
+
+    # Total amount of points, that expired without ever being spent
+    attr_accessor :total_expired_points
+
+    # List of all events that have happened such as additions, subtractions and expiries
     attr_accessor :transactions
 
-    # ExpiringPoints contains a list of all points that will expiry and when
+    # List of all points that will expire
     attr_accessor :expiring_points
 
+    # List of all currently active points
+    attr_accessor :active_points
+
+    # List of all points pending activation
+    attr_accessor :pending_points
+
+    # List of expired points
+    attr_accessor :expired_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'total' => :'total',
+        :'total_active_points' => :'totalActivePoints',
+        :'total_pending_points' => :'totalPendingPoints',
+        :'total_spent_points' => :'totalSpentPoints',
+        :'total_expired_points' => :'totalExpiredPoints',
         :'transactions' => :'transactions',
-        :'expiring_points' => :'expiringPoints'
+        :'expiring_points' => :'expiringPoints',
+        :'active_points' => :'activePoints',
+        :'pending_points' => :'pendingPoints',
+        :'expired_points' => :'expiredPoints'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'total' => :'Float',
+        :'total_active_points' => :'Float',
+        :'total_pending_points' => :'Float',
+        :'total_spent_points' => :'Float',
+        :'total_expired_points' => :'Float',
         :'transactions' => :'Array<LoyaltyLedgerEntry>',
-        :'expiring_points' => :'Array<LoyaltyLedgerEntry>'
+        :'expiring_points' => :'Array<LoyaltyLedgerEntry>',
+        :'active_points' => :'Array<LoyaltyLedgerEntry>',
+        :'pending_points' => :'Array<LoyaltyLedgerEntry>',
+        :'expired_points' => :'Array<LoyaltyLedgerEntry>'
       }
     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::LoyaltySubLedger` 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::LoyaltySubLedger`. 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?(:'total')
+      if attributes.key?(:'total')
         self.total = attributes[:'total']
       end
 
-      if attributes.has_key?(:'transactions')
+      if attributes.key?(:'total_active_points')
+        self.total_active_points = attributes[:'total_active_points']
+      end
+
+      if attributes.key?(:'total_pending_points')
+        self.total_pending_points = attributes[:'total_pending_points']
+      end
+
+      if attributes.key?(:'total_spent_points')
+        self.total_spent_points = attributes[:'total_spent_points']
+      end
+
+      if attributes.key?(:'total_expired_points')
+        self.total_expired_points = attributes[:'total_expired_points']
+      end
+
+      if attributes.key?(:'transactions')
         if (value = attributes[:'transactions']).is_a?(Array)
           self.transactions = value
         end
       end
 
-      if attributes.has_key?(:'expiringPoints')
-        if (value = attributes[:'expiringPoints']).is_a?(Array)
+      if attributes.key?(:'expiring_points')
+        if (value = attributes[:'expiring_points']).is_a?(Array)
           self.expiring_points = value
         end
       end
+
+      if attributes.key?(:'active_points')
+        if (value = attributes[:'active_points']).is_a?(Array)
+          self.active_points = value
+        end
+      end
+
+      if attributes.key?(:'pending_points')
+        if (value = attributes[:'pending_points']).is_a?(Array)
+          self.pending_points = value
+        end
+      end
+
+      if attributes.key?(:'expired_points')
+        if (value = attributes[:'expired_points']).is_a?(Array)
+          self.expired_points = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -74,6 +157,22 @@ module TalonOne
         invalid_properties.push('invalid value for "total", total cannot be nil.')
       end
 
+      if @total_active_points.nil?
+        invalid_properties.push('invalid value for "total_active_points", total_active_points cannot be nil.')
+      end
+
+      if @total_pending_points.nil?
+        invalid_properties.push('invalid value for "total_pending_points", total_pending_points cannot be nil.')
+      end
+
+      if @total_spent_points.nil?
+        invalid_properties.push('invalid value for "total_spent_points", total_spent_points cannot be nil.')
+      end
+
+      if @total_expired_points.nil?
+        invalid_properties.push('invalid value for "total_expired_points", total_expired_points cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -81,6 +180,10 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @total.nil?
+      return false if @total_active_points.nil?
+      return false if @total_pending_points.nil?
+      return false if @total_spent_points.nil?
+      return false if @total_expired_points.nil?
       true
     end
 
@@ -90,8 +193,15 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           total == o.total &&
+          total_active_points == o.total_active_points &&
+          total_pending_points == o.total_pending_points &&
+          total_spent_points == o.total_spent_points &&
+          total_expired_points == o.total_expired_points &&
           transactions == o.transactions &&
-          expiring_points == o.expiring_points
+          expiring_points == o.expiring_points &&
+          active_points == o.active_points &&
+          pending_points == o.pending_points &&
+          expired_points == o.expired_points
     end
 
     # @see the `==` method
@@ -101,9 +211,16 @@ module TalonOne
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [total, transactions, expiring_points].hash
+      [total, total_active_points, total_pending_points, total_spent_points, total_expired_points, transactions, expiring_points, active_points, pending_points, expired_points].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
@@ -111,9 +228,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) })
@@ -142,7 +259,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
@@ -163,8 +280,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
 
@@ -186,7 +302,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