Merge pull request #79 from mxenabled/openapi-generator-0.15.0

Generated version 0.15.0
mxenabled · Apr 19, 2023 · 6a6c0ba · 6a6c0ba
2 parents bf937c6 + 0fb74e5
commit 6a6c0ba
Show file tree

Hide file tree

Showing 31 changed files with 2,538 additions and 2 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -12,6 +12,10 @@ docs/AccountResponseBody.md
 docs/AccountUpdateRequest.md
 docs/AccountUpdateRequestBody.md
 docs/AccountsResponseBody.md
+docs/AuthorizationCodeRequest.md
+docs/AuthorizationCodeRequestBody.md
+docs/AuthorizationCodeResponse.md
+docs/AuthorizationCodeResponseBody.md
 docs/CategoriesResponseBody.md
 docs/CategoryCreateRequest.md
 docs/CategoryCreateRequestBody.md
@@ -72,6 +76,10 @@ docs/OAuthWindowResponse.md
 docs/OAuthWindowResponseBody.md
 docs/OptionResponse.md
 docs/PaginationResponse.md
+docs/PaymentProcessorAuthorizationCodeRequest.md
+docs/PaymentProcessorAuthorizationCodeRequestBody.md
+docs/PaymentProcessorAuthorizationCodeResponse.md
+docs/PaymentProcessorAuthorizationCodeResponseBody.md
 docs/StatementResponse.md
 docs/StatementResponseBody.md
 docs/StatementsResponseBody.md
@@ -126,6 +134,10 @@ lib/mx-platform-ruby/models/account_response_body.rb
 lib/mx-platform-ruby/models/account_update_request.rb
 lib/mx-platform-ruby/models/account_update_request_body.rb
 lib/mx-platform-ruby/models/accounts_response_body.rb
+lib/mx-platform-ruby/models/authorization_code_request.rb
+lib/mx-platform-ruby/models/authorization_code_request_body.rb
+lib/mx-platform-ruby/models/authorization_code_response.rb
+lib/mx-platform-ruby/models/authorization_code_response_body.rb
 lib/mx-platform-ruby/models/categories_response_body.rb
 lib/mx-platform-ruby/models/category_create_request.rb
 lib/mx-platform-ruby/models/category_create_request_body.rb
@@ -185,6 +197,10 @@ lib/mx-platform-ruby/models/o_auth_window_response.rb
 lib/mx-platform-ruby/models/o_auth_window_response_body.rb
 lib/mx-platform-ruby/models/option_response.rb
 lib/mx-platform-ruby/models/pagination_response.rb
+lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb
+lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb
+lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb
+lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb
 lib/mx-platform-ruby/models/statement_response.rb
 lib/mx-platform-ruby/models/statement_response_body.rb
 lib/mx-platform-ruby/models/statements_response_body.rb
@@ -239,6 +255,10 @@ spec/models/account_response_spec.rb
 spec/models/account_update_request_body_spec.rb
 spec/models/account_update_request_spec.rb
 spec/models/accounts_response_body_spec.rb
+spec/models/authorization_code_request_body_spec.rb
+spec/models/authorization_code_request_spec.rb
+spec/models/authorization_code_response_body_spec.rb
+spec/models/authorization_code_response_spec.rb
 spec/models/categories_response_body_spec.rb
 spec/models/category_create_request_body_spec.rb
 spec/models/category_create_request_spec.rb
@@ -298,6 +318,10 @@ spec/models/o_auth_window_response_body_spec.rb
 spec/models/o_auth_window_response_spec.rb
 spec/models/option_response_spec.rb
 spec/models/pagination_response_spec.rb
+spec/models/payment_processor_authorization_code_request_body_spec.rb
+spec/models/payment_processor_authorization_code_request_spec.rb
+spec/models/payment_processor_authorization_code_response_body_spec.rb
+spec/models/payment_processor_authorization_code_response_spec.rb
 spec/models/statement_response_body_spec.rb
 spec/models/statement_response_spec.rb
 spec/models/statements_response_body_spec.rb

