velopayments 2.29.128.beta1 → 2.35.58

data/lib/velopayments/models/{source_account_response.rb → funding_response.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
 
@@ -14,76 +14,56 @@ require 'date'
 require 'time'
 
 module VeloPayments
-  class SourceAccountResponse
-    # Source Account Id
-    attr_accessor :id
+  class FundingResponse
+    attr_accessor :funding_id
 
-    # Decimal implied
-    attr_accessor :balance
+    attr_accessor :payor_id
 
-    attr_accessor :currency
+    attr_accessor :allocation_date
 
-    attr_accessor :funding_ref
+    attr_accessor :detected_funding_ref
 
-    attr_accessor :physical_account_name
+    attr_accessor :amount
 
-    attr_accessor :rails_id
-
-    attr_accessor :payor_id
+    # Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details.
+    attr_accessor :currency
 
-    attr_accessor :name
+    attr_accessor :text
 
-    attr_accessor :pooled
+    attr_accessor :physical_account_name
 
-    attr_accessor :balance_visible
+    attr_accessor :source_account_id
 
-    attr_accessor :customer_id
+    # Funding Allocation Type. One of the following values: AUTOMATIC, MANUAL
+    attr_accessor :allocation_type
 
-    attr_accessor :physical_account_id
+    attr_accessor :reason
 
-    attr_accessor :funding_account_id
+    attr_accessor :hidden_date
 
-    attr_accessor :account_type
+    # Funding Account Type. One of the following values: FBO, WUBS_DECOUPLED, PRIVATE
+    attr_accessor :funding_account_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
+    # Current status of the funding. One of the follwing values: PENDING, UNALLOCATED, ALLOCATED, HIDDEN, RETURNED, RETURNING, BULK_RETURN, OTHER
+    attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'balance' => :'balance',
+        :'funding_id' => :'fundingId',
+        :'payor_id' => :'payorId',
+        :'allocation_date' => :'allocationDate',
+        :'detected_funding_ref' => :'detectedFundingRef',
+        :'amount' => :'amount',
         :'currency' => :'currency',
-        :'funding_ref' => :'fundingRef',
+        :'text' => :'text',
         :'physical_account_name' => :'physicalAccountName',
-        :'rails_id' => :'railsId',
-        :'payor_id' => :'payorId',
-        :'name' => :'name',
-        :'pooled' => :'pooled',
-        :'balance_visible' => :'balanceVisible',
-        :'customer_id' => :'customerId',
-        :'physical_account_id' => :'physicalAccountId',
-        :'funding_account_id' => :'fundingAccountId',
-        :'account_type' => :'accountType'
+        :'source_account_id' => :'sourceAccountId',
+        :'allocation_type' => :'allocationType',
+        :'reason' => :'reason',
+        :'hidden_date' => :'hiddenDate',
+        :'funding_account_type' => :'fundingAccountType',
+        :'status' => :'status'
       }
     end
 
@@ -95,28 +75,26 @@ module VeloPayments
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'balance' => :'Integer',
+        :'funding_id' => :'String',
+        :'payor_id' => :'String',
+        :'allocation_date' => :'Time',
+        :'detected_funding_ref' => :'String',
+        :'amount' => :'Integer',
         :'currency' => :'String',
-        :'funding_ref' => :'String',
+        :'text' => :'String',
         :'physical_account_name' => :'String',
-        :'rails_id' => :'String',
-        :'payor_id' => :'String',
-        :'name' => :'String',
-        :'pooled' => :'Boolean',
-        :'balance_visible' => :'Boolean',
-        :'customer_id' => :'String',
-        :'physical_account_id' => :'String',
-        :'funding_account_id' => :'String',
-        :'account_type' => :'String'
+        :'source_account_id' => :'String',
+        :'allocation_type' => :'String',
+        :'reason' => :'String',
+        :'hidden_date' => :'Time',
+        :'funding_account_type' => :'String',
+        :'status' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'customer_id',
-        :'funding_account_id',
       ])
     end
 
@@ -124,106 +102,174 @@ module VeloPayments
     # @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 `VeloPayments::SourceAccountResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::FundingResponse` 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 `VeloPayments::SourceAccountResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::FundingResponse`. 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']
+      if attributes.key?(:'funding_id')
+        self.funding_id = attributes[:'funding_id']
+      else
+        self.funding_id = nil
       end
 
-      if attributes.key?(:'balance')
-        self.balance = attributes[:'balance']
+      if attributes.key?(:'payor_id')
+        self.payor_id = attributes[:'payor_id']
+      else
+        self.payor_id = nil
       end
 
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.key?(:'allocation_date')
+        self.allocation_date = attributes[:'allocation_date']
+      else
+        self.allocation_date = nil
       end
 
-      if attributes.key?(:'funding_ref')
-        self.funding_ref = attributes[:'funding_ref']
+      if attributes.key?(:'detected_funding_ref')
+        self.detected_funding_ref = attributes[:'detected_funding_ref']
       end
 
-      if attributes.key?(:'physical_account_name')
-        self.physical_account_name = attributes[:'physical_account_name']
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
       end
 
