velopayments 2.29.128.beta1 → 2.35.58.beta1

data/lib/velopayments/models/payment_response_v3.rb

@@ -3,10 +3,10 @@
 
 ### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
 
-The version of the OpenAPI document: 2.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -42,11 +42,13 @@ module VeloPayments
     # The source amount for the payment (amount debited to make the payment)
     attr_accessor :source_amount
 
+    # ISO 3 character currency code
     attr_accessor :source_currency
 
     # The amount which the payee will receive
     attr_accessor :payment_amount
 
+    # ISO 3 character currency code
     attr_accessor :payment_currency
 
     # The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed
@@ -57,9 +59,10 @@ module VeloPayments
 
     attr_accessor :submitted_date_time
 
+    # Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, FAILED, WITHDRAWN
     attr_accessor :status
 
-    # The funding status of the payment
+    # The funding status of the payment. One of the following values: [FUNDED, INSTRUCTED, UNFUNDED
     attr_accessor :funding_status
 
     # The routing number for the payment.
@@ -108,29 +111,9 @@ module VeloPayments
 
     attr_accessor :rails_batch_id
 
-    attr_accessor :rejection_reason
-
-    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
+    attr_accessor :payment_scheme
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    attr_accessor :rejection_reason
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -170,6 +153,7 @@ module VeloPayments
         :'return_reason' => :'returnReason',
         :'rails_payment_id' => :'railsPaymentId',
         :'rails_batch_id' => :'railsBatchId',
+        :'payment_scheme' => :'paymentScheme',
         :'rejection_reason' => :'rejectionReason'
       }
     end
@@ -191,9 +175,9 @@ module VeloPayments
         :'source_account_name' => :'String',
         :'remote_id' => :'String',
         :'source_amount' => :'Integer',
-        :'source_currency' => :'PaymentAuditCurrencyV3',
+        :'source_currency' => :'String',
         :'payment_amount' => :'Integer',
-        :'payment_currency' => :'PaymentAuditCurrencyV3',
+        :'payment_currency' => :'String',
         :'rate' => :'Float',
         :'inverted_rate' => :'Float',
         :'submitted_date_time' => :'Time',
@@ -217,6 +201,7 @@ module VeloPayments
         :'return_reason' => :'String',
         :'rails_payment_id' => :'String',
         :'rails_batch_id' => :'String',
+        :'payment_scheme' => :'String',
         :'rejection_reason' => :'String'
       }
     end
@@ -244,14 +229,20 @@ module VeloPayments
 
       if attributes.key?(:'payment_id')
         self.payment_id = attributes[:'payment_id']
+      else
+        self.payment_id = nil
       end
 
       if attributes.key?(:'payee_id')
         self.payee_id = attributes[:'payee_id']
+      else
+        self.payee_id = nil
       end
 
       if attributes.key?(:'payor_id')
         self.payor_id = attributes[:'payor_id']
+      else
+        self.payor_id = nil
       end
 
       if attributes.key?(:'payor_name')
@@ -260,10 +251,14 @@ module VeloPayments
 
       if attributes.key?(:'quote_id')
         self.quote_id = attributes[:'quote_id']
+      else
+        self.quote_id = nil
       end
 
       if attributes.key?(:'source_account_id')
         self.source_account_id = attributes[:'source_account_id']
+      else
+        self.source_account_id = nil
       end
 
       if attributes.key?(:'source_account_name')
@@ -284,6 +279,8 @@ module VeloPayments
 
       if attributes.key?(:'payment_amount')
         self.payment_amount = attributes[:'payment_amount']
+      else
+        self.payment_amount = nil
       end
 
       if attributes.key?(:'payment_currency')
@@ -300,14 +297,20 @@ module VeloPayments
 
       if attributes.key?(:'submitted_date_time')
         self.submitted_date_time = attributes[:'submitted_date_time']
+      else
+        self.submitted_date_time = nil
       end
 
       if attributes.key?(:'status')
         self.status = attributes[:'status']
+      else
+        self.status = nil
       end
 
       if attributes.key?(:'funding_status')
         self.funding_status = attributes[:'funding_status']
+      else
+        self.funding_status = nil
       end
 
       if attributes.key?(:'routing_number')
@@ -368,6 +371,8 @@ module VeloPayments
         if (value = attributes[:'events']).is_a?(Array)
           self.events = value
         end
+      else
+        self.events = nil
       end
 
       if attributes.key?(:'return_cost')
@@ -386,6 +391,10 @@ module VeloPayments
         self.rails_batch_id = attributes[:'rails_batch_id']
       end
 
+      if attributes.key?(:'payment_scheme')
+        self.payment_scheme = attributes[:'payment_scheme']
+      end
+
       if attributes.key?(:'rejection_reason')
         self.rejection_reason = attributes[:'rejection_reason']
       end
@@ -394,6 +403,7 @@ module VeloPayments
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @payment_id.nil?
         invalid_properties.push('invalid value for "payment_id", payment_id cannot be nil.')
