mx-platform-ruby 0.10.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c79e61ba996b5559c17e4d1dc8ec87138454d23e515b57445f40400a71d806
-  data.tar.gz: 8c6978931f616cdea8d57bf33d6b541600bc62ad76b2ff49906e387af1e0cf00
+  metadata.gz: d9d4a26b3ac19690196d2bb65b2832e60224b7edd9551edaf683bad2943262e5
+  data.tar.gz: 18ebac6201fbf962887a2f79eb62b2ffc675ec17a90bf895a3576e2e633825b9
 SHA512:
-  metadata.gz: 8f9da0861c2663bfc726ec1e3c054ed1a3fbc109b69b01e09833ce01117ae19c5d52f834e9ffd92e372225d9fbe9a5e7a83ff929ff6ef7981ec3b80a92407e15
-  data.tar.gz: ee495bad85076c335f6a9e78401848b8f2a666e847f4968c3174374d844e87393b3146a9462dab863271963b9145eac7b6c73b44378f07af7a660e8258cb18f0
+  metadata.gz: 3c88a6dca6e12e87592bd6f837e768d961f882f249e5a2a7d225732596d2323f5c3bfbaebaaff65a4f25e199b14d1913ce1c30f8f41de62e39133e043d26ee8e
+  data.tar.gz: d48da8b5bd045f345d30f935bc9a42b74001b834ee392e88e28d87cf0dcfc8c5c7a76f3060ebc7c3d2a69fdc30a447ce751c14d13a972c49595955b70279585b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.10.0)
+    mx-platform-ruby (0.11.2)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    faraday (1.9.3)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -38,7 +38,7 @@ GEM
     method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -87,4 +87,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.3.7
+   2.3.9

data/docs/CredentialResponse.md

@@ -9,6 +9,7 @@
 | **field_type** | **String** |  | [optional] |
 | **guid** | **String** |  | [optional] |
 | **label** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = MxPlatformRuby::CredentialResponse.new(
   field_name: LOGIN,
   field_type: TEXT,
   guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da,
-  label: Username
+  label: Username,
+  type: TEXT
 )
 ```
 

data/docs/MxPlatformApi.md

@@ -79,6 +79,9 @@ All URIs are relative to *https://api.mx.com*
 | [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
 | [**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_payment_account**](MxPlatformApi.md#request_payment_account) | **GET** /payment_account | Request payment account |
+| [**request_payment_processor_authorization_code**](MxPlatformApi.md#request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | Request payment processor authorization code |
+| [**request_payment_processor_token**](MxPlatformApi.md#request_payment_processor_token) | **POST** /payment_processor_token | Request payment processor token |
 | [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
 | [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
 | [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
@@ -827,7 +830,7 @@ end
 
 Create user
 
-Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
+Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
 
 ### Examples
 
@@ -5674,6 +5677,216 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## request_payment_account
+
+> <PaymentAccountResponseBody> request_payment_account
+
+Request payment account
+
+Use this endpoint to request a payment account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+
+begin
+  # Request payment account
+  result = api_instance.request_payment_account
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_payment_account: #{e}"
+end
+```
+
+#### Using the request_payment_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentAccountResponseBody>, Integer, Hash)> request_payment_account_with_http_info
+
+```ruby
+begin
+  # Request payment account
+  data, status_code, headers = api_instance.request_payment_account_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentAccountResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_payment_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PaymentAccountResponseBody**](PaymentAccountResponseBody.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## request_payment_processor_authorization_code
+
+> <PaymentProcessorAuthorizationCodeResponseBody> request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
+
+Request payment processor authorization code
+
+Use this endpoint to request a payment processor authorization code.
+
+### 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 | Payment processor authorization code object containing account_guid, member_guid, and user_guid.
+
+begin
+  # Request payment processor authorization code
+  result = api_instance.request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code: #{e}"
+end
+```
+
+#### Using the 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)> request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
+
+```ruby
+begin
+  # Request payment processor authorization code
+  data, status_code, headers = api_instance.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->request_payment_processor_authorization_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | Payment processor authorization code object containing account_guid, member_guid, and user_guid. |  |
+
+### Return type
+
+[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## request_payment_processor_token
+
+> <PaymentProcessorTokenResponseBody> request_payment_processor_token(opts)
+
+Request payment processor token
+
+Use this endpoint to request a payment processor token.
+
+### 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
+opts = {
+  code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request processor token.
+  grant_type: 'authorization_code' # String | Specify grant type.
+}
+
+begin
+  # Request payment processor token
+  result = api_instance.request_payment_processor_token(opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_payment_processor_token: #{e}"
+end
+```
+
+#### Using the request_payment_processor_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentProcessorTokenResponseBody>, Integer, Hash)> request_payment_processor_token_with_http_info(opts)
+
+```ruby
+begin
+  # Request payment processor token
+  data, status_code, headers = api_instance.request_payment_processor_token_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentProcessorTokenResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->request_payment_processor_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code to request processor token. | [optional] |
+| **grant_type** | **String** | Specify grant type. | [optional] |
+
+### Return type
+
+[**PaymentProcessorTokenResponseBody**](PaymentProcessorTokenResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## request_widget_url
 
 > <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)
@@ -6578,7 +6791,7 @@ end
 
 Update user
 
-Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
+Use this endpoint to update the attributes of the specified user.
 
 ### Examples
 

data/docs/PaymentAccountResponse.md

@@ -0,0 +1,30 @@
+# MxPlatformRuby::PaymentAccountResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_name** | **String** |  | [optional] |
+| **account_number** | **String** |  | [optional] |
+| **account_type** | **String** |  | [optional] |
+| **available_balance** | **Float** |  | [optional] |
+| **balance** | **Float** |  | [optional] |
+| **routing_number** | **String** |  | [optional] |
+| **transit_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentAccountResponse.new(
+  account_name: My Savings,
+  account_number: 1858091489,
+  account_type: SAVINGS,
+  available_balance: 1000.0,
+  balance: 1000.0,
+  routing_number: 68899990000000,
+  transit_number: 12345
+)
+```
+

data/docs/PaymentAccountResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::PaymentAccountResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_account** | [**PaymentAccountResponse**](PaymentAccountResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentAccountResponseBody.new(
+  payment_account: null
+)
+```
+

data/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-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
+  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/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
+)
+```
+

data/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: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
+)
+```
+

data/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
+)
+```
+

data/docs/PaymentProcessorTokenResponseBody.md

@@ -0,0 +1,22 @@
+# MxPlatformRuby::PaymentProcessorTokenResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  | [optional] |
+| **scope** | **String** |  | [optional] |
+| **token_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::PaymentProcessorTokenResponseBody.new(
+  access_token: jUmJS4AZVdvywAMO_JWKwZ8fvY9ZZQINSBHTKkHMw-c,
+  scope: payment_accounts,
+  token_type: bearer
+)
+```
+