talon_one 5.0.0 → 6.0.0

data/lib/talon_one/models/integration_coupon.rb

@@ -39,7 +39,7 @@ module TalonOne
     # Timestamp at which point the coupon becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    # Expiration date of the coupon. Coupon never expires if this is omitted.
     attr_accessor :expiry_date
 
     # Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. 

data/lib/talon_one/models/inventory_coupon.rb

@@ -39,7 +39,7 @@ module TalonOne
     # Timestamp at which point the coupon becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    # Expiration date of the coupon. Coupon never expires if this is omitted.
     attr_accessor :expiry_date
 
     # Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. 

data/lib/talon_one/models/inventory_referral.rb

@@ -24,7 +24,7 @@ module TalonOne
     # Timestamp at which point the referral code becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
+    # Expiration date of the referral code. Referral never expires if this is omitted.
     attr_accessor :expiry_date
 
     # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 

data/lib/talon_one/models/loyalty_balance_with_tier.rb

@@ -0,0 +1,276 @@
+=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 LoyaltyBalanceWithTier
+    # Total amount of points awarded to this customer and available to spend.
+    attr_accessor :active_points
+
+    # Total amount of points awarded to this customer but not available until their start date.
+    attr_accessor :pending_points
+
+    # Total amount of points already spent by this customer.
+    attr_accessor :spent_points
+
+    # Total amount of points awarded but never redeemed. They cannot be used anymore.
+    attr_accessor :expired_points
+
+    attr_accessor :current_tier
+
+    attr_accessor :projected_tier
+
+    # The number of points required to move up a tier.
+    attr_accessor :points_to_next_tier
+
+    # The name of the tier consecutive to the current tier.
+    attr_accessor :next_tier_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active_points' => :'activePoints',
+        :'pending_points' => :'pendingPoints',
+        :'spent_points' => :'spentPoints',
+        :'expired_points' => :'expiredPoints',
+        :'current_tier' => :'currentTier',
+        :'projected_tier' => :'projectedTier',
+        :'points_to_next_tier' => :'pointsToNextTier',
+        :'next_tier_name' => :'nextTierName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'active_points' => :'Float',
+        :'pending_points' => :'Float',
+        :'spent_points' => :'Float',
+        :'expired_points' => :'Float',
+        :'current_tier' => :'Tier',
+        :'projected_tier' => :'ProjectedTier',
+        :'points_to_next_tier' => :'Float',
+        :'next_tier_name' => :'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::LoyaltyBalanceWithTier` 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::LoyaltyBalanceWithTier`. 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?(:'active_points')
+        self.active_points = attributes[:'active_points']
+      end
+
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
+      if attributes.key?(:'spent_points')
+        self.spent_points = attributes[:'spent_points']
+      end
+
+      if attributes.key?(:'expired_points')
+        self.expired_points = attributes[:'expired_points']
+      end
+
+      if attributes.key?(:'current_tier')
+        self.current_tier = attributes[:'current_tier']
+      end
+
+      if attributes.key?(:'projected_tier')
+        self.projected_tier = attributes[:'projected_tier']
+      end
+
+      if attributes.key?(:'points_to_next_tier')
+        self.points_to_next_tier = attributes[:'points_to_next_tier']
+      end
+
+      if attributes.key?(:'next_tier_name')
+        self.next_tier_name = attributes[:'next_tier_name']
+      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
+      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?
+      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 &&
+          active_points == o.active_points &&
+          pending_points == o.pending_points &&
+          spent_points == o.spent_points &&
+          expired_points == o.expired_points &&
+          current_tier == o.current_tier &&
+          projected_tier == o.projected_tier &&
+          points_to_next_tier == o.points_to_next_tier &&
+          next_tier_name == o.next_tier_name
+    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
+      [active_points, pending_points, spent_points, expired_points, current_tier, projected_tier, points_to_next_tier, next_tier_name].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_balances_with_tiers.rb