@@ -415,10 +425,26 @@ module VeloPayments
         invalid_properties.push('invalid value for "source_account_id", source_account_id cannot be nil.')
       end
 
+      if !@source_currency.nil? && @source_currency.to_s.length > 3
+        invalid_properties.push('invalid value for "source_currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@source_currency.nil? && @source_currency.to_s.length < 3
+        invalid_properties.push('invalid value for "source_currency", the character length must be great than or equal to 3.')
+      end
+
       if @payment_amount.nil?
         invalid_properties.push('invalid value for "payment_amount", payment_amount cannot be nil.')
       end
 
+      if !@payment_currency.nil? && @payment_currency.to_s.length > 3
+        invalid_properties.push('invalid value for "payment_currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@payment_currency.nil? && @payment_currency.to_s.length < 3
+        invalid_properties.push('invalid value for "payment_currency", the character length must be great than or equal to 3.')
+      end
+
       if @submitted_date_time.nil?
         invalid_properties.push('invalid value for "submitted_date_time", submitted_date_time cannot be nil.')
       end
@@ -445,42 +471,59 @@ module VeloPayments
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @payment_id.nil?
       return false if @payee_id.nil?
       return false if @payor_id.nil?
       return false if @quote_id.nil?
       return false if @source_account_id.nil?
+      return false if !@source_currency.nil? && @source_currency.to_s.length > 3
+      return false if !@source_currency.nil? && @source_currency.to_s.length < 3
       return false if @payment_amount.nil?
+      return false if !@payment_currency.nil? && @payment_currency.to_s.length > 3
+      return false if !@payment_currency.nil? && @payment_currency.to_s.length < 3
       return false if @submitted_date_time.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "WITHDRAWN"])
-      return false unless status_validator.valid?(@status)
       return false if @funding_status.nil?
-      funding_status_validator = EnumAttributeValidator.new('String', ["FUNDED", "INSTRUCTED", "UNFUNDED"])
-      return false unless funding_status_validator.valid?(@funding_status)
       return false if @rails_id.nil?
       return false if @events.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "WITHDRAWN"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] source_currency Value to be assigned
+    def source_currency=(source_currency)
+      if source_currency.nil?
+        fail ArgumentError, 'source_currency cannot be nil'
       end
-      @status = status
+
+      if source_currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "source_currency", the character length must be smaller than or equal to 3.'
+      end
+
+      if source_currency.to_s.length < 3
+        fail ArgumentError, 'invalid value for "source_currency", the character length must be great than or equal to 3.'
+      end
+
+      @source_currency = source_currency
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] funding_status Object to be assigned
-    def funding_status=(funding_status)
-      validator = EnumAttributeValidator.new('String', ["FUNDED", "INSTRUCTED", "UNFUNDED"])
-      unless validator.valid?(funding_status)
-        fail ArgumentError, "invalid value for \"funding_status\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] payment_currency Value to be assigned
+    def payment_currency=(payment_currency)
+      if payment_currency.nil?
+        fail ArgumentError, 'payment_currency cannot be nil'
       end
-      @funding_status = funding_status
+
+      if payment_currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "payment_currency", the character length must be smaller than or equal to 3.'
+      end
+
+      if payment_currency.to_s.length < 3
+        fail ArgumentError, 'invalid value for "payment_currency", the character length must be great than or equal to 3.'
+      end
+
+      @payment_currency = payment_currency
     end
 
     # Checks equality by comparing each attribute.
@@ -523,6 +566,7 @@ module VeloPayments
           return_reason == o.return_reason &&
           rails_payment_id == o.rails_payment_id &&
           rails_batch_id == o.rails_batch_id &&
+          payment_scheme == o.payment_scheme &&
           rejection_reason == o.rejection_reason
     end
 
@@ -535,43 +579,37 @@ module VeloPayments
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payment_id, payee_id, payor_id, payor_name, quote_id, source_account_id, source_account_name, remote_id, source_amount, source_currency, payment_amount, payment_currency, rate, inverted_rate, submitted_date_time, status, funding_status, routing_number, account_number, iban, payment_memo, filename_reference, individual_identification_number, trace_number, payor_payment_id, payment_channel_id, payment_channel_name, account_name, rails_id, country_code, events, return_cost, return_reason, rails_payment_id, rails_batch_id, rejection_reason].hash
+      [payment_id, payee_id, payor_id, payor_name, quote_id, source_account_id, source_account_name, remote_id, source_amount, source_currency, payment_amount, payment_currency, rate, inverted_rate, submitted_date_time, status, funding_status, routing_number, account_number, iban, payment_memo, filename_reference, individual_identification_number, trace_number, payor_payment_id, payment_channel_id, payment_channel_name, account_name, rails_id, country_code, events, return_cost, return_reason, rails_payment_id, rails_batch_id, payment_scheme, rejection_reason].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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)