velopayments 2.17.8 → 2.18.31.beta1

data/Jenkinsfile

@@ -1,41 +0,0 @@
-pipeline {
-  environment {
-    SPEC_FULL_BRANCHNAME = sh(returnStdout: true, script: '''echo ${spec_branch//origin\\//$''}''').trim()
-    CLIENT_BUILD_SEMVER = sh(returnStdout: true, script: '''echo ${spec_branch//origin\\/v/$''}.${BUILD_NUMBER}''').trim()
-    SPEC_OA3_SEMVER = ''
-  }
-  agent any
-  stages {
-    stage('prepare') {
-      steps {
-        script {
-          def oa3semver = sh(returnStdout: true, script: '''make WORKING_SPEC=https://raw.githubusercontent.com/velopaymentsapi/VeloOpenApi/${SPEC_FULL_BRANCHNAME}/spec/openapi.yaml version''').trim()
-          SPEC_OA3_SEMVER = oa3semver.replace("/n", "")
-          env.SPEC_OA3_SEMVER = SPEC_OA3_SEMVER
-        }
-
-        echo "SPEC_FULL_BRANCHNAME is ${SPEC_FULL_BRANCHNAME}"
-        echo "CLIENT_BUILD_SEMVER is ${CLIENT_BUILD_SEMVER}"
-        echo "SPEC_OA3_SEMVER is ${SPEC_OA3_SEMVER}"
-      }
-    }
-    stage('build') {
-      steps {
-        sh 'make VERSION=${CLIENT_BUILD_SEMVER} oa3config'
-        sh 'make WORKING_SPEC=https://raw.githubusercontent.com/velopaymentsapi/VeloOpenApi/${SPEC_FULL_BRANCHNAME}/spec/openapi.yaml client'
-      }
-    }
-    stage('test') {
-      steps {
-        sh 'make tests'
-      }
-    }
-    stage('publish') {
-      steps {
-        sh 'make build'
-        sh 'make VERSION=${CLIENT_BUILD_SEMVER} commit'
-        sh 'make VERSION=${CLIENT_BUILD_SEMVER} publish'
-      }
-    }
-  }
-}

data/docs/AuthApi.md

@@ -1,64 +0,0 @@
-# VeloPayments::AuthApi
-
-All URIs are relative to *https://api.sandbox.velopayments.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**velo_auth**](AuthApi.md#velo_auth) | **POST** /v1/authenticate | Authentication endpoint
-
-
-
-## velo_auth
-
-> AuthResponse velo_auth(opts)
-
-Authentication endpoint
-
-Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded 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. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 
-
-### Example
-
-```ruby
-# load the gem
-require 'velopayments'
-# setup authorization
-VeloPayments.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = VeloPayments::AuthApi.new
-opts = {
-  grant_type: 'client_credentials' # String | OAuth grant type. Should use 'client_credentials'
-}
-
-begin
-  #Authentication endpoint
-  result = api_instance.velo_auth(opts)
-  p result
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling AuthApi->velo_auth: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **grant_type** | **String**| OAuth grant type. Should use 'client_credentials' | [optional] [default to 'client_credentials']
-
-### Return type
-
-[**AuthResponse**](AuthResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/FundingDelta.md

@@ -1,23 +0,0 @@
-# VeloPayments::FundingDelta
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** |  | 
-**funding_id** | **String** |  | [readonly] 
-**amount** | **Integer** | Amount to fund in minor units | [optional] 
-**currency** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::FundingDelta.new(status: ALLOCATED,
-                                 funding_id: null,
-                                 amount: 100000,
-                                 currency: USD)
-```
-
-

data/docs/FundingDeltaResponse.md