@@ -0,0 +1,219 @@
+=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
+  # List of loyalty balances for a ledger and its subledgers.
+  class LoyaltyBalancesWithTiers
+    attr_accessor :balance
+
+    # Map of the loyalty balances of the subledgers of a ledger.
+    attr_accessor :subledger_balances
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'balance' => :'balance',
+        :'subledger_balances' => :'subledgerBalances'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'balance' => :'LoyaltyBalanceWithTier',
+        :'subledger_balances' => :'Hash<String, LoyaltyBalanceWithTier>'
+      }
+    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::LoyaltyBalancesWithTiers` 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::LoyaltyBalancesWithTiers`. 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?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.key?(:'subledger_balances')
+        if (value = attributes[:'subledger_balances']).is_a?(Hash)
+          self.subledger_balances = 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
+      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?
+      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 &&
+          balance == o.balance &&
+          subledger_balances == o.subledger_balances
+    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
+      [balance, subledger_balances].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_card.rb

@@ -24,9 +24,12 @@ module TalonOne
     # The ID of the loyalty program that owns this entity.
     attr_accessor :program_id
 
-    # Status of the loyalty card. Can be one of: ['active', 'inactive'] 
+    # Status of the loyalty card. Can be `active` or `inactive`. 
     attr_accessor :status
 
+    # Reason for transferring and blocking the loyalty card. 
+    attr_accessor :block_reason
+
     # The alphanumeric identifier of the loyalty card. 
     attr_accessor :identifier
 
@@ -50,6 +53,9 @@ module TalonOne
     # The alphanumeric identifier of the loyalty card. 
     attr_accessor :new_card_identifier
 
+    # The ID of the batch in which the loyalty card was created.
+    attr_accessor :batch_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -57,6 +63,7 @@ module TalonOne
         :'created' => :'created',
         :'program_id' => :'programID',
         :'status' => :'status',
+        :'block_reason' => :'blockReason',
         :'identifier' => :'identifier',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'profiles' => :'profiles',
@@ -64,7 +71,8 @@ module TalonOne
         :'subledgers' => :'subledgers',
         :'modified' => :'modified',
         :'old_card_identifier' => :'oldCardIdentifier',
-        :'new_card_identifier' => :'newCardIdentifier'
+        :'new_card_identifier' => :'newCardIdentifier',
+        :'batch_id' => :'batchId'
       }
     end
 
@@ -75,6 +83,7 @@ module TalonOne
         :'created' => :'DateTime',
         :'program_id' => :'Integer',
         :'status' => :'String',
+        :'block_reason' => :'String',
         :'identifier' => :'String',
         :'users_per_card_limit' => :'Integer',
         :'profiles' => :'Array<LoyaltyCardProfileRegistration>',
@@ -82,7 +91,8 @@ module TalonOne
         :'subledgers' => :'Hash<String, LedgerInfo>',
         :'modified' => :'DateTime',
         :'old_card_identifier' => :'String',
-        :'new_card_identifier' => :'String'
+        :'new_card_identifier' => :'String',
+        :'batch_id' => :'String'
       }
     end
 
@@ -123,6 +133,10 @@ module TalonOne
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'block_reason')
+        self.block_reason = attributes[:'block_reason']
+      end
+
       if attributes.key?(:'identifier')
         self.identifier = attributes[:'identifier']
       end
@@ -158,6 +172,10 @@ module TalonOne
       if attributes.key?(:'new_card_identifier')
         self.new_card_identifier = attributes[:'new_card_identifier']
       end
+
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -280,6 +298,7 @@ module TalonOne
           created == o.created &&
           program_id == o.program_id &&
           status == o.status &&
+          block_reason == o.block_reason &&
           identifier == o.identifier &&
           users_per_card_limit == o.users_per_card_limit &&
           profiles == o.profiles &&
@@ -287,7 +306,8 @@ module TalonOne
           subledgers == o.subledgers &&
           modified == o.modified &&
           old_card_identifier == o.old_card_identifier &&
-          new_card_identifier == o.new_card_identifier
+          new_card_identifier == o.new_card_identifier &&
+          batch_id == o.batch_id
     end
 
     # @see the `==` method
@@ -299,7 +319,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, program_id, status, identifier, users_per_card_limit, profiles, ledger, subledgers, modified, old_card_identifier, new_card_identifier].hash
+      [id, created, program_id, status, block_reason, identifier, users_per_card_limit, profiles, ledger, subledgers, modified, old_card_identifier, new_card_identifier, batch_id].hash
     end
 
     # Builds the object from hash