velopayments 2.18.113 → 2.23.78.beta1

data/docs/QuotePayoutApi.md

@@ -1,61 +0,0 @@
-# VeloPayments::QuotePayoutApi
-
-All URIs are relative to *https://api.sandbox.velopayments.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**v3_payouts_payout_id_quote_post**](QuotePayoutApi.md#v3_payouts_payout_id_quote_post) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout
-
-
-
-## v3_payouts_payout_id_quote_post
-
-> QuoteResponse v3_payouts_payout_id_quote_post(payout_id)
-
-Create a quote for the payout
-
-Create quote for a payout
-
-### Example
-
-```ruby
-# load the gem
-require 'velopayments'
-# setup authorization
-VeloPayments.configure do |config|
-  # Configure OAuth2 access token for authorization: OAuth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = VeloPayments::QuotePayoutApi.new
-payout_id = 'payout_id_example' # String | Id of the payout
-
-begin
-  #Create a quote for the payout
-  result = api_instance.v3_payouts_payout_id_quote_post(payout_id)
-  p result
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling QuotePayoutApi->v3_payouts_payout_id_quote_post: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **payout_id** | [**String**](.md)| Id of the payout | 
-
-### Return type
-
-[**QuoteResponse**](QuoteResponse.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/QuoteResponse.md

@@ -1,17 +0,0 @@
-# VeloPayments::QuoteResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fx_summaries** | [**Array<QuoteFxSummary>**](QuoteFxSummary.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::QuoteResponse.new(fx_summaries: null)
-```
-
-

data/docs/RegisterMFARequest.md

@@ -1,17 +0,0 @@
-# VeloPayments::RegisterMFARequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mfa_type** | [**MFAType**](MFAType.md) |  | 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::RegisterMFARequest.new(mfa_type: null)
-```
-
-

data/docs/RegisterMFAResponse.md

@@ -1,19 +0,0 @@
-# VeloPayments::RegisterMFAResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totp_url** | **String** | A TOTP Url thaty can be parsed by the TOTP device | [optional] 
-**totp_shared_secret** | **String** | The shared secret between the TOTP app and the server | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::RegisterMFAResponse.new(totp_url: otpauth://totp/Velo%20Payments:stephen.smith@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Velo%20Payments,
-                                 totp_shared_secret: JBSWY3DPEHPK3PXP)
-```
-
-

data/docs/SubmitPayoutApi.md

@@ -1,60 +0,0 @@
-# VeloPayments::SubmitPayoutApi
-
-All URIs are relative to *https://api.sandbox.velopayments.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**submit_payout**](SubmitPayoutApi.md#submit_payout) | **POST** /v3/payouts | Submit Payout
-
-
-
-## submit_payout
-
-> submit_payout(create_payout_request)
-
-Submit Payout
-
-Create a new payout and return a location header with a link to get the payout. Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously, the results of which can be obtained by issuing a HTTP GET to the URL returned in the location header. **NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.  with no decimal places. 
-
-### Example
-
-```ruby
-# load the gem
-require 'velopayments'
-# setup authorization
-VeloPayments.configure do |config|
-  # Configure OAuth2 access token for authorization: OAuth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = VeloPayments::SubmitPayoutApi.new
-create_payout_request = VeloPayments::CreatePayoutRequest.new # CreatePayoutRequest | Post amount to transfer using stored funding account details.
-
-begin
-  #Submit Payout
-  api_instance.submit_payout(create_payout_request)
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling SubmitPayoutApi->submit_payout: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **create_payout_request** | [**CreatePayoutRequest**](CreatePayoutRequest.md)| Post amount to transfer using stored funding account details. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, multipart/form-data
-- **Accept**: Not defined
-

data/docs/SupportedCurrency.md

@@ -1,19 +0,0 @@
-# VeloPayments::SupportedCurrency
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency** | **String** | ISO Currency Code | [optional] 
-**max_payment_amount** | **Integer** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::SupportedCurrency.new(currency: null,
-                                 max_payment_amount: null)
-```
-
-

data/docs/SupportedCurrencyResponse.md

