transferzero-sdk 1.30.3 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +4 -7
- data/docs/AccountDebitsApi.md +0 -129
- data/lib/transferzero-sdk/api/account_debits_api.rb +0 -108
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/version.rb +1 -1
- data/lib/transferzero-sdk.rb +0 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9c3ba87248b22e8808d7e8549ffecdc667cd02ddbe26c9a79894a8b135a758ff
|
|
4
|
+
data.tar.gz: c0c86305fbe8de1822d311e72526391192d0e0d63647ee075db29115d104f12e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3b517a948f572a7a171e129d443cc22eaa71a51d1013282ac0efa8255d1db884948e28f83c5bfaec4b673b232cf509686d2f8c8ca27239748f37c98b7228e16f
|
|
7
|
+
data.tar.gz: 79e32aa22eb3ab5eae34f23adf73bea4138725a72a77255279682828d65873a4d5a740c51d11b23c0be0a5335b6056b85080495c27d797b6c9bb23af4fef258c
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 1.0
|
|
10
|
-
- Package version: 1.
|
|
10
|
+
- Package version: 1.31.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
For more information, please visit:
|
|
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
|
|
|
31
31
|
Then either install the gem locally:
|
|
32
32
|
|
|
33
33
|
```shell
|
|
34
|
-
gem install ./transferzero-sdk-1.
|
|
34
|
+
gem install ./transferzero-sdk-1.31.0.gem
|
|
35
35
|
```
|
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.31.0.gem` to install the development dependencies)
|
|
37
37
|
|
|
38
38
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
39
39
|
|
|
40
40
|
Finally add this to the Gemfile:
|
|
41
41
|
|
|
42
|
-
gem 'transferzero-sdk', '~> 1.
|
|
42
|
+
gem 'transferzero-sdk', '~> 1.31.0'
|
|
43
43
|
|
|
44
44
|
### Install from Git
|
|
45
45
|
|
|
@@ -106,8 +106,6 @@ Class | Method | HTTP request | Description
|
|
|
106
106
|
------------ | ------------- | ------------- | -------------
|
|
107
107
|
*TransferZero::APILogsApi* | [**get_api_log**](docs/APILogsApi.md#get_api_log) | **GET** /api_logs/{API Log ID} | Fetch an individual API log
|
|
108
108
|
*TransferZero::APILogsApi* | [**get_api_logs**](docs/APILogsApi.md#get_api_logs) | **GET** /api_logs | Fetch a list of API logs
|
|
109
|
-
*TransferZero::AccountDebitsApi* | [**get_accounts_debit**](docs/AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
|
|
110
|
-
*TransferZero::AccountDebitsApi* | [**get_accounts_debits**](docs/AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
|
|
111
109
|
*TransferZero::AccountDebitsApi* | [**post_accounts_debits**](docs/AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
|
|
112
110
|
*TransferZero::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account or a mobile phone number
|
|
113
111
|
*TransferZero::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{Currency} | Fetches account balance for specified currrency
|
|
@@ -178,7 +176,6 @@ Class | Method | HTTP request | Description
|
|
|
178
176
|
- [TransferZero::DebitListResponse](docs/DebitListResponse.md)
|
|
179
177
|
- [TransferZero::DebitRequest](docs/DebitRequest.md)
|
|
180
178
|
- [TransferZero::DebitRequestWrapper](docs/DebitRequestWrapper.md)
|
|
181
|
-
- [TransferZero::DebitResponse](docs/DebitResponse.md)
|
|
182
179
|
- [TransferZero::Document](docs/Document.md)
|
|
183
180
|
- [TransferZero::DocumentListResponse](docs/DocumentListResponse.md)
|
|
184
181
|
- [TransferZero::DocumentRequest](docs/DocumentRequest.md)
|
data/docs/AccountDebitsApi.md
CHANGED
|
@@ -4,138 +4,9 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**get_accounts_debit**](AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
|
|
8
|
-
[**get_accounts_debits**](AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
|
|
9
7
|
[**post_accounts_debits**](AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
|
|
10
8
|
|
|
11
9
|
|
|
12
|
-
# **get_accounts_debit**
|
|
13
|
-
> DebitResponse get_accounts_debit(account_debit_id)
|
|
14
|
-
|
|
15
|
-
Fetching an account debit
|
|
16
|
-
|
|
17
|
-
Returns a single account debit by the account debit ID
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
```ruby
|
|
21
|
-
# load the gem
|
|
22
|
-
require 'transferzero-sdk'
|
|
23
|
-
|
|
24
|
-
api_instance = TransferZero::AccountDebitsApi.new
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
begin
|
|
28
|
-
#Fetching an account debit
|
|
29
|
-
result = api_instance.get_accounts_debit(account_debit_id)
|
|
30
|
-
p result
|
|
31
|
-
rescue TransferZero::ApiError => e
|
|
32
|
-
if e.validation_error
|
|
33
|
-
puts "WARN: Validation error occured when calling the endpoint"
|
|
34
|
-
result = e.response_object("DebitResponse")
|
|
35
|
-
p result
|
|
36
|
-
else
|
|
37
|
-
puts "Exception when calling AccountDebitsApi->get_accounts_debit: #{e}"
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Parameters
|
|
43
|
-
|
|
44
|
-
Name | Type | Description | Notes
|
|
45
|
-
------------- | ------------- | ------------- | -------------
|
|
46
|
-
**account_debit_id** | [**String**](.md)| ID of the account debit to get. Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d` |
|
|
47
|
-
|
|
48
|
-
### Return type
|
|
49
|
-
|
|
50
|
-
[**DebitResponse**](DebitResponse.md)
|
|
51
|
-
|
|
52
|
-
### Authorization
|
|
53
|
-
|
|
54
|
-
You can set the API Key and Secret on the TransferZero object when setting it up:
|
|
55
|
-
|
|
56
|
-
```ruby
|
|
57
|
-
|
|
58
|
-
TransferZero.configure do |config|
|
|
59
|
-
config.api_key = '<key'
|
|
60
|
-
config.api_secret = '<secret>'
|
|
61
|
-
config.host = 'https://api-sandbox.transferzero.com/v1'
|
|
62
|
-
end
|
|
63
|
-
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### HTTP request headers
|
|
67
|
-
|
|
68
|
-
- **Content-Type**: Not defined
|
|
69
|
-
- **Accept**: application/json
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
# **get_accounts_debits**
|
|
74
|
-
> DebitListResponse get_accounts_debits(opts)
|
|
75
|
-
|
|
76
|
-
Listing Accounts debits
|
|
77
|
-
|
|
78
|
-
Get a list of accounts debits
|
|
79
|
-
|
|
80
|
-
### Example
|
|
81
|
-
```ruby
|
|
82
|
-
# load the gem
|
|
83
|
-
require 'transferzero-sdk'
|
|
84
|
-
|
|
85
|
-
api_instance = TransferZero::AccountDebitsApi.new
|
|
86
|
-
|
|
87
|
-
opts = {
|
|
88
|
-
page: 1 # Integer | The page number to request (defaults to 1)
|
|
89
|
-
per: 10 # Integer | The number of results to load per page (defaults to 10)
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
begin
|
|
93
|
-
#Listing Accounts debits
|
|
94
|
-
result = api_instance.get_accounts_debits(opts)
|
|
95
|
-
p result
|
|
96
|
-
rescue TransferZero::ApiError => e
|
|
97
|
-
if e.validation_error
|
|
98
|
-
puts "WARN: Validation error occured when calling the endpoint"
|
|
99
|
-
result = e.response_object("DebitListResponse")
|
|
100
|
-
p result
|
|
101
|
-
else
|
|
102
|
-
puts "Exception when calling AccountDebitsApi->get_accounts_debits: #{e}"
|
|
103
|
-
end
|
|
104
|
-
end
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Parameters
|
|
108
|
-
|
|
109
|
-
Name | Type | Description | Notes
|
|
110
|
-
------------- | ------------- | ------------- | -------------
|
|
111
|
-
**page** | **Integer**| The page number to request (defaults to 1) | [optional]
|
|
112
|
-
**per** | **Integer**| The number of results to load per page (defaults to 10) | [optional]
|
|
113
|
-
|
|
114
|
-
### Return type
|
|
115
|
-
|
|
116
|
-
[**DebitListResponse**](DebitListResponse.md)
|
|
117
|
-
|
|
118
|
-
### Authorization
|
|
119
|
-
|
|
120
|
-
You can set the API Key and Secret on the TransferZero object when setting it up:
|
|
121
|
-
|
|
122
|
-
```ruby
|
|
123
|
-
|
|
124
|
-
TransferZero.configure do |config|
|
|
125
|
-
config.api_key = '<key'
|
|
126
|
-
config.api_secret = '<secret>'
|
|
127
|
-
config.host = 'https://api-sandbox.transferzero.com/v1'
|
|
128
|
-
end
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### HTTP request headers
|
|
133
|
-
|
|
134
|
-
- **Content-Type**: Not defined
|
|
135
|
-
- **Accept**: application/json
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
10
|
# **post_accounts_debits**
|
|
140
11
|
> DebitListResponse post_accounts_debits(debit_request_wrapper)
|
|
141
12
|
|
|
@@ -21,114 +21,6 @@ module TransferZero
|
|
|
21
21
|
end
|
|
22
22
|
|
|
23
23
|
|
|
24
|
-
# Fetching an account debit
|
|
25
|
-
# Returns a single account debit by the account debit ID
|
|
26
|
-
# @param account_debit_id ID of the account debit to get. Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d`
|
|
27
|
-
# @param [Hash] opts the optional parameters
|
|
28
|
-
# @return [DebitResponse]
|
|
29
|
-
def get_accounts_debit(account_debit_id, opts = {})
|
|
30
|
-
data, _status_code, _headers = get_accounts_debit_with_http_info(account_debit_id, opts)
|
|
31
|
-
data
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# Fetching an account debit
|
|
35
|
-
# Returns a single account debit by the account debit ID
|
|
36
|
-
# @param account_debit_id ID of the account debit to get. Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d`
|
|
37
|
-
# @param [Hash] opts the optional parameters
|
|
38
|
-
# @return [Array<(DebitResponse, Fixnum, Hash)>] DebitResponse data, response status code and response headers
|
|
39
|
-
def get_accounts_debit_with_http_info(account_debit_id, opts = {})
|
|
40
|
-
if @api_client.config.debugging
|
|
41
|
-
@api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debit ...'
|
|
42
|
-
end
|
|
43
|
-
# verify the required parameter 'account_debit_id' is set
|
|
44
|
-
if @api_client.config.client_side_validation && account_debit_id.nil?
|
|
45
|
-
fail ArgumentError, "Missing the required parameter 'account_debit_id' when calling AccountDebitsApi.get_accounts_debit"
|
|
46
|
-
end
|
|
47
|
-
# resource path
|
|
48
|
-
local_var_path = '/accounts/debits/{Account Debit ID}'.sub('{' + 'Account Debit ID' + '}', account_debit_id.to_s)
|
|
49
|
-
|
|
50
|
-
# query parameters
|
|
51
|
-
query_params = {}
|
|
52
|
-
|
|
53
|
-
# header parameters
|
|
54
|
-
header_params = {}
|
|
55
|
-
# HTTP header 'Accept' (if needed)
|
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
57
|
-
|
|
58
|
-
# form parameters
|
|
59
|
-
form_params = {}
|
|
60
|
-
|
|
61
|
-
# http body (model)
|
|
62
|
-
post_body = nil
|
|
63
|
-
auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
|
|
64
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
65
|
-
:header_params => header_params,
|
|
66
|
-
:query_params => query_params,
|
|
67
|
-
:form_params => form_params,
|
|
68
|
-
:body => post_body,
|
|
69
|
-
:auth_names => auth_names,
|
|
70
|
-
:return_type => 'DebitResponse')
|
|
71
|
-
if @api_client.config.debugging
|
|
72
|
-
@api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
|
-
end
|
|
74
|
-
return data, status_code, headers
|
|
75
|
-
end
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
# Listing Accounts debits
|
|
79
|
-
# Get a list of accounts debits
|
|
80
|
-
# @param [Hash] opts the optional parameters
|
|
81
|
-
# @option opts [Integer] :page The page number to request (defaults to 1)
|
|
82
|
-
# @option opts [Integer] :per The number of results to load per page (defaults to 10)
|
|
83
|
-
# @return [DebitListResponse]
|
|
84
|
-
def get_accounts_debits(opts = {})
|
|
85
|
-
data, _status_code, _headers = get_accounts_debits_with_http_info(opts)
|
|
86
|
-
data
|
|
87
|
-
end
|
|
88
|
-
|
|
89
|
-
# Listing Accounts debits
|
|
90
|
-
# Get a list of accounts debits
|
|
91
|
-
# @param [Hash] opts the optional parameters
|
|
92
|
-
# @option opts [Integer] :page The page number to request (defaults to 1)
|
|
93
|
-
# @option opts [Integer] :per The number of results to load per page (defaults to 10)
|
|
94
|
-
# @return [Array<(DebitListResponse, Fixnum, Hash)>] DebitListResponse data, response status code and response headers
|
|
95
|
-
def get_accounts_debits_with_http_info(opts = {})
|
|
96
|
-
if @api_client.config.debugging
|
|
97
|
-
@api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debits ...'
|
|
98
|
-
end
|
|
99
|
-
# resource path
|
|
100
|
-
local_var_path = '/accounts/debits'
|
|
101
|
-
|
|
102
|
-
# query parameters
|
|
103
|
-
query_params = {}
|
|
104
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
105
|
-
query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
|
|
106
|
-
|
|
107
|
-
# header parameters
|
|
108
|
-
header_params = {}
|
|
109
|
-
# HTTP header 'Accept' (if needed)
|
|
110
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
111
|
-
|
|
112
|
-
# form parameters
|
|
113
|
-
form_params = {}
|
|
114
|
-
|
|
115
|
-
# http body (model)
|
|
116
|
-
post_body = nil
|
|
117
|
-
auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
|
|
118
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
119
|
-
:header_params => header_params,
|
|
120
|
-
:query_params => query_params,
|
|
121
|
-
:form_params => form_params,
|
|
122
|
-
:body => post_body,
|
|
123
|
-
:auth_names => auth_names,
|
|
124
|
-
:return_type => 'DebitListResponse')
|
|
125
|
-
if @api_client.config.debugging
|
|
126
|
-
@api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
127
|
-
end
|
|
128
|
-
return data, status_code, headers
|
|
129
|
-
end
|
|
130
|
-
|
|
131
|
-
|
|
132
24
|
# Creating an account debit
|
|
133
25
|
# Creates a new account debit finding transaction through the internal balance To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet Once the transaction is funded, we will immediately start trying to pay out the recipient(s). It is also possible to create multiple account debits by supplying an array of debit objects
|
|
134
26
|
# @param debit_request_wrapper
|
|
@@ -36,7 +36,7 @@ module TransferZero
|
|
|
36
36
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
37
37
|
def initialize(config = Configuration.default)
|
|
38
38
|
@config = config
|
|
39
|
-
@user_agent = "TransferZero-SDK/Ruby/1.
|
|
39
|
+
@user_agent = "TransferZero-SDK/Ruby/1.31.0"
|
|
40
40
|
@default_headers = {
|
|
41
41
|
'Content-Type' => 'application/json',
|
|
42
42
|
'User-Agent' => @user_agent
|
data/lib/transferzero-sdk.rb
CHANGED
|
@@ -38,7 +38,6 @@ require 'transferzero-sdk/models/debit_list_request'
|
|
|
38
38
|
require 'transferzero-sdk/models/debit_list_response'
|
|
39
39
|
require 'transferzero-sdk/models/debit_request'
|
|
40
40
|
require 'transferzero-sdk/models/debit_request_wrapper'
|
|
41
|
-
require 'transferzero-sdk/models/debit_response'
|
|
42
41
|
require 'transferzero-sdk/models/document'
|
|
43
42
|
require 'transferzero-sdk/models/document_list_response'
|
|
44
43
|
require 'transferzero-sdk/models/document_request'
|