velopayments 2.17.8 → 2.18.31.beta1

data/docs/LinkForResponse.md

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

data/docs/ListFundingAccountsResponse.md

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

data/docs/ListPaymentsResponse.md

@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**ListPaymentsResponseSummary**](ListPaymentsResponseSummary.md) |  | [optional] 
 **page** | [**ListPaymentsResponsePage**](ListPaymentsResponsePage.md) |  | [optional] 
 **links** | [**Array<GetPayoutsResponseV3Links>**](GetPayoutsResponseV3Links.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV3>**](PaymentResponseV3.md) |  | [optional] 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::ListPaymentsResponse.new(summary: null,
-                                 page: null,
+instance = VeloPayments::ListPaymentsResponse.new(page: null,
                                  links: null,
                                  content: null)
 ```

data/docs/ListPaymentsResponseV4.md

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

data/docs/ListSourceAccountResponseV2.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**ListSourceAccountResponseV2Page**](ListSourceAccountResponseV2Page.md) |  | [optional] 
+**page** | [**PagedUserResponsePage**](PagedUserResponsePage.md) |  | [optional] 
 **links** | [**Array<ListSourceAccountResponseLinks>**](ListSourceAccountResponseLinks.md) |  | [optional] 
 **content** | [**Array<SourceAccountResponseV2>**](SourceAccountResponseV2.md) |  | [optional] 
 

data/docs/LoginApi.md

@@ -0,0 +1,212 @@
+# VeloPayments::LoginApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**logout**](LoginApi.md#logout) | **POST** /v1/logout | Logout
+[**reset_password**](LoginApi.md#reset_password) | **POST** /v1/password/reset | Reset password
+[**validate_access_token**](LoginApi.md#validate_access_token) | **POST** /v1/validate | validate
+[**velo_auth**](LoginApi.md#velo_auth) | **POST** /v1/authenticate | Authentication endpoint
+
+
+
+## logout
+
+> logout
+
+Logout
+
+<p>Given a valid access token in the header then log out the authenticated user or client </p> <p>Will revoke the token</p> 
+
+### 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::LoginApi.new
+
+begin
+  #Logout
+  api_instance.logout
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling LoginApi->logout: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reset_password
+
+> reset_password(reset_password_request)
+
+Reset password
+
+<p>Reset password </p> <p>An email with an embedded link will be sent to the receipient of the email address </p> <p>The link will contain a token to be used for resetting the password </p> 
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+
+api_instance = VeloPayments::LoginApi.new
+reset_password_request = VeloPayments::ResetPasswordRequest.new # ResetPasswordRequest | An Email address to send the reset password link to
+
+begin
+  #Reset password
+  api_instance.reset_password(reset_password_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling LoginApi->reset_password: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **reset_password_request** | [**ResetPasswordRequest**](ResetPasswordRequest.md)| An Email address to send the reset password link to | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_access_token
+
+> AccessTokenResponse validate_access_token(access_token_validation_request)
+
+validate
+
+<p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p> 
+
+### 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::LoginApi.new
+access_token_validation_request = VeloPayments::AccessTokenValidationRequest.new # AccessTokenValidationRequest | An OTP from the user's registered MFA Device 
+
+begin
+  #validate
+  result = api_instance.validate_access_token(access_token_validation_request)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling LoginApi->validate_access_token: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_token_validation_request** | [**AccessTokenValidationRequest**](AccessTokenValidationRequest.md)| An OTP from the user&#39;s registered MFA Device  | 
+
+### Return type
+
+[**AccessTokenResponse**](AccessTokenResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## 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::LoginApi.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 LoginApi->velo_auth: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grant_type** | **String**| OAuth grant type. Should use &#39;client_credentials&#39; | [optional] [default to &#39;client_credentials&#39;]
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MFADetails.md

@@ -0,0 +1,19 @@
+# VeloPayments::MFADetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mfa_type** | [**MFAType**](MFAType.md) |  | [optional] 
+**verified** | **Boolean** | true if the user has used the MFA device for login | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::MFADetails.new(mfa_type: null,
+                                 verified: true)
+```
+
+

data/docs/MFAStatus.md

@@ -0,0 +1,16 @@
+# VeloPayments::MFAStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::MFAStatus.new()
+```
+
+

data/docs/MFAType.md

@@ -0,0 +1,16 @@
+# VeloPayments::MFAType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::MFAType.new()
+```
+
+

data/docs/OTPType.md

@@ -0,0 +1,16 @@
+# VeloPayments::OTPType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::OTPType.new()
+```
+
+

data/docs/PageForResponse.md

@@ -0,0 +1,25 @@
+# VeloPayments::PageForResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_elements** | **Integer** |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+**page** | **Integer** |  | [optional] 
+**page_size** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PageForResponse.new(number_of_elements: null,
+                                 total_elements: null,
+                                 total_pages: null,
+                                 page: null,
+                                 page_size: null)
+```
+
+

data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md

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

data/docs/PagedUserResponse.md

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

data/docs/PagedUserResponseLinks.md

@@ -0,0 +1,19 @@
+# VeloPayments::PagedUserResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PagedUserResponseLinks.new(rel: first,
+                                 href: https://api.sandbox.velopayments.com/v2/users??type=PAYOR&page=1&pageSize=10)
+```
+
+

data/docs/{ListSourceAccountResponseV2Page.md → PagedUserResponsePage.md}

@@ -1,4 +1,4 @@
-# VeloPayments::ListSourceAccountResponseV2Page
+# VeloPayments::PagedUserResponsePage
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::ListSourceAccountResponseV2Page.new(number_of_elements: 12,
+instance = VeloPayments::PagedUserResponsePage.new(number_of_elements: 12,
                                  total_elements: 33,
                                  total_pages: 2,
                                  page: 1,

data/docs/PasswordRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::PasswordRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **String** | a password that passes validation | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PasswordRequest.new(password: My_strong_password)
+```
+
+

data/docs/PayeeInvitationStatus.md

@@ -15,7 +15,7 @@ require 'VeloPayments'
 
 instance = VeloPayments::PayeeInvitationStatus.new(payee_id: null,
                                  invitation_status: ACCEPTED,
-                                 grace_period_end_date: null)
+                                 grace_period_end_date: Sun Feb 03 00:00:00 GMT 2019)
 ```