talon_one 6.0.0 → 8.0.0

data/lib/talon_one/models/list_campaign_store_budgets_store.rb

@@ -0,0 +1,239 @@
+=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 ListCampaignStoreBudgetsStore
+    attr_accessor :id
+
+    attr_accessor :integration_id
+
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'integration_id' => :'integrationId',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'integration_id' => :'String',
+        :'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::ListCampaignStoreBudgetsStore` 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::ListCampaignStoreBudgetsStore`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @id.nil?
+      return false if @integration_id.nil?
+      return false if @name.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 &&
+          id == o.id &&
+          integration_id == o.integration_id &&
+          name == o.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
+      [id, integration_id, 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/login_params.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class LoginParams
     # The email address associated with the user profile.
     attr_accessor :email

data/lib/talon_one/models/loyalty_balance.rb

@@ -27,13 +27,17 @@ module TalonOne
     # Total amount of points awarded but never redeemed. They cannot be used anymore.
     attr_accessor :expired_points
 
+    # Total amount of negative points. This implies that `activePoints` is `0`.
+    attr_accessor :negative_points
+
     # 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'
+        :'expired_points' => :'expiredPoints',
+        :'negative_points' => :'negativePoints'
       }
     end
 
@@ -43,7 +47,8 @@ module TalonOne
         :'active_points' => :'Float',
         :'pending_points' => :'Float',
         :'spent_points' => :'Float',
-        :'expired_points' => :'Float'
+        :'expired_points' => :'Float',
+        :'negative_points' => :'Float'
       }
     end
 
@@ -83,6 +88,10 @@ module TalonOne
       if attributes.key?(:'expired_points')
         self.expired_points = attributes[:'expired_points']
       end
