Skip to content

Commit b2a65da

Browse files
Merge pull request #65 from mxenabled/openapi-generator-0.11.0
Generated version 0.11.0
2 parents 8756b75 + afb8f52 commit b2a65da

29 files changed

Lines changed: 2545 additions & 2 deletions

.openapi-generator/FILES

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,13 @@ docs/OAuthWindowResponse.md
7272
docs/OAuthWindowResponseBody.md
7373
docs/OptionResponse.md
7474
docs/PaginationResponse.md
75+
docs/PaymentAccountResponse.md
76+
docs/PaymentAccountResponseBody.md
77+
docs/PaymentProcessorAuthorizationCodeRequest.md
78+
docs/PaymentProcessorAuthorizationCodeRequestBody.md
79+
docs/PaymentProcessorAuthorizationCodeResponse.md
80+
docs/PaymentProcessorAuthorizationCodeResponseBody.md
81+
docs/PaymentProcessorTokenResponseBody.md
7582
docs/StatementResponse.md
7683
docs/StatementResponseBody.md
7784
docs/StatementsResponseBody.md
@@ -185,6 +192,13 @@ lib/mx-platform-ruby/models/o_auth_window_response.rb
185192
lib/mx-platform-ruby/models/o_auth_window_response_body.rb
186193
lib/mx-platform-ruby/models/option_response.rb
187194
lib/mx-platform-ruby/models/pagination_response.rb
195+
lib/mx-platform-ruby/models/payment_account_response.rb
196+
lib/mx-platform-ruby/models/payment_account_response_body.rb
197+
lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb
198+
lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb
199+
lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb
200+
lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb
201+
lib/mx-platform-ruby/models/payment_processor_token_response_body.rb
188202
lib/mx-platform-ruby/models/statement_response.rb
189203
lib/mx-platform-ruby/models/statement_response_body.rb
190204
lib/mx-platform-ruby/models/statements_response_body.rb
@@ -298,6 +312,13 @@ spec/models/o_auth_window_response_body_spec.rb
298312
spec/models/o_auth_window_response_spec.rb
299313
spec/models/option_response_spec.rb
300314
spec/models/pagination_response_spec.rb
315+
spec/models/payment_account_response_body_spec.rb
316+
spec/models/payment_account_response_spec.rb
317+
spec/models/payment_processor_authorization_code_request_body_spec.rb
318+
spec/models/payment_processor_authorization_code_request_spec.rb
319+
spec/models/payment_processor_authorization_code_response_body_spec.rb
320+
spec/models/payment_processor_authorization_code_response_spec.rb
321+
spec/models/payment_processor_token_response_body_spec.rb
301322
spec/models/statement_response_body_spec.rb
302323
spec/models/statement_response_spec.rb
303324
spec/models/statements_response_body_spec.rb

docs/MxPlatformApi.md

