Skip to content

Commit 6a6c0ba

Browse files
mcoats13mcoats13
authored
Merge pull request #79 from mxenabled/openapi-generator-0.15.0
Generated version 0.15.0
2 parents bf937c6 + 0fb74e5 commit 6a6c0ba

31 files changed

Lines changed: 2538 additions & 2 deletions

‎.openapi-generator/FILES‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ docs/AccountResponseBody.md
1212
docs/AccountUpdateRequest.md
1313
docs/AccountUpdateRequestBody.md
1414
docs/AccountsResponseBody.md
15+
docs/AuthorizationCodeRequest.md
16+
docs/AuthorizationCodeRequestBody.md
17+
docs/AuthorizationCodeResponse.md
18+
docs/AuthorizationCodeResponseBody.md
1519
docs/CategoriesResponseBody.md
1620
docs/CategoryCreateRequest.md
1721
docs/CategoryCreateRequestBody.md
@@ -72,6 +76,10 @@ docs/OAuthWindowResponse.md
7276
docs/OAuthWindowResponseBody.md
7377
docs/OptionResponse.md
7478
docs/PaginationResponse.md
79+
docs/PaymentProcessorAuthorizationCodeRequest.md
80+
docs/PaymentProcessorAuthorizationCodeRequestBody.md
81+
docs/PaymentProcessorAuthorizationCodeResponse.md
82+
docs/PaymentProcessorAuthorizationCodeResponseBody.md
7583
docs/StatementResponse.md
7684
docs/StatementResponseBody.md
7785
docs/StatementsResponseBody.md
@@ -126,6 +134,10 @@ lib/mx-platform-ruby/models/account_response_body.rb
126134
lib/mx-platform-ruby/models/account_update_request.rb
127135
lib/mx-platform-ruby/models/account_update_request_body.rb
128136
lib/mx-platform-ruby/models/accounts_response_body.rb
137+
lib/mx-platform-ruby/models/authorization_code_request.rb
138+
lib/mx-platform-ruby/models/authorization_code_request_body.rb
139+
lib/mx-platform-ruby/models/authorization_code_response.rb
140+
lib/mx-platform-ruby/models/authorization_code_response_body.rb
129141
lib/mx-platform-ruby/models/categories_response_body.rb
130142
lib/mx-platform-ruby/models/category_create_request.rb
131143
lib/mx-platform-ruby/models/category_create_request_body.rb
@@ -185,6 +197,10 @@ lib/mx-platform-ruby/models/o_auth_window_response.rb
185197
lib/mx-platform-ruby/models/o_auth_window_response_body.rb
186198
lib/mx-platform-ruby/models/option_response.rb
187199
lib/mx-platform-ruby/models/pagination_response.rb
200+
lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb
201+
lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb
202+
lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb
203+
lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb
188204
lib/mx-platform-ruby/models/statement_response.rb
189205
lib/mx-platform-ruby/models/statement_response_body.rb
190206
lib/mx-platform-ruby/models/statements_response_body.rb
@@ -239,6 +255,10 @@ spec/models/account_response_spec.rb
239255
spec/models/account_update_request_body_spec.rb
240256
spec/models/account_update_request_spec.rb
241257
spec/models/accounts_response_body_spec.rb
258+
spec/models/authorization_code_request_body_spec.rb
259+
spec/models/authorization_code_request_spec.rb
260+
spec/models/authorization_code_response_body_spec.rb
261+
spec/models/authorization_code_response_spec.rb
242262
spec/models/categories_response_body_spec.rb
243263
spec/models/category_create_request_body_spec.rb
244264
spec/models/category_create_request_spec.rb
@@ -298,6 +318,10 @@ spec/models/o_auth_window_response_body_spec.rb
298318
spec/models/o_auth_window_response_spec.rb
299319
spec/models/option_response_spec.rb
300320
spec/models/pagination_response_spec.rb
321+
spec/models/payment_processor_authorization_code_request_body_spec.rb
322+
spec/models/payment_processor_authorization_code_request_spec.rb
323+
spec/models/payment_processor_authorization_code_response_body_spec.rb
324+
spec/models/payment_processor_authorization_code_response_spec.rb
301325
spec/models/statement_response_body_spec.rb
302326
spec/models/statement_response_spec.rb
303327
spec/models/statements_response_body_spec.rb

