mx-platform-ruby 1.12.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -6
- data/docs/AccountsApi.md +1 -1
- data/docs/InstitutionResponse.md +1 -1
- data/docs/InstitutionsApi.md +4 -4
- data/docs/MicrodepositsApi.md +1 -1
- data/docs/TransactionsApi.md +4 -4
- data/docs/UsersApi.md +1 -1
- data/docs/WidgetRequest.md +1 -1
- data/lib/mx-platform-ruby/api/accounts_api.rb +2 -2
- data/lib/mx-platform-ruby/api/institutions_api.rb +4 -4
- data/lib/mx-platform-ruby/api/microdeposits_api.rb +2 -2
- data/lib/mx-platform-ruby/api/transactions_api.rb +8 -8
- data/lib/mx-platform-ruby/api/users_api.rb +2 -2
- data/lib/mx-platform-ruby/models/institution_response.rb +1 -0
- data/lib/mx-platform-ruby/models/widget_request.rb +1 -1
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/openapi/config.yml +1 -1
- data/spec/api/accounts_api_spec.rb +1 -1
- data/spec/api/institutions_api_spec.rb +2 -2
- data/spec/api/microdeposits_api_spec.rb +1 -1
- data/spec/api/transactions_api_spec.rb +4 -4
- data/spec/api/users_api_spec.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6047c5749a2db41af8219015899e10e51c09124f58204eb91bca9c834a51f34a
|
|
4
|
+
data.tar.gz: f2e41f8d0aee696605862dfb79004a82a18c038524bc75c8ff38a91fa6ce9780
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4d0aa2b81ff06837a4720ea635895e86121881b51bddae4504a314c95e928b16b1142eebf3d80110a3bf00e6b0109ffd4bf49153530ae05acc23d0400563811f
|
|
7
|
+
data.tar.gz: a8ebd87e150e221de206ee2f3acee5bab4ea77463385fc0408c7c909590477ef1e0e4bfb2ad6d06c1efa8ccb7d2ae99c0d54f44370d369af4e8ec3363b48f874
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
mx-platform-ruby (1.
|
|
4
|
+
mx-platform-ruby (1.13.0)
|
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
|
6
6
|
faraday-multipart
|
|
7
7
|
marcel
|
|
@@ -13,13 +13,13 @@ GEM
|
|
|
13
13
|
base64 (0.3.0)
|
|
14
14
|
byebug (11.1.3)
|
|
15
15
|
coderay (1.1.3)
|
|
16
|
-
date (3.5.
|
|
16
|
+
date (3.5.1)
|
|
17
17
|
diff-lcs (1.6.2)
|
|
18
18
|
faraday (2.8.1)
|
|
19
19
|
base64
|
|
20
20
|
faraday-net_http (>= 2.0, < 3.1)
|
|
21
21
|
ruby2_keywords (>= 0.0.4)
|
|
22
|
-
faraday-multipart (1.
|
|
22
|
+
faraday-multipart (1.2.0)
|
|
23
23
|
multipart-post (~> 2.0)
|
|
24
24
|
faraday-net_http (3.0.2)
|
|
25
25
|
jaro_winkler (1.5.6)
|
|
@@ -27,7 +27,7 @@ GEM
|
|
|
27
27
|
method_source (1.1.0)
|
|
28
28
|
multipart-post (2.4.1)
|
|
29
29
|
parallel (1.24.0)
|
|
30
|
-
parser (3.3.10.
|
|
30
|
+
parser (3.3.10.1)
|
|
31
31
|
ast (~> 2.4.1)
|
|
32
32
|
racc
|
|
33
33
|
pry (0.13.1)
|
|
@@ -36,7 +36,7 @@ GEM
|
|
|
36
36
|
pry-byebug (3.9.0)
|
|
37
37
|
byebug (~> 11.0)
|
|
38
38
|
pry (~> 0.13.0)
|
|
39
|
-
psych (5.
|
|
39
|
+
psych (5.3.1)
|
|
40
40
|
date
|
|
41
41
|
stringio
|
|
42
42
|
racc (1.8.1)
|
|
@@ -54,7 +54,7 @@ GEM
|
|
|
54
54
|
rspec-mocks (3.13.7)
|
|
55
55
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
56
56
|
rspec-support (~> 3.13.0)
|
|
57
|
-
rspec-support (3.13.
|
|
57
|
+
rspec-support (3.13.7)
|
|
58
58
|
rubocop (0.66.0)
|
|
59
59
|
jaro_winkler (~> 1.5.1)
|
|
60
60
|
parallel (~> 1.10)
|
data/docs/AccountsApi.md
CHANGED
|
@@ -481,7 +481,7 @@ end
|
|
|
481
481
|
|
|
482
482
|
List accounts
|
|
483
483
|
|
|
484
|
-
This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](
|
|
484
|
+
This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
|
|
485
485
|
|
|
486
486
|
### Examples
|
|
487
487
|
|
data/docs/InstitutionResponse.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **code** | **String** | | [optional] |
|
|
8
8
|
| **forgot_password_url** | **String** | | [optional] |
|
|
9
9
|
| **forgot_username_url** | **String** | | [optional] |
|
|
10
|
-
| **instructional_text** | **String** |
|
|
10
|
+
| **instructional_text** | **String** | Render this text when end users are asked for their credentials, as it helps end users provide the correct credentials when creating a new member. May contain `<a></a>` tags to link to explanatory material. | [optional] |
|
|
11
11
|
| **instructional_text_steps** | **Array<String>** | An array of instructional steps that may contain html elements. | [optional] |
|
|
12
12
|
| **is_disabled_by_client** | **Boolean** | | [optional] |
|
|
13
13
|
| **iso_country_code** | **String** | | [optional] |
|
data/docs/InstitutionsApi.md
CHANGED
|
@@ -34,7 +34,7 @@ api_instance = MxPlatformRuby::InstitutionsApi.new
|
|
|
34
34
|
opts = {
|
|
35
35
|
iso_country_code: ['inner_example'], # Array<String> | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
36
36
|
page: 1, # Integer | Results are paginated. Specify current page.
|
|
37
|
-
records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
37
|
+
records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
begin
|
|
@@ -70,7 +70,7 @@ end
|
|
|
70
70
|
| ---- | ---- | ----------- | ----- |
|
|
71
71
|
| **iso_country_code** | [**Array<String>**](String.md) | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional] |
|
|
72
72
|
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
73
|
-
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
73
|
+
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional] |
|
|
74
74
|
|
|
75
75
|
### Return type
|
|
76
76
|
|
|
@@ -187,7 +187,7 @@ opts = {
|
|
|
187
187
|
name: 'mxbank', # String | This will list only institutions in which the appended string appears.
|
|
188
188
|
iso_country_code: ['inner_example'], # Array<String> | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
189
189
|
page: 1, # Integer | Results are paginated. Specify current page.
|
|
190
|
-
records_per_page: 10, # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
190
|
+
records_per_page: 10, # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
191
191
|
supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
|
|
192
192
|
supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
|
|
193
193
|
supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
|
|
@@ -228,7 +228,7 @@ end
|
|
|
228
228
|
| **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
|
|
229
229
|
| **iso_country_code** | [**Array<String>**](String.md) | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional] |
|
|
230
230
|
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
231
|
-
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
231
|
+
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional] |
|
|
232
232
|
| **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
|
|
233
233
|
| **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
|
|
234
234
|
| **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
|
data/docs/MicrodepositsApi.md
CHANGED
|
@@ -301,7 +301,7 @@ end
|
|
|
301
301
|
|
|
302
302
|
Read a microdeposit for a user
|
|
303
303
|
|
|
304
|
-
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br
|
|
304
|
+
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
|
|
305
305
|
|
|
306
306
|
### Examples
|
|
307
307
|
|
data/docs/TransactionsApi.md
CHANGED
|
@@ -633,7 +633,7 @@ end
|
|
|
633
633
|
|
|
634
634
|
List transactions by account
|
|
635
635
|
|
|
636
|
-
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
636
|
+
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
637
637
|
|
|
638
638
|
### Examples
|
|
639
639
|
|
|
@@ -935,7 +935,7 @@ end
|
|
|
935
935
|
|
|
936
936
|
Read transaction
|
|
937
937
|
|
|
938
|
-
Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
938
|
+
Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
939
939
|
|
|
940
940
|
### Examples
|
|
941
941
|
|
|
@@ -1011,7 +1011,7 @@ end
|
|
|
1011
1011
|
|
|
1012
1012
|
List Repeating Transactions
|
|
1013
1013
|
|
|
1014
|
-
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](
|
|
1014
|
+
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
|
|
1015
1015
|
|
|
1016
1016
|
### Examples
|
|
1017
1017
|
|
|
@@ -1081,7 +1081,7 @@ end
|
|
|
1081
1081
|
|
|
1082
1082
|
Get a Repeating Transaction
|
|
1083
1083
|
|
|
1084
|
-
Get a Specific Repeating Transaction. <br /><br />List For more see the
|
|
1084
|
+
Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
|
|
1085
1085
|
|
|
1086
1086
|
### Examples
|
|
1087
1087
|
|
data/docs/UsersApi.md
CHANGED
|
@@ -87,7 +87,7 @@ end
|
|
|
87
87
|
|
|
88
88
|
Delete user
|
|
89
89
|
|
|
90
|
-
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](
|
|
90
|
+
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects). :::
|
|
91
91
|
|
|
92
92
|
### Examples
|
|
93
93
|
|
data/docs/WidgetRequest.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **current_institution_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional] |
|
|
12
12
|
| **current_member_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state. `current_member_guid` takes precedence over `current_institution_code` and `current_institution_guid`. | [optional] |
|
|
13
13
|
| **disable_background_agg** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX. | [optional] |
|
|
14
|
-
| **disable_institution_search** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. | [optional] |
|
|
14
|
+
| **disable_institution_search** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. If you set `disable_institution_search` to `true`, you must also listen for the [backToSearch event](/connect/guides/handling-events/#back-to-search) to intercept the user from navigating back to search during the flow. Don't listen for any Primary Action postMessages when you disable search. All buttons that will take a user to the search institution page are still displayed in the Connect Widget experience and your user can still select them. This may trigger during several steps in the Connect Widget flow, such as Connected, MDV/Microdeposits Verified, Login Error, and Credentials/OAuth (back button). | [optional] |
|
|
15
15
|
| **enable_app2app** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional] |
|
|
16
16
|
| **include_identity** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the `mode`. Defaults to `false`. This can be set in either `aggregation` or `verification` mode. The AOI runs after the primary process is complete. | [optional] |
|
|
17
17
|
| **include_transactions** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether transaction data are retrieved. Defaults to `true` in aggregation mode and `false` in verification mode. This can be set in either `aggregation` or `verification` mode. This option does not affect future foreground or background aggregations. | [optional] |
|
|
@@ -471,7 +471,7 @@ module MxPlatformRuby
|
|
|
471
471
|
end
|
|
472
472
|
|
|
473
473
|
# List accounts
|
|
474
|
-
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](
|
|
474
|
+
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
|
|
475
475
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
476
476
|
# @param [Hash] opts the optional parameters
|
|
477
477
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
@@ -486,7 +486,7 @@ module MxPlatformRuby
|
|
|
486
486
|
end
|
|
487
487
|
|
|
488
488
|
# List accounts
|
|
489
|
-
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](
|
|
489
|
+
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
|
|
490
490
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
491
491
|
# @param [Hash] opts the optional parameters
|
|
492
492
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
@@ -24,7 +24,7 @@ module MxPlatformRuby
|
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
26
26
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
27
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
27
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
28
28
|
# @return [InstitutionsResponseBody]
|
|
29
29
|
def list_favorite_institutions(opts = {})
|
|
30
30
|
data, _status_code, _headers = list_favorite_institutions_with_http_info(opts)
|
|
@@ -36,7 +36,7 @@ module MxPlatformRuby
|
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
38
38
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
39
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
39
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
40
40
|
# @return [Array<(InstitutionsResponseBody, Integer, Hash)>] InstitutionsResponseBody data, response status code and response headers
|
|
41
41
|
def list_favorite_institutions_with_http_info(opts = {})
|
|
42
42
|
if @api_client.config.debugging
|
|
@@ -160,7 +160,7 @@ module MxPlatformRuby
|
|
|
160
160
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
|
161
161
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
162
162
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
163
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
163
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
164
164
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
|
165
165
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
|
166
166
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
|
@@ -177,7 +177,7 @@ module MxPlatformRuby
|
|
|
177
177
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
|
178
178
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
179
179
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
180
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
180
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
181
181
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
|
182
182
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
|
183
183
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
|
@@ -287,7 +287,7 @@ module MxPlatformRuby
|
|
|
287
287
|
end
|
|
288
288
|
|
|
289
289
|
# Read a microdeposit for a user
|
|
290
|
-
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br
|
|
290
|
+
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
|
|
291
291
|
# @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
|
|
292
292
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
293
293
|
# @param [Hash] opts the optional parameters
|
|
@@ -298,7 +298,7 @@ module MxPlatformRuby
|
|
|
298
298
|
end
|
|
299
299
|
|
|
300
300
|
# Read a microdeposit for a user
|
|
301
|
-
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br
|
|
301
|
+
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
|
|
302
302
|
# @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
|
|
303
303
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
304
304
|
# @param [Hash] opts the optional parameters
|
|
@@ -619,7 +619,7 @@ module MxPlatformRuby
|
|
|
619
619
|
end
|
|
620
620
|
|
|
621
621
|
# List transactions by account
|
|
622
|
-
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
622
|
+
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
623
623
|
# @param account_guid [String] The unique id for an `account`.
|
|
624
624
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
625
625
|
# @param [Hash] opts the optional parameters
|
|
@@ -643,7 +643,7 @@ module MxPlatformRuby
|
|
|
643
643
|
end
|
|
644
644
|
|
|
645
645
|
# List transactions by account
|
|
646
|
-
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
646
|
+
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
647
647
|
# @param account_guid [String] The unique id for an `account`.
|
|
648
648
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
649
649
|
# @param [Hash] opts the optional parameters
|
|
@@ -946,7 +946,7 @@ module MxPlatformRuby
|
|
|
946
946
|
end
|
|
947
947
|
|
|
948
948
|
# Read transaction
|
|
949
|
-
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
949
|
+
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
950
950
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
951
951
|
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
952
952
|
# @param [Hash] opts the optional parameters
|
|
@@ -958,7 +958,7 @@ module MxPlatformRuby
|
|
|
958
958
|
end
|
|
959
959
|
|
|
960
960
|
# Read transaction
|
|
961
|
-
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
961
|
+
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
962
962
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
963
963
|
# @param transaction_guid [String] The unique id for a `transaction`.
|
|
964
964
|
# @param [Hash] opts the optional parameters
|
|
@@ -1018,7 +1018,7 @@ module MxPlatformRuby
|
|
|
1018
1018
|
end
|
|
1019
1019
|
|
|
1020
1020
|
# List Repeating Transactions
|
|
1021
|
-
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](
|
|
1021
|
+
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
|
|
1022
1022
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1023
1023
|
# @param [Hash] opts the optional parameters
|
|
1024
1024
|
# @return [RepeatingTransactionsResponseBody]
|
|
@@ -1028,7 +1028,7 @@ module MxPlatformRuby
|
|
|
1028
1028
|
end
|
|
1029
1029
|
|
|
1030
1030
|
# List Repeating Transactions
|
|
1031
|
-
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](
|
|
1031
|
+
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
|
|
1032
1032
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1033
1033
|
# @param [Hash] opts the optional parameters
|
|
1034
1034
|
# @return [Array<(RepeatingTransactionsResponseBody, Integer, Hash)>] RepeatingTransactionsResponseBody data, response status code and response headers
|
|
@@ -1081,7 +1081,7 @@ module MxPlatformRuby
|
|
|
1081
1081
|
end
|
|
1082
1082
|
|
|
1083
1083
|
# Get a Repeating Transaction
|
|
1084
|
-
# Get a Specific Repeating Transaction. <br /><br />List For more see the
|
|
1084
|
+
# Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
|
|
1085
1085
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1086
1086
|
# @param repeating_transaction_guid [String] The unique id for a recurring transaction.
|
|
1087
1087
|
# @param [Hash] opts the optional parameters
|
|
@@ -1092,7 +1092,7 @@ module MxPlatformRuby
|
|
|
1092
1092
|
end
|
|
1093
1093
|
|
|
1094
1094
|
# Get a Repeating Transaction
|
|
1095
|
-
# Get a Specific Repeating Transaction. <br /><br />List For more see the
|
|
1095
|
+
# Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
|
|
1096
1096
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1097
1097
|
# @param repeating_transaction_guid [String] The unique id for a recurring transaction.
|
|
1098
1098
|
# @param [Hash] opts the optional parameters
|
|
@@ -88,7 +88,7 @@ module MxPlatformRuby
|
|
|
88
88
|
end
|
|
89
89
|
|
|
90
90
|
# Delete user
|
|
91
|
-
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](
|
|
91
|
+
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects). :::
|
|
92
92
|
# @param accept [String] Specifies the media type expected in the response.
|
|
93
93
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
@@ -99,7 +99,7 @@ module MxPlatformRuby
|
|
|
99
99
|
end
|
|
100
100
|
|
|
101
101
|
# Delete user
|
|
102
|
-
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](
|
|
102
|
+
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects). :::
|
|
103
103
|
# @param accept [String] Specifies the media type expected in the response.
|
|
104
104
|
# @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
105
105
|
# @param [Hash] opts the optional parameters
|
|
@@ -21,6 +21,7 @@ module MxPlatformRuby
|
|
|
21
21
|
|
|
22
22
|
attr_accessor :forgot_username_url
|
|
23
23
|
|
|
24
|
+
# Render this text when end users are asked for their credentials, as it helps end users provide the correct credentials when creating a new member. May contain `<a></a>` tags to link to explanatory material.
|
|
24
25
|
attr_accessor :instructional_text
|
|
25
26
|
|
|
26
27
|
# An array of instructional steps that may contain html elements.
|
|
@@ -36,7 +36,7 @@ module MxPlatformRuby
|
|
|
36
36
|
# Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX.
|
|
37
37
|
attr_accessor :disable_background_agg
|
|
38
38
|
|
|
39
|
-
# Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`.
|
|
39
|
+
# Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. If you set `disable_institution_search` to `true`, you must also listen for the [backToSearch event](/connect/guides/handling-events/#back-to-search) to intercept the user from navigating back to search during the flow. Don't listen for any Primary Action postMessages when you disable search. All buttons that will take a user to the search institution page are still displayed in the Connect Widget experience and your user can still select them. This may trigger during several steps in the Connect Widget flow, such as Connected, MDV/Microdeposits Verified, Login Error, and Credentials/OAuth (back button).
|
|
40
40
|
attr_accessor :disable_institution_search
|
|
41
41
|
|
|
42
42
|
# Only use this option if the `widget_type` is set to `connect_widget`. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.
|
data/openapi/config.yml
CHANGED
|
@@ -122,7 +122,7 @@ describe 'AccountsApi' do
|
|
|
122
122
|
|
|
123
123
|
# unit tests for list_user_accounts
|
|
124
124
|
# List accounts
|
|
125
|
-
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](
|
|
125
|
+
# This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
|
|
126
126
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
127
127
|
# @param [Hash] opts the optional parameters
|
|
128
128
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
@@ -38,7 +38,7 @@ describe 'InstitutionsApi' do
|
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
39
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
40
40
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
41
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
41
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
42
42
|
# @return [InstitutionsResponseBody]
|
|
43
43
|
describe 'list_favorite_institutions test' do
|
|
44
44
|
it 'should work' do
|
|
@@ -67,7 +67,7 @@ describe 'InstitutionsApi' do
|
|
|
67
67
|
# @option opts [String] :name This will list only institutions in which the appended string appears.
|
|
68
68
|
# @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
|
|
69
69
|
# @option opts [Integer] :page Results are paginated. Specify current page.
|
|
70
|
-
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `
|
|
70
|
+
# @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
71
71
|
# @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
|
|
72
72
|
# @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
|
|
73
73
|
# @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
|
|
@@ -84,7 +84,7 @@ describe 'MicrodepositsApi' do
|
|
|
84
84
|
|
|
85
85
|
# unit tests for read_user_microdeposit
|
|
86
86
|
# Read a microdeposit for a user
|
|
87
|
-
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br
|
|
87
|
+
# Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
|
|
88
88
|
# @param micro_deposit_guid The unique identifier for the microdeposit. Defined by MX.
|
|
89
89
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
@@ -152,7 +152,7 @@ describe 'TransactionsApi' do
|
|
|
152
152
|
|
|
153
153
|
# unit tests for list_transactions_by_account
|
|
154
154
|
# List transactions by account
|
|
155
|
-
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
155
|
+
# Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
156
156
|
# @param account_guid The unique id for an `account`.
|
|
157
157
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
158
158
|
# @param [Hash] opts the optional parameters
|
|
@@ -231,7 +231,7 @@ describe 'TransactionsApi' do
|
|
|
231
231
|
|
|
232
232
|
# unit tests for read_transaction
|
|
233
233
|
# Read transaction
|
|
234
|
-
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
234
|
+
# Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
|
|
235
235
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
236
236
|
# @param transaction_guid The unique id for a `transaction`.
|
|
237
237
|
# @param [Hash] opts the optional parameters
|
|
@@ -245,7 +245,7 @@ describe 'TransactionsApi' do
|
|
|
245
245
|
|
|
246
246
|
# unit tests for repeating_transactions
|
|
247
247
|
# List Repeating Transactions
|
|
248
|
-
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](
|
|
248
|
+
# Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
|
|
249
249
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
250
250
|
# @param [Hash] opts the optional parameters
|
|
251
251
|
# @return [RepeatingTransactionsResponseBody]
|
|
@@ -257,7 +257,7 @@ describe 'TransactionsApi' do
|
|
|
257
257
|
|
|
258
258
|
# unit tests for specific_repeating_transaction
|
|
259
259
|
# Get a Repeating Transaction
|
|
260
|
-
# Get a Specific Repeating Transaction. <br /><br />List For more see the
|
|
260
|
+
# Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
|
|
261
261
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
262
262
|
# @param repeating_transaction_guid The unique id for a recurring transaction.
|
|
263
263
|
# @param [Hash] opts the optional parameters
|
data/spec/api/users_api_spec.rb
CHANGED
|
@@ -46,7 +46,7 @@ describe 'UsersApi' do
|
|
|
46
46
|
|
|
47
47
|
# unit tests for delete_user
|
|
48
48
|
# Delete user
|
|
49
|
-
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](
|
|
49
|
+
# Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects). :::
|
|
50
50
|
# @param accept Specifies the media type expected in the response.
|
|
51
51
|
# @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
52
52
|
# @param [Hash] opts the optional parameters
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: mx-platform-ruby
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.13.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- MX
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2026-01-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|