@@ -1,21 +0,0 @@
-# VeloPayments::FundingDeltaResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page** | [**PayeeDeltaResponsePage**](PayeeDeltaResponsePage.md) |  | [optional] 
-**links** | [**Array<FundingDeltaResponseLinks>**](FundingDeltaResponseLinks.md) |  | [optional] 
-**content** | [**Array<FundingDelta>**](FundingDelta.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::FundingDeltaResponse.new(page: null,
-                                 links: null,
-                                 content: null)
-```
-
-

data/docs/FundingDeltaResponseLinks.md

@@ -1,19 +0,0 @@
-# VeloPayments::FundingDeltaResponseLinks
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rel** | **String** |  | [optional] 
-**href** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::FundingDeltaResponseLinks.new(rel: first,
-                                 href: http://api.sandbox.velopayments.com/v1/deltas/fundings?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
-```
-
-

data/docs/GetPayoutsResponseV3Summary.md

@@ -1,25 +0,0 @@
-# VeloPayments::GetPayoutsResponseV3Summary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total_payees_count** | **Integer** |  | [optional] 
-**total_invited_count** | **Integer** |  | [optional] 
-**total_registered_count** | **Integer** |  | [optional] 
-**total_onboarded_count** | **Integer** |  | [optional] 
-**total_ofac_failed_count** | **Integer** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::GetPayoutsResponseV3Summary.new(total_payees_count: 12,
-                                 total_invited_count: 100,
-                                 total_registered_count: 123,
-                                 total_onboarded_count: 123,
-                                 total_ofac_failed_count: 23)
-```
-
-

data/docs/ListPaymentsResponseSummary.md

@@ -1,25 +0,0 @@
-# VeloPayments::ListPaymentsResponseSummary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total_payees_count** | **Integer** |  | [optional] 
-**total_invited_count** | **Integer** |  | [optional] 
-**total_registered_count** | **Integer** |  | [optional] 
-**total_onboarded_count** | **Integer** |  | [optional] 
-**total_ofac_failed_count** | **Integer** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'VeloPayments'
-
-instance = VeloPayments::ListPaymentsResponseSummary.new(total_payees_count: 123,
-                                 total_invited_count: 123,
-                                 total_registered_count: 123,
-                                 total_onboarded_count: 123,
-                                 total_ofac_failed_count: 123)
-```
-
-

data/docs/PayorApplicationsApi.md

@@ -1,119 +0,0 @@
-# VeloPayments::PayorApplicationsApi
-
-All URIs are relative to *https://api.sandbox.velopayments.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**payor_create_api_key_request**](PayorApplicationsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
-[**payor_create_application_request**](PayorApplicationsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
-
-
-
-## payor_create_api_key_request
-
-> PayorCreateApiKeyResponse payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
-
-Create API Key
-
-Create an an API key for the given payor Id and application Id
-
-### 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::PayorApplicationsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
-application_id = 'application_id_example' # String | Application ID
-payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new # PayorCreateApiKeyRequest | Details of application API key to create
-
-begin
-  #Create API Key
-  result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
-  p result
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayorApplicationsApi->payor_create_api_key_request: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
- **application_id** | [**String**](.md)| Application ID | 
- **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md)| Details of application API key to create | 
-
-### Return type
-
-[**PayorCreateApiKeyResponse**](PayorCreateApiKeyResponse.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## payor_create_application_request
-
-> payor_create_application_request(payor_id, payor_create_application_request)
-
-Create Application
-
-Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-
-### 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::PayorApplicationsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
-payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new # PayorCreateApplicationRequest | Details of application to create
-
-begin
-  #Create Application
-  api_instance.payor_create_application_request(payor_id, payor_create_application_request)
-rescue VeloPayments::ApiError => e
-  puts "Exception when calling PayorApplicationsApi->payor_create_application_request: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
- **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md)| Details of application to create | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-

data/lib/velopayments/api/payor_applications_api.rb

@@ -1,166 +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.17.8
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
-
-=end
-
-require 'cgi'
-
-module VeloPayments
-  class PayorApplicationsApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Create API Key
-    # Create an an API key for the given payor Id and application Id
-    # @param payor_id [String] The account owner Payor ID
-    # @param application_id [String] Application ID
-    # @param payor_create_api_key_request [PayorCreateApiKeyRequest] Details of application API key to create
-    # @param [Hash] opts the optional parameters
-    # @return [PayorCreateApiKeyResponse]
-    def payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request, opts = {})
-      data, _status_code, _headers = payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request, opts)
-      data
-    end
-
-    # Create API Key
-    # Create an an API key for the given payor Id and application Id
-    # @param payor_id [String] The account owner Payor ID
-    # @param application_id [String] Application ID
-    # @param payor_create_api_key_request [PayorCreateApiKeyRequest] Details of application API key to create
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(PayorCreateApiKeyResponse, Integer, Hash)>] PayorCreateApiKeyResponse data, response status code and response headers
-    def payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PayorApplicationsApi.payor_create_api_key_request ...'
-      end
-      # verify the required parameter 'payor_id' is set
-      if @api_client.config.client_side_validation && payor_id.nil?
-        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayorApplicationsApi.payor_create_api_key_request"
-      end
-      # verify the required parameter 'application_id' is set
-      if @api_client.config.client_side_validation && application_id.nil?
-        fail ArgumentError, "Missing the required parameter 'application_id' when calling PayorApplicationsApi.payor_create_api_key_request"
-      end
-      # verify the required parameter 'payor_create_api_key_request' is set
-      if @api_client.config.client_side_validation && payor_create_api_key_request.nil?
-        fail ArgumentError, "Missing the required parameter 'payor_create_api_key_request' when calling PayorApplicationsApi.payor_create_api_key_request"
-      end
-      # resource path
-      local_var_path = '/v1/payors/{payorId}/applications/{applicationId}/keys'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_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'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(payor_create_api_key_request) 
-
-      # return_type
-      return_type = opts[:return_type] || 'PayorCreateApiKeyResponse' 
-
-      # 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(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PayorApplicationsApi#payor_create_api_key_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Create Application
-    # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-    # @param payor_id [String] The account owner Payor ID
-    # @param payor_create_application_request [PayorCreateApplicationRequest] Details of application to create
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def payor_create_application_request(payor_id, payor_create_application_request, opts = {})
-      payor_create_application_request_with_http_info(payor_id, payor_create_application_request, opts)
-      nil
-    end
-
-    # Create Application
-    # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-    # @param payor_id [String] The account owner Payor ID
-    # @param payor_create_application_request [PayorCreateApplicationRequest] Details of application to create
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def payor_create_application_request_with_http_info(payor_id, payor_create_application_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PayorApplicationsApi.payor_create_application_request ...'
-      end
-      # verify the required parameter 'payor_id' is set
-      if @api_client.config.client_side_validation && payor_id.nil?
-        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayorApplicationsApi.payor_create_application_request"
-      end
-      # verify the required parameter 'payor_create_application_request' is set
-      if @api_client.config.client_side_validation && payor_create_application_request.nil?
-        fail ArgumentError, "Missing the required parameter 'payor_create_application_request' when calling PayorApplicationsApi.payor_create_application_request"
-      end
-      # resource path
-      local_var_path = '/v1/payors/{payorId}/applications'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(payor_create_application_request) 
-
-      # return_type
-      return_type = opts[:return_type] 
-
-      # 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(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PayorApplicationsApi#payor_create_application_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/spec/api/payor_applications_api_spec.rb

@@ -1,62 +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.17.8
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
-
-=end
-
-require 'spec_helper'
-require 'json'
-
-# Unit tests for VeloPayments::PayorApplicationsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'PayorApplicationsApi' do
-  before do
-    # run before each test
-    @api_instance = VeloPayments::PayorApplicationsApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of PayorApplicationsApi' do
-    it 'should create an instance of PayorApplicationsApi' do
-      expect(@api_instance).to be_instance_of(VeloPayments::PayorApplicationsApi)
-    end
-  end
-
-  # unit tests for payor_create_api_key_request
-  # Create API Key
-  # Create an an API key for the given payor Id and application Id
-  # @param payor_id The account owner Payor ID
-  # @param application_id Application ID
-  # @param payor_create_api_key_request Details of application API key to create
-  # @param [Hash] opts the optional parameters
-  # @return [PayorCreateApiKeyResponse]
-  describe 'payor_create_api_key_request test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for payor_create_application_request
-  # Create Application
-  # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-  # @param payor_id The account owner Payor ID
-  # @param payor_create_application_request Details of application to create
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'payor_create_application_request test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-end