talon_one 10.0.0 → 11.0.0

data/lib/talon_one/models/expiring_points_data.rb

@@ -0,0 +1,291 @@
+=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 ExpiringPointsData
+    # The expiration date of loyalty points.
+    attr_accessor :expiry_date
+
+    # The ID of the loyalty program.
+    attr_accessor :loyalty_program_id
+
+    # The integration ID of the customer profile that has expiring points.
+    attr_accessor :customer_profile_id
+
+    # The amount of loyalty points that will be expired soon.
+    attr_accessor :amount_of_expiring_points
+
+    # The ID of the subledger within the loyalty program where these points were added.
+    attr_accessor :subledger_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiry_date' => :'ExpiryDate',
+        :'loyalty_program_id' => :'LoyaltyProgramID',
+        :'customer_profile_id' => :'CustomerProfileID',
+        :'amount_of_expiring_points' => :'AmountOfExpiringPoints',
+        :'subledger_id' => :'SubledgerID'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'expiry_date' => :'Date',
+        :'loyalty_program_id' => :'Integer',
+        :'customer_profile_id' => :'String',
+        :'amount_of_expiring_points' => :'Float',
+        :'subledger_id' => :'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::ExpiringPointsData` 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::ExpiringPointsData`. 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?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'loyalty_program_id')
+        self.loyalty_program_id = attributes[:'loyalty_program_id']
+      end
+
+      if attributes.key?(:'customer_profile_id')
+        self.customer_profile_id = attributes[:'customer_profile_id']
+      end
+
+      if attributes.key?(:'amount_of_expiring_points')
+        self.amount_of_expiring_points = attributes[:'amount_of_expiring_points']
+      end
+
+      if attributes.key?(:'subledger_id')
+        self.subledger_id = attributes[:'subledger_id']
+      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 @expiry_date.nil?
+        invalid_properties.push('invalid value for "expiry_date", expiry_date 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 @customer_profile_id.nil?
+        invalid_properties.push('invalid value for "customer_profile_id", customer_profile_id cannot be nil.')
+      end
+
+      if @amount_of_expiring_points.nil?
+        invalid_properties.push('invalid value for "amount_of_expiring_points", amount_of_expiring_points cannot be nil.')
+      end
+
+      if @subledger_id.nil?
+        invalid_properties.push('invalid value for "subledger_id", subledger_id 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 @expiry_date.nil?
+      return false if @loyalty_program_id.nil?
+      return false if @loyalty_program_id < 1
+      return false if @customer_profile_id.nil?
+      return false if @amount_of_expiring_points.nil?
+      return false if @subledger_id.nil?
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          expiry_date == o.expiry_date &&
+          loyalty_program_id == o.loyalty_program_id &&
+          customer_profile_id == o.customer_profile_id &&
+          amount_of_expiring_points == o.amount_of_expiring_points &&
+          subledger_id == o.subledger_id
+    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
+      [expiry_date, loyalty_program_id, customer_profile_id, amount_of_expiring_points, subledger_id].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/expiring_points_notification.rb

@@ -0,0 +1,277 @@
+=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 ExpiringPointsNotification
+    attr_accessor :total_result_size
+
+    # The array of expiring points.
+    attr_accessor :data
+
+    # 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
+      {
+        :'total_result_size' => :'TotalResultSize',
+        :'data' => :'Data',
+        :'notification_type' => :'NotificationType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total_result_size' => :'Integer',
+        :'data' => :'Array<ExpiringPointsData>',
+        :'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::ExpiringPointsNotification` 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::ExpiringPointsNotification`. 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_result_size')
+        self.total_result_size = attributes[:'total_result_size']
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      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 @total_result_size.nil?
+        invalid_properties.push('invalid value for "total_result_size", total_result_size cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @total_result_size.nil?
+      return false if @data.nil?
+      return false if @notification_type.nil?
+      notification_type_validator = EnumAttributeValidator.new('String', ["LoyaltyPointsExpiring"])
+      return false unless notification_type_validator.valid?(@notification_type)
+      true
+    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', ["LoyaltyPointsExpiring"])
+      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 &&
+          total_result_size == o.total_result_size &&
+          data == o.data &&
+          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
+      [total_result_size, data, 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/expiring_points_notification_policy.rb

@@ -84,6 +84,8 @@ module TalonOne
 
       if attributes.key?(:'batch_size')
         self.batch_size = attributes[:'batch_size']
+      else
+        self.batch_size = 1000
       end
     end
 

data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb

@@ -24,11 +24,8 @@ module TalonOne
     # Time frame by which the expiry date extends.  The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit.  Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. 
     attr_accessor :extension_duration
 
-    # The list of identifiers of transactions affected affected by the extension.
-    attr_accessor :transaction_uui_ds
-
-    # Expiry date before applying the extension.
-    attr_accessor :previous_expiration_date
+    # List of transactions affected by the expiry date update.
+    attr_accessor :affected_transactions
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -36,8 +33,7 @@ module TalonOne
         :'program_id' => :'programId',
         :'sub_ledger_id' => :'subLedgerId',
         :'extension_duration' => :'extensionDuration',
-        :'transaction_uui_ds' => :'transactionUUIDs',
-        :'previous_expiration_date' => :'previousExpirationDate'
+        :'affected_transactions' => :'affectedTransactions'
       }
     end
 
@@ -47,8 +43,7 @@ module TalonOne
         :'program_id' => :'Integer',
         :'sub_ledger_id' => :'String',
         :'extension_duration' => :'String',
-        :'transaction_uui_ds' => :'Array<String>',
-        :'previous_expiration_date' => :'DateTime'
+        :'affected_transactions' => :'Array<LoyaltyLedgerEntryExpiryDateChange>'
       }
     end
 
@@ -85,15 +80,11 @@ module TalonOne
         self.extension_duration = attributes[:'extension_duration']
       end
 
-      if attributes.key?(:'transaction_uui_ds')
-        if (value = attributes[:'transaction_uui_ds']).is_a?(Array)
-          self.transaction_uui_ds = value
+      if attributes.key?(:'affected_transactions')
+        if (value = attributes[:'affected_transactions']).is_a?(Array)
+          self.affected_transactions = value
         end
       end
-
-      if attributes.key?(:'previous_expiration_date')
-        self.previous_expiration_date = attributes[:'previous_expiration_date']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -112,10 +103,6 @@ module TalonOne
         invalid_properties.push('invalid value for "extension_duration", extension_duration cannot be nil.')
       end
 
-      if @previous_expiration_date.nil?
-        invalid_properties.push('invalid value for "previous_expiration_date", previous_expiration_date cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -125,7 +112,6 @@ module TalonOne
       return false if @program_id.nil?
       return false if @sub_ledger_id.nil?
       return false if @extension_duration.nil?
-      return false if @previous_expiration_date.nil?
       true
     end
 
@@ -137,8 +123,7 @@ module TalonOne
           program_id == o.program_id &&
           sub_ledger_id == o.sub_ledger_id &&
           extension_duration == o.extension_duration &&
-          transaction_uui_ds == o.transaction_uui_ds &&
-          previous_expiration_date == o.previous_expiration_date
+          affected_transactions == o.affected_transactions
     end
 
     # @see the `==` method
@@ -150,7 +135,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [program_id, sub_ledger_id, extension_duration, transaction_uui_ds, previous_expiration_date].hash
+      [program_id, sub_ledger_id, extension_duration, affected_transactions].hash
     end
 
     # Builds the object from hash