diff --git a/docs/AuthorizationCodeRequest.md b/docs/AuthorizationCodeRequest.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::AuthorizationCodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scope** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AuthorizationCodeRequest.new(
+  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
+)
+```
+
diff --git a/docs/AuthorizationCodeRequestBody.md b/docs/AuthorizationCodeRequestBody.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::AuthorizationCodeRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code** | [**AuthorizationCodeRequest**](AuthorizationCodeRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AuthorizationCodeRequestBody.new(
+  authorization_code: null
+)
+```
+
diff --git a/docs/AuthorizationCodeResponse.md b/docs/AuthorizationCodeResponse.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::AuthorizationCodeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AuthorizationCodeResponse.new(
+  code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
+)
+```
+
diff --git a/docs/AuthorizationCodeResponseBody.md b/docs/AuthorizationCodeResponseBody.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::AuthorizationCodeResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code** | [**Array&lt;AuthorizationCodeResponse&gt;**](AuthorizationCodeResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AuthorizationCodeResponseBody.new(
+  authorization_code: null
+)
+```
+
diff --git a/docs/MxPlatformApi.md b/docs/MxPlatformApi.md
@@ -24,6 +24,7 @@ All URIs are relative to *https://api.mx.com*
 | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
 | [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
 | [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
+| [**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
 | [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
 | [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
 | [**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*
 | [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
 | [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
 | [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
+| [**request_authorization_code**](MxPlatformApi.md#request_authorization_code) | **POST** /authorization_code | Request an authorization code. |
 | [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
 | [**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 |
 | [**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)
 - **Accept**: Not defined
 
 
+## deprecated_request_payment_processor_authorization_code
+
+> <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
+
+(Deprecated) Request an authorization code.
+
+(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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
+
+begin
+  # (Deprecated) Request an authorization code.
+  result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
+end
+```
+
+#### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
+
+```ruby
+begin
+  # (Deprecated) Request an authorization code.
+  data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentProcessorAuthorizationCodeResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. |  |
+
+### Return type
+
+[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## download_statement_pdf
 
 > File download_statement_pdf(member_guid, statement_guid, user_guid)
@@ -5686,6 +5758,76 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## request_authorization_code
+
+> <AuthorizationCodeResponseBody> request_authorization_code(authorization_code_request_body)
+
+Request an authorization code.
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+authorization_code_request_body = MxPlatformRuby::AuthorizationCodeRequestBody.new # AuthorizationCodeRequestBody | The scope for the authorization code.
+
+begin
+  # Request an authorization code.
+  result = api_instance.request_authorization_code(authorization_code_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_authorization_code: #{e}"
+end
+```
+
+#### Using the request_authorization_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthorizationCodeResponseBody>, Integer, Hash)> request_authorization_code_with_http_info(authorization_code_request_body)
+
+```ruby
+begin
+  # Request an authorization code.
+  data, status_code, headers = api_instance.request_authorization_code_with_http_info(authorization_code_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthorizationCodeResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_authorization_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code_request_body** | [**AuthorizationCodeRequestBody**](AuthorizationCodeRequestBody.md) | The scope for the authorization code. |  |
+
+### Return type
+
+[**AuthorizationCodeResponseBody**](AuthorizationCodeResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## request_connect_widget_url
 
 > <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)

diff --git a/docs/PaymentProcessorAuthorizationCodeRequest.md b/docs/PaymentProcessorAuthorizationCodeRequest.md
@@ -0,0 +1,22 @@
+# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** |  | [optional] |
+| **member_guid** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest.new(
+  account_guid: ACT-4d4c0068-33bc-4d06-bbd6-cd270fd0135c,
+  member_guid: MBR-46637bc5-942d-4229-9370-ddd858bf805e,
+  user_guid: USR-f12b1f5a-7cbe-467c-aa30-0a10d0b2f549
+)
+```
+
diff --git a/docs/PaymentProcessorAuthorizationCodeRequestBody.md b/docs/PaymentProcessorAuthorizationCodeRequestBody.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeRequest**](PaymentProcessorAuthorizationCodeRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new(
+  payment_processor_authorization_code: null
+)
+```
+
diff --git a/docs/PaymentProcessorAuthorizationCodeResponse.md b/docs/PaymentProcessorAuthorizationCodeResponse.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse.new(
+  authorization_code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
+)
+```
+
diff --git a/docs/PaymentProcessorAuthorizationCodeResponseBody.md b/docs/PaymentProcessorAuthorizationCodeResponseBody.md
@@ -0,0 +1,18 @@
+# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeResponse**](PaymentProcessorAuthorizationCodeResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody.new(
+  payment_processor_authorization_code: null
+)
+```
+