mx-platform-ruby 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b7bf8cec23929cbf30de63f0882a276aaf37635577cb805acd1bd9afc9110d
-  data.tar.gz: 3bdab1f7207bb87e83d8ad6d709b964d2f0d26ea1e4282b61beae2e5301627a8
+  metadata.gz: ab1410816217c5640a8be2c03f446b82f6d6a7c16b763dea4ccc6fd799159a4d
+  data.tar.gz: 46f442533a80fb1dd5b493165ca8c19b7aa14098f6c0b6e0fb3502f202fbf86e
 SHA512:
-  metadata.gz: 2a23569dc78294f1114f252c26b1dd703731bbb14db753e190352c8a871d9432cff4641ad8579d272bc0ea1379022ea4d80bd328d03deaaa5f2f936d0363efd4
-  data.tar.gz: 4f17b42abd95b66f216a06a40600d9334b90d9d9c66d13a4e0de5120389af09a2cd06c1fe5c6f71f80d280491985949f9ba99cb79ee176676fdd620d1de37e5a
+  metadata.gz: 9aa1bdc51335fc40aec94e32b1e3c4997d97ad8d8a0959d70a0ae03d167dd822dad08befc47f79e91effa63e8982fb98e0d68d64c11af3f4b4aeada263717c06
+  data.tar.gz: ced2787f5809d0dada6503a97c4147517c7a086c47c217d50a4cdd7846d1c1c5466c2e0c53c4a52fd5a675166688c610a9e318031e5a77be435473f459fec448

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.11.0)
+    mx-platform-ruby (0.12.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -37,8 +37,8 @@ GEM
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -59,7 +59,7 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
@@ -87,4 +87,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.3.8
+   2.3.11

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,9 +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_partner_account**](MxPlatformApi.md#request_partner_account) | **GET** /partner_account | Request partner account |
+| [**request_partner_authorization_code**](MxPlatformApi.md#request_partner_authorization_code) | **POST** /partner_authorization_code | Request partner authorization code |
+| [**request_partner_token**](MxPlatformApi.md#request_partner_token) | **POST** /partner_token | Request partner 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 |
@@ -830,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
 
@@ -5677,13 +5677,13 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
-## request_payment_account
+## request_partner_account
 
-> <PaymentAccountResponseBody> request_payment_account
+> <PartnerAccountResponseBody> request_partner_account
 
-Request payment account
+Request partner account
 
-Use this endpoint to request a payment account.
+Use this endpoint to request a partner account.
 
 ### Examples
 
@@ -5699,29 +5699,29 @@ end
 api_instance = MxPlatformRuby::MxPlatformApi.new
 
 begin
-  # Request payment account
-  result = api_instance.request_payment_account
+  # Request partner account
+  result = api_instance.request_partner_account
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_account: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_account: #{e}"
 end
 ```
 
-#### Using the request_payment_account_with_http_info variant
+#### Using the request_partner_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
+> <Array(<PartnerAccountResponseBody>, Integer, Hash)> request_partner_account_with_http_info
 
 ```ruby
 begin
-  # Request payment account
-  data, status_code, headers = api_instance.request_payment_account_with_http_info
+  # Request partner account
+  data, status_code, headers = api_instance.request_partner_account_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PaymentAccountResponseBody>
+  p data # => <PartnerAccountResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_account_with_http_info: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_account_with_http_info: #{e}"
 end
 ```
 
@@ -5731,7 +5731,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**PaymentAccountResponseBody**](PaymentAccountResponseBody.md)
+[**PartnerAccountResponseBody**](PartnerAccountResponseBody.md)
 
 ### Authorization
 
@@ -5743,13 +5743,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/vnd.mx.api.v1+json
 
 
-## request_payment_processor_authorization_code
+## request_partner_authorization_code
 
-> <PaymentProcessorAuthorizationCodeResponseBody> request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
+> <PartnerAuthorizationCodeResponseBody> request_partner_authorization_code(partner_authorization_code_request_body)
 
-Request payment processor authorization code
+Request partner authorization code
 
-Use this endpoint to request a payment processor authorization code.
+Use this endpoint to request a partner authorization code.
 
 ### Examples
 
@@ -5764,32 +5764,32 @@ MxPlatformRuby.configure do |config|
 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.
+partner_authorization_code_request_body = MxPlatformRuby::PartnerAuthorizationCodeRequestBody.new # PartnerAuthorizationCodeRequestBody | Partner 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)
+  # Request partner authorization code
+  result = api_instance.request_partner_authorization_code(partner_authorization_code_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_authorization_code: #{e}"
 end
 ```
 
-#### Using the request_payment_processor_authorization_code_with_http_info variant
+#### Using the request_partner_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)
+> <Array(<PartnerAuthorizationCodeResponseBody>, Integer, Hash)> request_partner_authorization_code_with_http_info(partner_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)
+  # Request partner authorization code
+  data, status_code, headers = api_instance.request_partner_authorization_code_with_http_info(partner_authorization_code_request_body)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PaymentProcessorAuthorizationCodeResponseBody>
+  p data # => <PartnerAuthorizationCodeResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code_with_http_info: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_authorization_code_with_http_info: #{e}"
 end
 ```
 
@@ -5797,11 +5797,11 @@ end
 
 | 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. |  |
+| **partner_authorization_code_request_body** | [**PartnerAuthorizationCodeRequestBody**](PartnerAuthorizationCodeRequestBody.md) | Partner authorization code object containing account_guid, member_guid, and user_guid. |  |
 
 ### Return type
 
-[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
+[**PartnerAuthorizationCodeResponseBody**](PartnerAuthorizationCodeResponseBody.md)
 
 ### Authorization
 
@@ -5813,13 +5813,13 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
-## request_payment_processor_token
+## request_partner_token
 
-> <PaymentProcessorTokenResponseBody> request_payment_processor_token(opts)
+> <PartnerTokenResponseBody> request_partner_token(opts)
 
-Request payment processor token
+Request partner token
 
-Use this endpoint to request a payment processor token.
+Use this endpoint to request a partner token.
 
 ### Examples
 
@@ -5835,34 +5835,34 @@ end
 
 api_instance = MxPlatformRuby::MxPlatformApi.new
 opts = {
-  code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request processor token.
+  code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request partner token.
   grant_type: 'authorization_code' # String | Specify grant type.
 }
 
 begin
-  # Request payment processor token
-  result = api_instance.request_payment_processor_token(opts)
+  # Request partner token
+  result = api_instance.request_partner_token(opts)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_processor_token: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_token: #{e}"
 end
 ```
 
-#### Using the request_payment_processor_token_with_http_info variant
+#### Using the request_partner_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)
+> <Array(<PartnerTokenResponseBody>, Integer, Hash)> request_partner_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)
+  # Request partner token
+  data, status_code, headers = api_instance.request_partner_token_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PaymentProcessorTokenResponseBody>
+  p data # => <PartnerTokenResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MxPlatformApi->request_payment_processor_token_with_http_info: #{e}"
+  puts "Error when calling MxPlatformApi->request_partner_token_with_http_info: #{e}"
 end
 ```
 
@@ -5870,12 +5870,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Code to request processor token. | [optional] |
+| **code** | **String** | Code to request partner token. | [optional] |
 | **grant_type** | **String** | Specify grant type. | [optional] |
 
 ### Return type
 
-[**PaymentProcessorTokenResponseBody**](PaymentProcessorTokenResponseBody.md)
+[**PartnerTokenResponseBody**](PartnerTokenResponseBody.md)
 
 ### Authorization
 
@@ -6791,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 → PartnerAccountResponse.md}

@@ -1,4 +1,4 @@
-# MxPlatformRuby::PaymentAccountResponse
+# MxPlatformRuby::PartnerAccountResponse
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'mx-platform-ruby'
 
-instance = MxPlatformRuby::PaymentAccountResponse.new(
+instance = MxPlatformRuby::PartnerAccountResponse.new(
   account_name: My Savings,
   account_number: 1858091489,
   account_type: SAVINGS,

data/docs/PartnerAccountResponseBody.md

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

data/docs/{PaymentProcessorAuthorizationCodeRequest.md → PartnerAuthorizationCodeRequest.md}

@@ -1,4 +1,4 @@
-# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest
+# MxPlatformRuby::PartnerAuthorizationCodeRequest
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'mx-platform-ruby'
 
-instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest.new(
+instance = MxPlatformRuby::PartnerAuthorizationCodeRequest.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/PartnerAuthorizationCodeRequestBody.md

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

data/docs/{PaymentProcessorAuthorizationCodeResponse.md → PartnerAuthorizationCodeResponse.md}

@@ -1,4 +1,4 @@
-# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse
+# MxPlatformRuby::PartnerAuthorizationCodeResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'mx-platform-ruby'
 
-instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse.new(
+instance = MxPlatformRuby::PartnerAuthorizationCodeResponse.new(
   authorization_code: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
 )
 ```

data/docs/PartnerAuthorizationCodeResponseBody.md

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

data/docs/{PaymentProcessorTokenResponseBody.md → PartnerTokenResponseBody.md}

@@ -1,4 +1,4 @@
-# MxPlatformRuby::PaymentProcessorTokenResponseBody
+# MxPlatformRuby::PartnerTokenResponseBody
 
 ## Properties
 
@@ -13,9 +13,9 @@
 ```ruby
 require 'mx-platform-ruby'
 
-instance = MxPlatformRuby::PaymentProcessorTokenResponseBody.new(
+instance = MxPlatformRuby::PartnerTokenResponseBody.new(
   access_token: jUmJS4AZVdvywAMO_JWKwZ8fvY9ZZQINSBHTKkHMw-c,
-  scope: payment_accounts,
+  scope: Platform#partner_accounts,
   token_type: bearer
 )
 ```