+
+      if attributes.key?(:'negative_points')
+        self.negative_points = attributes[:'negative_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +115,8 @@ module TalonOne
           active_points == o.active_points &&
           pending_points == o.pending_points &&
           spent_points == o.spent_points &&
-          expired_points == o.expired_points
+          expired_points == o.expired_points &&
+          negative_points == o.negative_points
     end
 
     # @see the `==` method
@@ -118,7 +128,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [active_points, pending_points, spent_points, expired_points].hash
+      [active_points, pending_points, spent_points, expired_points, negative_points].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_balance_with_tier.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # Point balance of a ledger in the Loyalty Program.
   class LoyaltyBalanceWithTier
     # Total amount of points awarded to this customer and available to spend.
     attr_accessor :active_points
@@ -27,6 +27,9 @@ module TalonOne
     # Total amount of points awarded but never redeemed. They cannot be used anymore.
     attr_accessor :expired_points
 
+    # Total amount of negative points. This implies that `activePoints` is `0`.
+    attr_accessor :negative_points
+
     attr_accessor :current_tier
 
     attr_accessor :projected_tier
@@ -44,6 +47,7 @@ module TalonOne
         :'pending_points' => :'pendingPoints',
         :'spent_points' => :'spentPoints',
         :'expired_points' => :'expiredPoints',
+        :'negative_points' => :'negativePoints',
         :'current_tier' => :'currentTier',
         :'projected_tier' => :'projectedTier',
         :'points_to_next_tier' => :'pointsToNextTier',
@@ -58,6 +62,7 @@ module TalonOne
         :'pending_points' => :'Float',
         :'spent_points' => :'Float',
         :'expired_points' => :'Float',
+        :'negative_points' => :'Float',
         :'current_tier' => :'Tier',
         :'projected_tier' => :'ProjectedTier',
         :'points_to_next_tier' => :'Float',
@@ -102,6 +107,10 @@ module TalonOne
         self.expired_points = attributes[:'expired_points']
       end
 
+      if attributes.key?(:'negative_points')
+        self.negative_points = attributes[:'negative_points']
+      end
+
       if attributes.key?(:'current_tier')
         self.current_tier = attributes[:'current_tier']
       end
@@ -141,6 +150,7 @@ module TalonOne
           pending_points == o.pending_points &&
           spent_points == o.spent_points &&
           expired_points == o.expired_points &&
+          negative_points == o.negative_points &&
           current_tier == o.current_tier &&
           projected_tier == o.projected_tier &&
           points_to_next_tier == o.points_to_next_tier &&
@@ -156,7 +166,7 @@ module TalonOne
     # 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
+      [active_points, pending_points, spent_points, expired_points, negative_points, current_tier, projected_tier, points_to_next_tier, next_tier_name].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_card.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class LoyaltyCard
     # Internal ID of this entity.
     attr_accessor :id
@@ -24,6 +23,12 @@ module TalonOne
     # The ID of the loyalty program that owns this entity.
     attr_accessor :program_id
 
+    # The integration name of the loyalty program that owns this entity.
+    attr_accessor :program_name
+
+    # The Campaign Manager-displayed name of the loyalty program that owns this entity.
+    attr_accessor :program_title
+
     # Status of the loyalty card. Can be `active` or `inactive`. 
     attr_accessor :status
 
@@ -62,6 +67,8 @@ module TalonOne
         :'id' => :'id',
         :'created' => :'created',
         :'program_id' => :'programID',
+        :'program_name' => :'programName',
+        :'program_title' => :'programTitle',
         :'status' => :'status',
         :'block_reason' => :'blockReason',
         :'identifier' => :'identifier',
@@ -82,6 +89,8 @@ module TalonOne
         :'id' => :'Integer',
         :'created' => :'DateTime',
         :'program_id' => :'Integer',
+        :'program_name' => :'String',
+        :'program_title' => :'String',
         :'status' => :'String',
         :'block_reason' => :'String',
         :'identifier' => :'String',
@@ -129,6 +138,14 @@ module TalonOne
         self.program_id = attributes[:'program_id']
       end
 
+      if attributes.key?(:'program_name')
+        self.program_name = attributes[:'program_name']
+      end
+
+      if attributes.key?(:'program_title')
+        self.program_title = attributes[:'program_title']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -206,6 +223,11 @@ module TalonOne
         invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if @identifier !~ pattern
+        invalid_properties.push("invalid value for \"identifier\", must conform to the pattern #{pattern}.")
+      end
+
       if @users_per_card_limit.nil?
         invalid_properties.push('invalid value for "users_per_card_limit", users_per_card_limit cannot be nil.')
       end
@@ -218,10 +240,20 @@ module TalonOne
         invalid_properties.push('invalid value for "old_card_identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !@old_card_identifier.nil? && @old_card_identifier !~ pattern
+        invalid_properties.push("invalid value for \"old_card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       if !@new_card_identifier.nil? && @new_card_identifier.to_s.length > 108
         invalid_properties.push('invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !@new_card_identifier.nil? && @new_card_identifier !~ pattern
+        invalid_properties.push("invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -234,10 +266,13 @@ module TalonOne
       return false if @status.nil?
       return false if @identifier.nil?
       return false if @identifier.to_s.length > 108
+      return false if @identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       return false if @users_per_card_limit.nil?
       return false if @users_per_card_limit < 0
       return false if !@old_card_identifier.nil? && @old_card_identifier.to_s.length > 108
+      return false if !@old_card_identifier.nil? && @old_card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       return false if !@new_card_identifier.nil? && @new_card_identifier.to_s.length > 108
+      return false if !@new_card_identifier.nil? && @new_card_identifier !~ Regexp.new(/^[A-Za-z0-9_-]*$/)
       true
     end
 
@@ -252,6 +287,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if identifier !~ pattern
+        fail ArgumentError, "invalid value for \"identifier\", must conform to the pattern #{pattern}."
+      end
+
       @identifier = identifier
     end
 
@@ -276,6 +316,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "old_card_identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !old_card_identifier.nil? && old_card_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"old_card_identifier\", must conform to the pattern #{pattern}."
+      end
+
       @old_card_identifier = old_card_identifier
     end
 
@@ -286,6 +331,11 @@ module TalonOne
         fail ArgumentError, 'invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.'
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]*$/)
+      if !new_card_identifier.nil? && new_card_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"new_card_identifier\", must conform to the pattern #{pattern}."
+      end
+
       @new_card_identifier = new_card_identifier
     end
 
@@ -297,6 +347,8 @@ module TalonOne
           id == o.id &&
           created == o.created &&
           program_id == o.program_id &&
+          program_name == o.program_name &&
+          program_title == o.program_title &&
           status == o.status &&
           block_reason == o.block_reason &&
           identifier == o.identifier &&
@@ -319,7 +371,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def 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
+      [id, created, program_id, program_name, program_title, 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

data/lib/talon_one/models/loyalty_card_balances.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # List of customer profiles linked to the loyalty card.
   class LoyaltyCardBalances
     attr_accessor :balance
 

data/lib/talon_one/models/loyalty_card_batch.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class LoyaltyCardBatch
     # Number of loyalty cards in the batch.
     attr_accessor :number_of_cards
@@ -24,6 +23,8 @@ module TalonOne
     # Status of the loyalty cards in the batch.
     attr_accessor :status
 
+    attr_accessor :card_code_settings
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +52,8 @@ module TalonOne
       {
         :'number_of_cards' => :'numberOfCards',
         :'batch_id' => :'batchId',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'card_code_settings' => :'cardCodeSettings'
       }
     end
 
@@ -60,7 +62,8 @@ module TalonOne
       {
         :'number_of_cards' => :'Integer',
         :'batch_id' => :'String',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'card_code_settings' => :'CodeGeneratorSettings'
       }
     end
 
@@ -98,6 +101,10 @@ module TalonOne
       else
         self.status = 'active'
       end
+
+      if attributes.key?(:'card_code_settings')
+        self.card_code_settings = attributes[:'card_code_settings']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -172,7 +179,8 @@ module TalonOne
       self.class == o.class &&
           number_of_cards == o.number_of_cards &&
           batch_id == o.batch_id &&
-          status == o.status
+          status == o.status &&
+          card_code_settings == o.card_code_settings
     end
 
     # @see the `==` method
@@ -184,7 +192,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [number_of_cards, batch_id, status].hash
+      [number_of_cards, batch_id, status, card_code_settings].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/loyalty_ledger_entry.rb

@@ -48,6 +48,8 @@ module TalonOne
     # Indicates if the entry belongs to the archived session.
     attr_accessor :archived
 
+    attr_accessor :flags
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +66,8 @@ module TalonOne
         :'name' => :'name',
         :'sub_ledger_id' => :'subLedgerID',
         :'user_id' => :'userID',
-        :'archived' => :'archived'
+        :'archived' => :'archived',
+        :'flags' => :'flags'
       }
     end
 
@@ -84,7 +87,8 @@ module TalonOne
         :'name' => :'String',
         :'sub_ledger_id' => :'String',
         :'user_id' => :'Integer',
-        :'archived' => :'Boolean'
+        :'archived' => :'Boolean',
+        :'flags' => :'LoyaltyLedgerEntryFlags'
       }
     end
 
@@ -164,6 +168,10 @@ module TalonOne
       if attributes.key?(:'archived')
         self.archived = attributes[:'archived']
       end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -227,7 +235,8 @@ module TalonOne
           name == o.name &&
           sub_ledger_id == o.sub_ledger_id &&
           user_id == o.user_id &&
-          archived == o.archived
+          archived == o.archived &&
+          flags == o.flags
     end
 
     # @see the `==` method
@@ -239,7 +248,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created, program_id, customer_profile_id, card_id, customer_session_id, event_id, type, amount, start_date, expiry_date, name, sub_ledger_id, user_id, archived].hash
+      [created, program_id, customer_profile_id, card_id, customer_session_id, event_id, type, amount, start_date, expiry_date, name, sub_ledger_id, user_id, archived, flags].hash
     end
 
     # Builds the object from hash