@@ -1,17 +0,0 @@
-# VeloPayments::SupportedCurrencyResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currencies** | [**Array<SupportedCurrency>**](SupportedCurrency.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::SupportedCurrencyResponse.new(currencies: null)
-```
-
-

data/docs/UserResponse2.md

@@ -1,45 +0,0 @@
-# VeloPayments::UserResponse2
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The id of the user | [optional] 
-**status** | **String** | The status of the user when the user has been invited but not yet enrolled they will have a PENDING status  | [optional] 
-**email** | **String** | the email address of the user | [optional] 
-**sms_number** | **String** | The phone number of a device that the user can receive sms messages on  | [optional] 
-**primary_contact_number** | **String** | The main contact number for the user  | [optional] 
-**secondary_contact_number** | **String** | The secondary contact number for the user  | [optional] 
-**first_name** | **String** |  | [optional] 
-**last_name** | **String** |  | [optional] 
-**entity_id** | **String** | The payorId or payeeId or null if the user is not a payor or payee user  | [optional] 
-**roles** | [**Array<UserResponse2Roles>**](UserResponse2Roles.md) | The role(s) for the user  | [optional] 
-**mfa_type** | **String** | The type of the MFA device | [optional] 
-**mfa_verified** | **Boolean** | Will be true if the user has logged in successfully using the MFA Device  | [optional] 
-**mfa_status** | **String** | The status of the MFA device | [optional] 
-**locked_out** | **Boolean** | If true the user is currently locked out and unable to log in | [optional] 
-**locked_out_timestamp** | **DateTime** | A timestamp showing when the user was locked out If null then the user is not currently locked out  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::UserResponse2.new(id: 8bbf301c-948f-4445-b411-357eec53e441,
-                                 status: ENABLED,
-                                 email: foo@example.com,
-                                 sms_number: 11235555555,
-                                 primary_contact_number: 11235555555,
-                                 secondary_contact_number: 11235555550,
-                                 first_name: John,
-                                 last_name: Doe,
-                                 entity_id: 7fffa261-ac68-49e6-b605-d24a444d9206,
-                                 roles: ["payor.admin"],
-                                 mfa_type: TOTP,
-                                 mfa_verified: false,
-                                 mfa_status: REGISTERED,
-                                 locked_out: true,
-                                 locked_out_timestamp: null)
-```
-
-

data/docs/UserResponse2Roles.md

@@ -1,17 +0,0 @@
-# VeloPayments::UserResponse2Roles
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::UserResponse2Roles.new(name: null)
-```
-
-

data/docs/ValidateMFARequest.md

@@ -1,17 +0,0 @@
-# VeloPayments::ValidateMFARequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**otp** | **String** | An OTP value that can be verified by the MFA type registered with the user | 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::ValidateMFARequest.new(otp: 123456)
-```
-
-

data/docs/ValidateOTPRequest.md

@@ -1,17 +0,0 @@
-# VeloPayments::ValidateOTPRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**otp** | **String** | An OTP value that has been received by the user on their registered device | 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::ValidateOTPRequest.new(otp: 123456)
-```
-
-

data/docs/WithdrawPayoutApi.md

@@ -1,60 +0,0 @@
-# VeloPayments::WithdrawPayoutApi
-
-All URIs are relative to *https://api.sandbox.velopayments.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**withdraw_payout_v3**](WithdrawPayoutApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
-
-
-
-## withdraw_payout_v3
-
-> withdraw_payout_v3(payout_id)
-
-Withdraw Payout
-
-Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
-
-### Example
-
-```ruby
-# load the gem
-require 'velopayments'
-# setup authorization
-VeloPayments.configure do |config|
-  # Configure OAuth2 access token for authorization: OAuth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = VeloPayments::WithdrawPayoutApi.new
-payout_id = 'payout_id_example' # String | Id of the payout
-
-begin
-  #Withdraw Payout
-  api_instance.withdraw_payout_v3(payout_id)
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling WithdrawPayoutApi->withdraw_payout_v3: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **payout_id** | [**String**](.md)| Id of the payout | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-

data/lib/velopayments/api/get_payout_api.rb

@@ -1,84 +0,0 @@
-=begin
-#Velo Payments APIs
-
-### 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.18.113
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
-
-=end
-
-require 'cgi'
-
-module VeloPayments
-  class GetPayoutApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get Payout Summary
-    # Get payout summary - returns the current state of the payout.
-    # @param payout_id [String] Id of the payout
-    # @param [Hash] opts the optional parameters
-    # @return [PayoutSummaryResponse]
-    def get_payout_summary_v3(payout_id, opts = {})
-      data, _status_code, _headers = get_payout_summary_v3_with_http_info(payout_id, opts)
-      data
-    end
-
-    # Get Payout Summary
-    # Get payout summary - returns the current state of the payout.
-    # @param payout_id [String] Id of the payout
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(PayoutSummaryResponse, Integer, Hash)>] PayoutSummaryResponse data, response status code and response headers
-    def get_payout_summary_v3_with_http_info(payout_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: GetPayoutApi.get_payout_summary_v3 ...'
-      end
-      # verify the required parameter 'payout_id' is set
-      if @api_client.config.client_side_validation && payout_id.nil?
-        fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.get_payout_summary_v3"
-      end
-      # resource path
-      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] 
-
-      # return_type
-      return_type = opts[:return_type] || 'PayoutSummaryResponse' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
-
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: GetPayoutApi#get_payout_summary_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end