Lines changed: 213 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ All URIs are relative to *https://api.mx.com*
7979
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
8080
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
8181
| [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
82+
| [**request_payment_account**](MxPlatformApi.md#request_payment_account) | **GET** /payment_account | Request payment account |
83+
| [**request_payment_processor_authorization_code**](MxPlatformApi.md#request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | Request payment processor authorization code |
84+
| [**request_payment_processor_token**](MxPlatformApi.md#request_payment_processor_token) | **POST** /payment_processor_token | Request payment processor token |
8285
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
8386
| [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
8487
| [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
@@ -5674,6 +5677,216 @@ end
56745677
- **Accept**: application/vnd.mx.api.v1+json
56755678

56765679

5680+
## request_payment_account
5681+
5682+
> <PaymentAccountResponseBody> request_payment_account
5683+
5684+
Request payment account
5685+
5686+
Use this endpoint to request a payment account.
5687+
5688+
### Examples
5689+
5690+
```ruby
5691+
require 'time'
5692+
require 'mx-platform-ruby'
5693+
# setup authorization
5694+
MxPlatformRuby.configure do |config|
5695+
# Configure Bearer authorization: bearerAuth
5696+
config.access_token = 'YOUR_BEARER_TOKEN'
5697+
end
5698+
5699+
api_instance = MxPlatformRuby::MxPlatformApi.new
5700+
5701+
begin
5702+
# Request payment account
5703+
result = api_instance.request_payment_account
5704+
p result
5705+
rescue MxPlatformRuby::ApiError => e
5706+
puts "Error when calling MxPlatformApi->request_payment_account: #{e}"
5707+
end
5708+
```
5709+
5710+
#### Using the request_payment_account_with_http_info variant
5711+
5712+
This returns an Array which contains the response data, status code and headers.
5713+
5714+
> <Array(<PaymentAccountResponseBody>, Integer, Hash)> request_payment_account_with_http_info
5715+
5716+
```ruby
5717+
begin
5718+
# Request payment account
5719+
data, status_code, headers = api_instance.request_payment_account_with_http_info
5720+
p status_code # => 2xx
5721+
p headers # => { ... }
5722+
p data # => <PaymentAccountResponseBody>
5723+
rescue MxPlatformRuby::ApiError => e
5724+
puts "Error when calling MxPlatformApi->request_payment_account_with_http_info: #{e}"
5725+
end
5726+
```
5727+
5728+
### Parameters
5729+
5730+
This endpoint does not need any parameter.
5731+
5732+
### Return type
5733+
5734+
[**PaymentAccountResponseBody**](PaymentAccountResponseBody.md)
5735+
5736+
### Authorization
5737+
5738+
[bearerAuth](../README.md#bearerAuth)
5739+
5740+
### HTTP request headers
5741+
5742+
- **Content-Type**: Not defined
5743+
- **Accept**: application/vnd.mx.api.v1+json
5744+
5745+
5746+
## request_payment_processor_authorization_code
5747+
5748+
> <PaymentProcessorAuthorizationCodeResponseBody> request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
5749+
5750+
Request payment processor authorization code
5751+
5752+
Use this endpoint to request a payment processor authorization code.
5753+
5754+
### Examples
5755+
5756+
```ruby
5757+
require 'time'
5758+
require 'mx-platform-ruby'
5759+
# setup authorization
5760+
MxPlatformRuby.configure do |config|
5761+
# Configure HTTP basic authorization: basicAuth
5762+
config.username = 'YOUR USERNAME'
5763+
config.password = 'YOUR PASSWORD'
5764+
end
5765+
5766+
api_instance = MxPlatformRuby::MxPlatformApi.new
5767+
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | Payment processor authorization code object containing account_guid, member_guid, and user_guid.
5768+
5769+
begin
5770+
# Request payment processor authorization code
5771+
result = api_instance.request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
5772+
p result
5773+
rescue MxPlatformRuby::ApiError => e
5774+
puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code: #{e}"
5775+
end
5776+
```
5777+
5778+
#### Using the request_payment_processor_authorization_code_with_http_info variant
5779+
5780+
This returns an Array which contains the response data, status code and headers.
5781+
5782+
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
5783+
5784+
```ruby
5785+
begin
5786+
# Request payment processor authorization code
5787+
data, status_code, headers = api_instance.request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
5788+
p status_code # => 2xx
5789+
p headers # => { ... }
5790+
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
5791+
rescue MxPlatformRuby::ApiError => e
5792+
puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code_with_http_info: #{e}"
5793+
end
5794+
```
5795+
5796+
### Parameters
5797+
5798+
| Name | Type | Description | Notes |
5799+
| ---- | ---- | ----------- | ----- |
5800+
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | Payment processor authorization code object containing account_guid, member_guid, and user_guid. | |
5801+
5802+
### Return type
5803+
5804+
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
5805+
5806+
### Authorization
5807+
5808+
[basicAuth](../README.md#basicAuth)
5809+
5810+
### HTTP request headers
5811+
5812+
- **Content-Type**: application/json
5813+
- **Accept**: application/vnd.mx.api.v1+json
5814+
5815+
5816+
## request_payment_processor_token
5817+
5818+
> <PaymentProcessorTokenResponseBody> request_payment_processor_token(opts)
5819+
5820+
Request payment processor token
5821+
5822+
Use this endpoint to request a payment processor token.
5823+
5824+
### Examples
5825+
5826+
```ruby
5827+
require 'time'
5828+
require 'mx-platform-ruby'
5829+
# setup authorization
5830+
MxPlatformRuby.configure do |config|
5831+
# Configure HTTP basic authorization: basicAuth
5832+
config.username = 'YOUR USERNAME'
5833+
config.password = 'YOUR PASSWORD'
5834+
end
5835+
5836+
api_instance = MxPlatformRuby::MxPlatformApi.new
5837+
opts = {
5838+
code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request processor token.
5839+
grant_type: 'authorization_code' # String | Specify grant type.
5840+
}
5841+
5842+
begin
5843+
# Request payment processor token
5844+
result = api_instance.request_payment_processor_token(opts)
5845+
p result
5846+
rescue MxPlatformRuby::ApiError => e
5847+
puts "Error when calling MxPlatformApi->request_payment_processor_token: #{e}"
5848+
end
5849+
```
5850+
5851+
#### Using the request_payment_processor_token_with_http_info variant
5852+
5853+
This returns an Array which contains the response data, status code and headers.
5854+
5855+
> <Array(<PaymentProcessorTokenResponseBody>, Integer, Hash)> request_payment_processor_token_with_http_info(opts)
5856+
5857+
```ruby
5858+
begin
5859+
# Request payment processor token
5860+
data, status_code, headers = api_instance.request_payment_processor_token_with_http_info(opts)
5861+
p status_code # => 2xx
5862+
p headers # => { ... }
5863+
p data # => <PaymentProcessorTokenResponseBody>
5864+
rescue MxPlatformRuby::ApiError => e
5865+
puts "Error when calling MxPlatformApi->request_payment_processor_token_with_http_info: #{e}"
5866+
end
5867+
```
5868+
5869+
### Parameters
5870+
5871+
| Name | Type | Description | Notes |
5872+
| ---- | ---- | ----------- | ----- |
5873+
| **code** | **String** | Code to request processor token. | [optional] |
5874+
| **grant_type** | **String** | Specify grant type. | [optional] |
5875+
5876+
### Return type
5877+
5878+
[**PaymentProcessorTokenResponseBody**](PaymentProcessorTokenResponseBody.md)
5879+
5880+
### Authorization
5881+
5882+
[basicAuth](../README.md#basicAuth)
5883+
5884+
### HTTP request headers
5885+
5886+
- **Content-Type**: Not defined
5887+
- **Accept**: application/vnd.mx.api.v1+json
5888+
5889+
56775890
## request_widget_url
56785891

56795892
> <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)

docs/PaymentAccountResponse.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# MxPlatformRuby::PaymentAccountResponse
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **account_name** | **String** | | [optional] |
8+
| **account_number** | **String** | | [optional] |
9+
| **account_type** | **String** | | [optional] |
10+
| **available_balance** | **Float** | | [optional] |
11+
| **balance** | **Float** | | [optional] |
12+
| **routing_number** | **String** | | [optional] |
13+
| **transit_number** | **String** | | [optional] |
14+
15+
## Example
16+
17+
```ruby
18+
require 'mx-platform-ruby'
19+
20+
instance = MxPlatformRuby::PaymentAccountResponse.new(
21+
account_name: My Savings,
22+
account_number: 1858091489,
23+
account_type: SAVINGS,
24+
available_balance: 1000.0,
25+
balance: 1000.0,
26+
routing_number: 68899990000000,
27+
transit_number: 12345
28+
)
29+
```
30+

docs/PaymentAccountResponseBody.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::PaymentAccountResponseBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **payment_account** | [**PaymentAccountResponse**](PaymentAccountResponse.md) | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::PaymentAccountResponseBody.new(
15+
payment_account: null
16+
)
17+
```
18+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **account_guid** | **String** | | [optional] |
8+
| **member_guid** | **String** | | [optional] |
9+
| **user_guid** | **String** | | [optional] |
10+
11+
## Example
12+
13+
```ruby
14+
require 'mx-platform-ruby'
15+
16+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest.new(
17+
account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
18+
member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
19+
user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
20+
)
21+
```
22+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeRequest**](PaymentProcessorAuthorizationCodeRequest.md) | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new(
15+
payment_processor_authorization_code: null
16+
)
17+
```
18+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **authorization_code** | **String** | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse.new(
15+
authorization_code: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
16+
)
17+
```
18+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeResponse**](PaymentProcessorAuthorizationCodeResponse.md) | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody.new(
15+
payment_processor_authorization_code: null
16+
)
17+
```
18+

0 commit comments

Comments
 (0)