-      if attributes.key?(:'rails_id')
-        self.rails_id = attributes[:'rails_id']
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
       end
 
-      if attributes.key?(:'payor_id')
-        self.payor_id = attributes[:'payor_id']
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'physical_account_name')
+        self.physical_account_name = attributes[:'physical_account_name']
       end
 
-      if attributes.key?(:'pooled')
-        self.pooled = attributes[:'pooled']
+      if attributes.key?(:'source_account_id')
+        self.source_account_id = attributes[:'source_account_id']
       end
 
-      if attributes.key?(:'balance_visible')
-        self.balance_visible = attributes[:'balance_visible']
+      if attributes.key?(:'allocation_type')
+        self.allocation_type = attributes[:'allocation_type']
       end
 
-      if attributes.key?(:'customer_id')
-        self.customer_id = attributes[:'customer_id']
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
       end
 
-      if attributes.key?(:'physical_account_id')
-        self.physical_account_id = attributes[:'physical_account_id']
+      if attributes.key?(:'hidden_date')
+        self.hidden_date = attributes[:'hidden_date']
       end
 
-      if attributes.key?(:'funding_account_id')
-        self.funding_account_id = attributes[:'funding_account_id']
+      if attributes.key?(:'funding_account_type')
+        self.funding_account_type = attributes[:'funding_account_type']
+      else
+        self.funding_account_type = nil
       end
 
-      if attributes.key?(:'account_type')
-        self.account_type = attributes[:'account_type']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
       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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@currency.nil? && @currency.to_s.length > 3
+      if @funding_id.nil?
+        invalid_properties.push('invalid value for "funding_id", funding_id cannot be nil.')
+      end
+
+      if @payor_id.nil?
+        invalid_properties.push('invalid value for "payor_id", payor_id cannot be nil.')
+      end
+
+      if @allocation_date.nil?
+        invalid_properties.push('invalid value for "allocation_date", allocation_date cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @currency.to_s.length > 3
         invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
       end
 
-      if !@currency.nil? && @currency.to_s.length < 3
+      if @currency.to_s.length < 3
         invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
       end
 
+      pattern = Regexp.new(/^[A-Z]{3}$/)
+      if @currency !~ pattern
+        invalid_properties.push("invalid value for \"currency\", must conform to the pattern #{pattern}.")
+      end
+
+      if @funding_account_type.nil?
+        invalid_properties.push('invalid value for "funding_account_type", funding_account_type cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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?
-      currency_validator = EnumAttributeValidator.new('String', ["USD"])
-      return false unless currency_validator.valid?(@currency)
-      return false if !@currency.nil? && @currency.to_s.length > 3
-      return false if !@currency.nil? && @currency.to_s.length < 3
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @funding_id.nil?
+      return false if @payor_id.nil?
+      return false if @allocation_date.nil?
+      return false if @amount.nil?
+      return false if @currency.nil?
+      return false if @currency.to_s.length > 3
+      return false if @currency.to_s.length < 3
+      return false if @currency !~ Regexp.new(/^[A-Z]{3}$/)
+      return false if @funding_account_type.nil?
+      return false if @status.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] currency Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
     def currency=(currency)
-      validator = EnumAttributeValidator.new('String', ["USD"])
-      unless validator.valid?(currency)
-        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      if currency.nil?
+        fail ArgumentError, 'currency cannot be nil'
       end
+
+      if currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
+      end
+
+      if currency.to_s.length < 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
+      end
+
+      pattern = Regexp.new(/^[A-Z]{3}$/)
+      if currency !~ pattern
+        fail ArgumentError, "invalid value for \"currency\", must conform to the pattern #{pattern}."
+      end
+
       @currency = currency
     end
 
@@ -232,20 +278,20 @@ module VeloPayments
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          balance == o.balance &&
+          funding_id == o.funding_id &&
+          payor_id == o.payor_id &&
+          allocation_date == o.allocation_date &&
+          detected_funding_ref == o.detected_funding_ref &&
+          amount == o.amount &&
           currency == o.currency &&
-          funding_ref == o.funding_ref &&
+          text == o.text &&
           physical_account_name == o.physical_account_name &&
-          rails_id == o.rails_id &&
-          payor_id == o.payor_id &&
-          name == o.name &&
-          pooled == o.pooled &&
-          balance_visible == o.balance_visible &&
-          customer_id == o.customer_id &&
-          physical_account_id == o.physical_account_id &&
-          funding_account_id == o.funding_account_id &&
-          account_type == o.account_type
+          source_account_id == o.source_account_id &&
+          allocation_type == o.allocation_type &&
+          reason == o.reason &&
+          hidden_date == o.hidden_date &&
+          funding_account_type == o.funding_account_type &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -257,43 +303,37 @@ module VeloPayments
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, balance, currency, funding_ref, physical_account_name, rails_id, payor_id, name, pooled, balance_visible, customer_id, physical_account_id, funding_account_id, account_type].hash
+      [funding_id, payor_id, allocation_date, detected_funding_ref, amount, currency, text, physical_account_name, source_account_id, allocation_type, reason, hidden_date, funding_account_type, status].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)