‎docs/AuthorizationCodeRequest.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::AuthorizationCodeRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **scope** | **String** | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::AuthorizationCodeRequest.new(
15+
scope: user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a account-guid:ACT-32a64160-582a-4f00-ab34-5f49cc35ed35 read-protected
16+
)
17+
```
18+

‎docs/AuthorizationCodeRequestBody.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::AuthorizationCodeRequestBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **authorization_code** | [**AuthorizationCodeRequest**](AuthorizationCodeRequest.md) | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::AuthorizationCodeRequestBody.new(
15+
authorization_code: null
16+
)
17+
```
18+

‎docs/AuthorizationCodeResponse.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::AuthorizationCodeResponse
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **code** | **String** | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::AuthorizationCodeResponse.new(
15+
code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
16+
)
17+
```
18+

‎docs/AuthorizationCodeResponseBody.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MxPlatformRuby::AuthorizationCodeResponseBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **authorization_code** | [**Array<AuthorizationCodeResponse>**](AuthorizationCodeResponse.md) | | [optional] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mx-platform-ruby'
13+
14+
instance = MxPlatformRuby::AuthorizationCodeResponseBody.new(
15+
authorization_code: null
16+
)
17+
```
18+

‎docs/MxPlatformApi.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ All URIs are relative to *https://api.mx.com*
2424
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
2525
| [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
2626
| [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
27+
| [**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
2728
| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
2829
| [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
2930
| [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
@@ -79,6 +80,7 @@ All URIs are relative to *https://api.mx.com*
7980
| [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
8081
| [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
8182
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
83+
| [**request_authorization_code**](MxPlatformApi.md#request_authorization_code) | **POST** /authorization_code | Request an authorization code. |
8284
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
8385
| [**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 |
8486
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
@@ -1536,6 +1538,76 @@ nil (empty response body)
15361538
- **Accept**: Not defined
15371539

15381540

1541+
## deprecated_request_payment_processor_authorization_code
1542+
1543+
> <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
1544+
1545+
(Deprecated) Request an authorization code.
1546+
1547+
(This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
1548+
1549+
### Examples
1550+
1551+
```ruby
1552+
require 'time'
1553+
require 'mx-platform-ruby'
1554+
# setup authorization
1555+
MxPlatformRuby.configure do |config|
1556+
# Configure HTTP basic authorization: basicAuth
1557+
config.username = 'YOUR USERNAME'
1558+
config.password = 'YOUR PASSWORD'
1559+
end
1560+
1561+
api_instance = MxPlatformRuby::MxPlatformApi.new
1562+
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
1563+
1564+
begin
1565+
# (Deprecated) Request an authorization code.
1566+
result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
1567+
p result
1568+
rescue MxPlatformRuby::ApiError => e
1569+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
1570+
end
1571+
```
1572+
1573+
#### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
1574+
1575+
This returns an Array which contains the response data, status code and headers.
1576+
1577+
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
1578+
1579+
```ruby
1580+
begin
1581+
# (Deprecated) Request an authorization code.
1582+
data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
1583+
p status_code # => 2xx
1584+
p headers # => { ... }
1585+
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
1586+
rescue MxPlatformRuby::ApiError => e
1587+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
1588+
end
1589+
```
1590+
1591+
### Parameters
1592+
1593+
| Name | Type | Description | Notes |
1594+
| ---- | ---- | ----------- | ----- |
1595+
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
1596+
1597+
### Return type
1598+
1599+
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
1600+
1601+
### Authorization
1602+
1603+
[basicAuth](../README.md#basicAuth)
1604+
1605+
### HTTP request headers
1606+
1607+
- **Content-Type**: application/json
1608+
- **Accept**: application/vnd.mx.api.v1+json
1609+
1610+
15391611
## download_statement_pdf
15401612

15411613
> File download_statement_pdf(member_guid, statement_guid, user_guid)
@@ -5686,6 +5758,76 @@ end
56865758
- **Accept**: application/vnd.mx.api.v1+json
56875759

56885760

5761+
## request_authorization_code
5762+
5763+
> <AuthorizationCodeResponseBody> request_authorization_code(authorization_code_request_body)
5764+
5765+
Request an authorization code.
5766+
5767+
Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
5768+
5769+
### Examples
5770+
5771+
```ruby
5772+
require 'time'
5773+
require 'mx-platform-ruby'
5774+
# setup authorization
5775+
MxPlatformRuby.configure do |config|
5776+
# Configure HTTP basic authorization: basicAuth
5777+
config.username = 'YOUR USERNAME'
5778+
config.password = 'YOUR PASSWORD'
5779+
end
5780+
5781+
api_instance = MxPlatformRuby::MxPlatformApi.new
5782+
authorization_code_request_body = MxPlatformRuby::AuthorizationCodeRequestBody.new # AuthorizationCodeRequestBody | The scope for the authorization code.
5783+
5784+
begin
5785+
# Request an authorization code.
5786+
result = api_instance.request_authorization_code(authorization_code_request_body)
5787+
p result
5788+
rescue MxPlatformRuby::ApiError => e
5789+
puts "Error when calling MxPlatformApi->request_authorization_code: #{e}"
5790+
end
5791+
```
5792+
5793+
#### Using the request_authorization_code_with_http_info variant
5794+
5795+
This returns an Array which contains the response data, status code and headers.
5796+
5797+
> <Array(<AuthorizationCodeResponseBody>, Integer, Hash)> request_authorization_code_with_http_info(authorization_code_request_body)
5798+
5799+
```ruby
5800+
begin
5801+
# Request an authorization code.
5802+
data, status_code, headers = api_instance.request_authorization_code_with_http_info(authorization_code_request_body)
5803+
p status_code # => 2xx
5804+
p headers # => { ... }
5805+
p data # => <AuthorizationCodeResponseBody>
5806+
rescue MxPlatformRuby::ApiError => e
5807+
puts "Error when calling MxPlatformApi->request_authorization_code_with_http_info: #{e}"
5808+
end
5809+
```
5810+
5811+
### Parameters
5812+
5813+
| Name | Type | Description | Notes |
5814+
| ---- | ---- | ----------- | ----- |
5815+
| **authorization_code_request_body** | [**AuthorizationCodeRequestBody**](AuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
5816+
5817+
### Return type
5818+
5819+
[**AuthorizationCodeResponseBody**](AuthorizationCodeResponseBody.md)
5820+
5821+
### Authorization
5822+
5823+
[basicAuth](../README.md#basicAuth)
5824+
5825+
### HTTP request headers
5826+
5827+
- **Content-Type**: application/json
5828+
- **Accept**: application/vnd.mx.api.v1+json
5829+
5830+
56895831
## request_connect_widget_url
56905832

56915833
> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)

‎docs/PaymentProcessorAuthorizationCodeRequest.md‎

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-4d4c0068-33bc-4d06-bbd6-cd270fd0135c,
18+
member_guid: MBR-46637bc5-942d-4229-9370-ddd858bf805e,
19+
user_guid: USR-f12b1f5a-7cbe-467c-aa30-0a10d0b2f549
20+
)
21+
```
22+

‎docs/PaymentProcessorAuthorizationCodeRequestBody.md‎

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+

‎docs/PaymentProcessorAuthorizationCodeResponse.md‎

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: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
16+
)
17+
```
18+

‎docs/PaymentProcessorAuthorizationCodeResponseBody.md‎

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)