mx-platform-ruby 0.9.3 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +13 -13
- data/docs/MxPlatformApi.md +86 -76
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +145 -115
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +18 -13
- metadata +2 -2
data/docs/MxPlatformApi.md
CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.mx.com*
|
|
9
9
|
| [**create_category**](MxPlatformApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category |
|
10
10
|
| [**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
|
11
11
|
| [**create_managed_member**](MxPlatformApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member |
|
12
|
-
| [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/transactions | Create managed transaction |
|
12
|
+
| [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction |
|
13
13
|
| [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
|
14
14
|
| [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
|
15
15
|
| [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.mx.com*
|
|
18
18
|
| [**delete_category**](MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category |
|
19
19
|
| [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
|
20
20
|
| [**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
|
21
|
-
| [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Delete managed transaction |
|
21
|
+
| [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Delete managed transaction |
|
22
22
|
| [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
|
23
23
|
| [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
|
24
24
|
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
|
@@ -44,7 +44,7 @@ All URIs are relative to *https://api.mx.com*
|
|
44
44
|
| [**list_managed_accounts**](MxPlatformApi.md#list_managed_accounts) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts | List managed accounts |
|
45
45
|
| [**list_managed_institutions**](MxPlatformApi.md#list_managed_institutions) | **GET** /managed_institutions | List managed institutions |
|
46
46
|
| [**list_managed_members**](MxPlatformApi.md#list_managed_members) | **GET** /users/{user_guid}/managed_members | List managed members |
|
47
|
-
| [**list_managed_transactions**](MxPlatformApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions | List managed transactions |
|
47
|
+
| [**list_managed_transactions**](MxPlatformApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | List managed transactions |
|
48
48
|
| [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges |
|
49
49
|
| [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
|
50
50
|
| [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
|
@@ -66,7 +66,7 @@ All URIs are relative to *https://api.mx.com*
|
|
66
66
|
| [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
|
67
67
|
| [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
|
68
68
|
| [**read_managed_member**](MxPlatformApi.md#read_managed_member) | **GET** /users/{user_guid}/managed_members/{member_guid} | Read managed member |
|
69
|
-
| [**read_managed_transaction**](MxPlatformApi.md#read_managed_transaction) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Read managed transaction |
|
69
|
+
| [**read_managed_transaction**](MxPlatformApi.md#read_managed_transaction) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Read managed transaction |
|
70
70
|
| [**read_member**](MxPlatformApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member |
|
71
71
|
| [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
|
72
72
|
| [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
|
@@ -85,7 +85,7 @@ All URIs are relative to *https://api.mx.com*
|
|
85
85
|
| [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
|
86
86
|
| [**update_managed_account**](MxPlatformApi.md#update_managed_account) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Update managed account |
|
87
87
|
| [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
|
88
|
-
| [**update_managed_transaction**](MxPlatformApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Update managed transaction |
|
88
|
+
| [**update_managed_transaction**](MxPlatformApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Update managed transaction |
|
89
89
|
| [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
|
90
90
|
| [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
|
91
91
|
| [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
|
@@ -313,7 +313,7 @@ end
|
|
313
313
|
|
314
314
|
## create_managed_account
|
315
315
|
|
316
|
-
> <AccountResponseBody> create_managed_account(
|
316
|
+
> <AccountResponseBody> create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
317
317
|
|
318
318
|
Create managed account
|
319
319
|
|
@@ -332,13 +332,13 @@ MxPlatformRuby.configure do |config|
|
|
332
332
|
end
|
333
333
|
|
334
334
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
335
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
336
335
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
336
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
337
337
|
managed_account_create_request_body = MxPlatformRuby::ManagedAccountCreateRequestBody.new # ManagedAccountCreateRequestBody | Managed account to be created.
|
338
338
|
|
339
339
|
begin
|
340
340
|
# Create managed account
|
341
|
-
result = api_instance.create_managed_account(
|
341
|
+
result = api_instance.create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
342
342
|
p result
|
343
343
|
rescue MxPlatformRuby::ApiError => e
|
344
344
|
puts "Error when calling MxPlatformApi->create_managed_account: #{e}"
|
@@ -349,12 +349,12 @@ end
|
|
349
349
|
|
350
350
|
This returns an Array which contains the response data, status code and headers.
|
351
351
|
|
352
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(
|
352
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
353
353
|
|
354
354
|
```ruby
|
355
355
|
begin
|
356
356
|
# Create managed account
|
357
|
-
data, status_code, headers = api_instance.create_managed_account_with_http_info(
|
357
|
+
data, status_code, headers = api_instance.create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
358
358
|
p status_code # => 2xx
|
359
359
|
p headers # => { ... }
|
360
360
|
p data # => <AccountResponseBody>
|
@@ -367,8 +367,8 @@ end
|
|
367
367
|
|
368
368
|
| Name | Type | Description | Notes |
|
369
369
|
| ---- | ---- | ----------- | ----- |
|
370
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
371
370
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
371
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
372
372
|
| **managed_account_create_request_body** | [**ManagedAccountCreateRequestBody**](ManagedAccountCreateRequestBody.md) | Managed account to be created. | |
|
373
373
|
|
374
374
|
### Return type
|
@@ -459,7 +459,7 @@ end
|
|
459
459
|
|
460
460
|
## create_managed_transaction
|
461
461
|
|
462
|
-
> <TransactionResponseBody> create_managed_transaction(
|
462
|
+
> <TransactionResponseBody> create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
463
463
|
|
464
464
|
Create managed transaction
|
465
465
|
|
@@ -478,13 +478,14 @@ MxPlatformRuby.configure do |config|
|
|
478
478
|
end
|
479
479
|
|
480
480
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
481
|
-
|
481
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
482
482
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
483
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
483
484
|
managed_transaction_create_request_body = MxPlatformRuby::ManagedTransactionCreateRequestBody.new # ManagedTransactionCreateRequestBody | Managed transaction to be created.
|
484
485
|
|
485
486
|
begin
|
486
487
|
# Create managed transaction
|
487
|
-
result = api_instance.create_managed_transaction(
|
488
|
+
result = api_instance.create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
488
489
|
p result
|
489
490
|
rescue MxPlatformRuby::ApiError => e
|
490
491
|
puts "Error when calling MxPlatformApi->create_managed_transaction: #{e}"
|
@@ -495,12 +496,12 @@ end
|
|
495
496
|
|
496
497
|
This returns an Array which contains the response data, status code and headers.
|
497
498
|
|
498
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(
|
499
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
499
500
|
|
500
501
|
```ruby
|
501
502
|
begin
|
502
503
|
# Create managed transaction
|
503
|
-
data, status_code, headers = api_instance.create_managed_transaction_with_http_info(
|
504
|
+
data, status_code, headers = api_instance.create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
504
505
|
p status_code # => 2xx
|
505
506
|
p headers # => { ... }
|
506
507
|
p data # => <TransactionResponseBody>
|
@@ -513,8 +514,9 @@ end
|
|
513
514
|
|
514
515
|
| Name | Type | Description | Notes |
|
515
516
|
| ---- | ---- | ----------- | ----- |
|
516
|
-
| **
|
517
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
517
518
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
519
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
518
520
|
| **managed_transaction_create_request_body** | [**ManagedTransactionCreateRequestBody**](ManagedTransactionCreateRequestBody.md) | Managed transaction to be created. | |
|
519
521
|
|
520
522
|
### Return type
|
@@ -962,7 +964,7 @@ nil (empty response body)
|
|
962
964
|
|
963
965
|
## delete_managed_account
|
964
966
|
|
965
|
-
> delete_managed_account(member_guid, user_guid
|
967
|
+
> delete_managed_account(account_guid, member_guid, user_guid)
|
966
968
|
|
967
969
|
Delete managed account
|
968
970
|
|
@@ -981,13 +983,13 @@ MxPlatformRuby.configure do |config|
|
|
981
983
|
end
|
982
984
|
|
983
985
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
986
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
984
987
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
985
988
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
986
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
987
989
|
|
988
990
|
begin
|
989
991
|
# Delete managed account
|
990
|
-
api_instance.delete_managed_account(member_guid, user_guid
|
992
|
+
api_instance.delete_managed_account(account_guid, member_guid, user_guid)
|
991
993
|
rescue MxPlatformRuby::ApiError => e
|
992
994
|
puts "Error when calling MxPlatformApi->delete_managed_account: #{e}"
|
993
995
|
end
|
@@ -997,12 +999,12 @@ end
|
|
997
999
|
|
998
1000
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
999
1001
|
|
1000
|
-
> <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(member_guid, user_guid
|
1002
|
+
> <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
1001
1003
|
|
1002
1004
|
```ruby
|
1003
1005
|
begin
|
1004
1006
|
# Delete managed account
|
1005
|
-
data, status_code, headers = api_instance.delete_managed_account_with_http_info(member_guid, user_guid
|
1007
|
+
data, status_code, headers = api_instance.delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
1006
1008
|
p status_code # => 2xx
|
1007
1009
|
p headers # => { ... }
|
1008
1010
|
p data # => nil
|
@@ -1015,9 +1017,9 @@ end
|
|
1015
1017
|
|
1016
1018
|
| Name | Type | Description | Notes |
|
1017
1019
|
| ---- | ---- | ----------- | ----- |
|
1020
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
1018
1021
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
1019
1022
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
1020
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
1021
1023
|
|
1022
1024
|
### Return type
|
1023
1025
|
|
@@ -1106,7 +1108,7 @@ nil (empty response body)
|
|
1106
1108
|
|
1107
1109
|
## delete_managed_transaction
|
1108
1110
|
|
1109
|
-
> delete_managed_transaction(member_guid,
|
1111
|
+
> delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
1110
1112
|
|
1111
1113
|
Delete managed transaction
|
1112
1114
|
|
@@ -1125,13 +1127,14 @@ MxPlatformRuby.configure do |config|
|
|
1125
1127
|
end
|
1126
1128
|
|
1127
1129
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1130
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
1128
1131
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
1129
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1130
1132
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
1133
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1131
1134
|
|
1132
1135
|
begin
|
1133
1136
|
# Delete managed transaction
|
1134
|
-
api_instance.delete_managed_transaction(member_guid,
|
1137
|
+
api_instance.delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
1135
1138
|
rescue MxPlatformRuby::ApiError => e
|
1136
1139
|
puts "Error when calling MxPlatformApi->delete_managed_transaction: #{e}"
|
1137
1140
|
end
|
@@ -1141,12 +1144,12 @@ end
|
|
1141
1144
|
|
1142
1145
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1143
1146
|
|
1144
|
-
> <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(member_guid,
|
1147
|
+
> <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
1145
1148
|
|
1146
1149
|
```ruby
|
1147
1150
|
begin
|
1148
1151
|
# Delete managed transaction
|
1149
|
-
data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(member_guid,
|
1152
|
+
data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
1150
1153
|
p status_code # => 2xx
|
1151
1154
|
p headers # => { ... }
|
1152
1155
|
p data # => nil
|
@@ -1159,9 +1162,10 @@ end
|
|
1159
1162
|
|
1160
1163
|
| Name | Type | Description | Notes |
|
1161
1164
|
| ---- | ---- | ----------- | ----- |
|
1165
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
1162
1166
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
1163
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
1164
1167
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
1168
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1165
1169
|
|
1166
1170
|
### Return type
|
1167
1171
|
|
@@ -2830,7 +2834,7 @@ end
|
|
2830
2834
|
|
2831
2835
|
## list_managed_accounts
|
2832
2836
|
|
2833
|
-
> <AccountsResponseBody> list_managed_accounts(
|
2837
|
+
> <AccountsResponseBody> list_managed_accounts(member_guid, user_guid, opts)
|
2834
2838
|
|
2835
2839
|
List managed accounts
|
2836
2840
|
|
@@ -2849,8 +2853,8 @@ MxPlatformRuby.configure do |config|
|
|
2849
2853
|
end
|
2850
2854
|
|
2851
2855
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2852
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2853
2856
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
2857
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2854
2858
|
opts = {
|
2855
2859
|
page: 1, # Integer | Specify current page.
|
2856
2860
|
records_per_page: 10 # Integer | Specify records per page.
|
@@ -2858,7 +2862,7 @@ opts = {
|
|
2858
2862
|
|
2859
2863
|
begin
|
2860
2864
|
# List managed accounts
|
2861
|
-
result = api_instance.list_managed_accounts(
|
2865
|
+
result = api_instance.list_managed_accounts(member_guid, user_guid, opts)
|
2862
2866
|
p result
|
2863
2867
|
rescue MxPlatformRuby::ApiError => e
|
2864
2868
|
puts "Error when calling MxPlatformApi->list_managed_accounts: #{e}"
|
@@ -2869,12 +2873,12 @@ end
|
|
2869
2873
|
|
2870
2874
|
This returns an Array which contains the response data, status code and headers.
|
2871
2875
|
|
2872
|
-
> <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(
|
2876
|
+
> <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
2873
2877
|
|
2874
2878
|
```ruby
|
2875
2879
|
begin
|
2876
2880
|
# List managed accounts
|
2877
|
-
data, status_code, headers = api_instance.list_managed_accounts_with_http_info(
|
2881
|
+
data, status_code, headers = api_instance.list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
2878
2882
|
p status_code # => 2xx
|
2879
2883
|
p headers # => { ... }
|
2880
2884
|
p data # => <AccountsResponseBody>
|
@@ -2887,8 +2891,8 @@ end
|
|
2887
2891
|
|
2888
2892
|
| Name | Type | Description | Notes |
|
2889
2893
|
| ---- | ---- | ----------- | ----- |
|
2890
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
2891
2894
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
2895
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
2892
2896
|
| **page** | **Integer** | Specify current page. | [optional] |
|
2893
2897
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
2894
2898
|
|
@@ -3058,7 +3062,7 @@ end
|
|
3058
3062
|
|
3059
3063
|
## list_managed_transactions
|
3060
3064
|
|
3061
|
-
> <TransactionsResponseBody> list_managed_transactions(
|
3065
|
+
> <TransactionsResponseBody> list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
3062
3066
|
|
3063
3067
|
List managed transactions
|
3064
3068
|
|
@@ -3077,8 +3081,9 @@ MxPlatformRuby.configure do |config|
|
|
3077
3081
|
end
|
3078
3082
|
|
3079
3083
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3080
|
-
|
3084
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
3081
3085
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
3086
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
3082
3087
|
opts = {
|
3083
3088
|
page: 1, # Integer | Specify current page.
|
3084
3089
|
records_per_page: 10 # Integer | Specify records per page.
|
@@ -3086,7 +3091,7 @@ opts = {
|
|
3086
3091
|
|
3087
3092
|
begin
|
3088
3093
|
# List managed transactions
|
3089
|
-
result = api_instance.list_managed_transactions(
|
3094
|
+
result = api_instance.list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
3090
3095
|
p result
|
3091
3096
|
rescue MxPlatformRuby::ApiError => e
|
3092
3097
|
puts "Error when calling MxPlatformApi->list_managed_transactions: #{e}"
|
@@ -3097,12 +3102,12 @@ end
|
|
3097
3102
|
|
3098
3103
|
This returns an Array which contains the response data, status code and headers.
|
3099
3104
|
|
3100
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(
|
3105
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
3101
3106
|
|
3102
3107
|
```ruby
|
3103
3108
|
begin
|
3104
3109
|
# List managed transactions
|
3105
|
-
data, status_code, headers = api_instance.list_managed_transactions_with_http_info(
|
3110
|
+
data, status_code, headers = api_instance.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
3106
3111
|
p status_code # => 2xx
|
3107
3112
|
p headers # => { ... }
|
3108
3113
|
p data # => <TransactionsResponseBody>
|
@@ -3115,8 +3120,9 @@ end
|
|
3115
3120
|
|
3116
3121
|
| Name | Type | Description | Notes |
|
3117
3122
|
| ---- | ---- | ----------- | ----- |
|
3118
|
-
| **
|
3123
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
3119
3124
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
3125
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
3120
3126
|
| **page** | **Integer** | Specify current page. | [optional] |
|
3121
3127
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
3122
3128
|
|
@@ -4580,7 +4586,7 @@ end
|
|
4580
4586
|
|
4581
4587
|
## read_managed_account
|
4582
4588
|
|
4583
|
-
> <AccountResponseBody> read_managed_account(member_guid, user_guid
|
4589
|
+
> <AccountResponseBody> read_managed_account(account_guid, member_guid, user_guid)
|
4584
4590
|
|
4585
4591
|
Read managed account
|
4586
4592
|
|
@@ -4599,13 +4605,13 @@ MxPlatformRuby.configure do |config|
|
|
4599
4605
|
end
|
4600
4606
|
|
4601
4607
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4608
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4602
4609
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4603
4610
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4604
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4605
4611
|
|
4606
4612
|
begin
|
4607
4613
|
# Read managed account
|
4608
|
-
result = api_instance.read_managed_account(member_guid, user_guid
|
4614
|
+
result = api_instance.read_managed_account(account_guid, member_guid, user_guid)
|
4609
4615
|
p result
|
4610
4616
|
rescue MxPlatformRuby::ApiError => e
|
4611
4617
|
puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
|
@@ -4616,12 +4622,12 @@ end
|
|
4616
4622
|
|
4617
4623
|
This returns an Array which contains the response data, status code and headers.
|
4618
4624
|
|
4619
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(member_guid, user_guid
|
4625
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
4620
4626
|
|
4621
4627
|
```ruby
|
4622
4628
|
begin
|
4623
4629
|
# Read managed account
|
4624
|
-
data, status_code, headers = api_instance.read_managed_account_with_http_info(member_guid, user_guid
|
4630
|
+
data, status_code, headers = api_instance.read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
4625
4631
|
p status_code # => 2xx
|
4626
4632
|
p headers # => { ... }
|
4627
4633
|
p data # => <AccountResponseBody>
|
@@ -4634,9 +4640,9 @@ end
|
|
4634
4640
|
|
4635
4641
|
| Name | Type | Description | Notes |
|
4636
4642
|
| ---- | ---- | ----------- | ----- |
|
4643
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4637
4644
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4638
4645
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4639
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
4640
4646
|
|
4641
4647
|
### Return type
|
4642
4648
|
|
@@ -4726,7 +4732,7 @@ end
|
|
4726
4732
|
|
4727
4733
|
## read_managed_transaction
|
4728
4734
|
|
4729
|
-
> <TransactionResponseBody> read_managed_transaction(member_guid,
|
4735
|
+
> <TransactionResponseBody> read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
4730
4736
|
|
4731
4737
|
Read managed transaction
|
4732
4738
|
|
@@ -4745,13 +4751,14 @@ MxPlatformRuby.configure do |config|
|
|
4745
4751
|
end
|
4746
4752
|
|
4747
4753
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4754
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4748
4755
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4749
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4750
4756
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
4757
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4751
4758
|
|
4752
4759
|
begin
|
4753
4760
|
# Read managed transaction
|
4754
|
-
result = api_instance.read_managed_transaction(member_guid,
|
4761
|
+
result = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
4755
4762
|
p result
|
4756
4763
|
rescue MxPlatformRuby::ApiError => e
|
4757
4764
|
puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
|
@@ -4762,12 +4769,12 @@ end
|
|
4762
4769
|
|
4763
4770
|
This returns an Array which contains the response data, status code and headers.
|
4764
4771
|
|
4765
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(member_guid,
|
4772
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
4766
4773
|
|
4767
4774
|
```ruby
|
4768
4775
|
begin
|
4769
4776
|
# Read managed transaction
|
4770
|
-
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(member_guid,
|
4777
|
+
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
4771
4778
|
p status_code # => 2xx
|
4772
4779
|
p headers # => { ... }
|
4773
4780
|
p data # => <TransactionResponseBody>
|
@@ -4780,9 +4787,10 @@ end
|
|
4780
4787
|
|
4781
4788
|
| Name | Type | Description | Notes |
|
4782
4789
|
| ---- | ---- | ----------- | ----- |
|
4790
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4783
4791
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4784
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
4785
4792
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
4793
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
4786
4794
|
|
4787
4795
|
### Return type
|
4788
4796
|
|
@@ -5611,8 +5619,8 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique i
|
|
5611
5619
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5612
5620
|
opts = {
|
5613
5621
|
referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
5614
|
-
|
5615
|
-
|
5622
|
+
skip_aggregation: false, # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
5623
|
+
ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
|
5616
5624
|
}
|
5617
5625
|
|
5618
5626
|
begin
|
@@ -5649,8 +5657,8 @@ end
|
|
5649
5657
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
5650
5658
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5651
5659
|
| **referral_source** | **String** | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`. | [optional] |
|
5652
|
-
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
|
5653
5660
|
| **skip_aggregation** | **Boolean** | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
|
5661
|
+
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
|
5654
5662
|
|
5655
5663
|
### Return type
|
5656
5664
|
|
@@ -5818,7 +5826,7 @@ end
|
|
5818
5826
|
|
5819
5827
|
## update_account_by_member
|
5820
5828
|
|
5821
|
-
> <AccountResponseBody> update_account_by_member(
|
5829
|
+
> <AccountResponseBody> update_account_by_member(account_guid, member_guid, user_guid, account_update_request_body)
|
5822
5830
|
|
5823
5831
|
Update account by member
|
5824
5832
|
|
@@ -5837,14 +5845,14 @@ MxPlatformRuby.configure do |config|
|
|
5837
5845
|
end
|
5838
5846
|
|
5839
5847
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5840
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5841
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5842
5848
|
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5849
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5850
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5843
5851
|
account_update_request_body = MxPlatformRuby::AccountUpdateRequestBody.new # AccountUpdateRequestBody | Account object to be created with optional parameters (is_hidden)
|
5844
5852
|
|
5845
5853
|
begin
|
5846
5854
|
# Update account by member
|
5847
|
-
result = api_instance.update_account_by_member(
|
5855
|
+
result = api_instance.update_account_by_member(account_guid, member_guid, user_guid, account_update_request_body)
|
5848
5856
|
p result
|
5849
5857
|
rescue MxPlatformRuby::ApiError => e
|
5850
5858
|
puts "Error when calling MxPlatformApi->update_account_by_member: #{e}"
|
@@ -5855,12 +5863,12 @@ end
|
|
5855
5863
|
|
5856
5864
|
This returns an Array which contains the response data, status code and headers.
|
5857
5865
|
|
5858
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(
|
5866
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(account_guid, member_guid, user_guid, account_update_request_body)
|
5859
5867
|
|
5860
5868
|
```ruby
|
5861
5869
|
begin
|
5862
5870
|
# Update account by member
|
5863
|
-
data, status_code, headers = api_instance.update_account_by_member_with_http_info(
|
5871
|
+
data, status_code, headers = api_instance.update_account_by_member_with_http_info(account_guid, member_guid, user_guid, account_update_request_body)
|
5864
5872
|
p status_code # => 2xx
|
5865
5873
|
p headers # => { ... }
|
5866
5874
|
p data # => <AccountResponseBody>
|
@@ -5873,9 +5881,9 @@ end
|
|
5873
5881
|
|
5874
5882
|
| Name | Type | Description | Notes |
|
5875
5883
|
| ---- | ---- | ----------- | ----- |
|
5876
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5877
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5878
5884
|
| **account_guid** | **String** | The unique id for an `account`. | |
|
5885
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
5886
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
5879
5887
|
| **account_update_request_body** | [**AccountUpdateRequestBody**](AccountUpdateRequestBody.md) | Account object to be created with optional parameters (is_hidden) | |
|
5880
5888
|
|
5881
5889
|
### Return type
|
@@ -5968,7 +5976,7 @@ end
|
|
5968
5976
|
|
5969
5977
|
## update_managed_account
|
5970
5978
|
|
5971
|
-
> <AccountResponseBody> update_managed_account(member_guid, user_guid,
|
5979
|
+
> <AccountResponseBody> update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
5972
5980
|
|
5973
5981
|
Update managed account
|
5974
5982
|
|
@@ -5987,14 +5995,14 @@ MxPlatformRuby.configure do |config|
|
|
5987
5995
|
end
|
5988
5996
|
|
5989
5997
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5998
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5990
5999
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5991
6000
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5992
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5993
6001
|
managed_account_update_request_body = MxPlatformRuby::ManagedAccountUpdateRequestBody.new # ManagedAccountUpdateRequestBody | Managed account object to be updated (While no single parameter is required, the request body can't be empty)
|
5994
6002
|
|
5995
6003
|
begin
|
5996
6004
|
# Update managed account
|
5997
|
-
result = api_instance.update_managed_account(member_guid, user_guid,
|
6005
|
+
result = api_instance.update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
5998
6006
|
p result
|
5999
6007
|
rescue MxPlatformRuby::ApiError => e
|
6000
6008
|
puts "Error when calling MxPlatformApi->update_managed_account: #{e}"
|
@@ -6005,12 +6013,12 @@ end
|
|
6005
6013
|
|
6006
6014
|
This returns an Array which contains the response data, status code and headers.
|
6007
6015
|
|
6008
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(member_guid, user_guid,
|
6016
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
6009
6017
|
|
6010
6018
|
```ruby
|
6011
6019
|
begin
|
6012
6020
|
# Update managed account
|
6013
|
-
data, status_code, headers = api_instance.update_managed_account_with_http_info(member_guid, user_guid,
|
6021
|
+
data, status_code, headers = api_instance.update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
6014
6022
|
p status_code # => 2xx
|
6015
6023
|
p headers # => { ... }
|
6016
6024
|
p data # => <AccountResponseBody>
|
@@ -6023,9 +6031,9 @@ end
|
|
6023
6031
|
|
6024
6032
|
| Name | Type | Description | Notes |
|
6025
6033
|
| ---- | ---- | ----------- | ----- |
|
6034
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
6026
6035
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
6027
6036
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
6028
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
6029
6037
|
| **managed_account_update_request_body** | [**ManagedAccountUpdateRequestBody**](ManagedAccountUpdateRequestBody.md) | Managed account object to be updated (While no single parameter is required, the request body can't be empty) | |
|
6030
6038
|
|
6031
6039
|
### Return type
|
@@ -6118,7 +6126,7 @@ end
|
|
6118
6126
|
|
6119
6127
|
## update_managed_transaction
|
6120
6128
|
|
6121
|
-
> <TransactionResponseBody> update_managed_transaction(
|
6129
|
+
> <TransactionResponseBody> update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6122
6130
|
|
6123
6131
|
Update managed transaction
|
6124
6132
|
|
@@ -6137,14 +6145,15 @@ MxPlatformRuby.configure do |config|
|
|
6137
6145
|
end
|
6138
6146
|
|
6139
6147
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6148
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
6140
6149
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6141
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6142
6150
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
6151
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6143
6152
|
managed_transaction_update_request_body = MxPlatformRuby::ManagedTransactionUpdateRequestBody.new # ManagedTransactionUpdateRequestBody | Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
|
6144
6153
|
|
6145
6154
|
begin
|
6146
6155
|
# Update managed transaction
|
6147
|
-
result = api_instance.update_managed_transaction(
|
6156
|
+
result = api_instance.update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6148
6157
|
p result
|
6149
6158
|
rescue MxPlatformRuby::ApiError => e
|
6150
6159
|
puts "Error when calling MxPlatformApi->update_managed_transaction: #{e}"
|
@@ -6155,12 +6164,12 @@ end
|
|
6155
6164
|
|
6156
6165
|
This returns an Array which contains the response data, status code and headers.
|
6157
6166
|
|
6158
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(
|
6167
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6159
6168
|
|
6160
6169
|
```ruby
|
6161
6170
|
begin
|
6162
6171
|
# Update managed transaction
|
6163
|
-
data, status_code, headers = api_instance.update_managed_transaction_with_http_info(
|
6172
|
+
data, status_code, headers = api_instance.update_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6164
6173
|
p status_code # => 2xx
|
6165
6174
|
p headers # => { ... }
|
6166
6175
|
p data # => <TransactionResponseBody>
|
@@ -6173,9 +6182,10 @@ end
|
|
6173
6182
|
|
6174
6183
|
| Name | Type | Description | Notes |
|
6175
6184
|
| ---- | ---- | ----------- | ----- |
|
6185
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
6176
6186
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
6177
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
6178
6187
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
6188
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
6179
6189
|
| **managed_transaction_update_request_body** | [**ManagedTransactionUpdateRequestBody**](ManagedTransactionUpdateRequestBody.md) | Managed transaction object to be updated (While no single parameter is required, the request body can't be empty) | |
|
6180
6190
|
|
6181
6191
|
### Return type
|