mx-platform-ruby 0.9.2 → 0.11.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 +15 -15
- data/README.md +7 -7
- data/docs/MxPlatformApi.md +309 -90
- data/docs/PaymentAccountResponse.md +30 -0
- data/docs/PaymentAccountResponseBody.md +18 -0
- data/docs/PaymentProcessorAuthorizationCodeRequest.md +22 -0
- data/docs/PaymentProcessorAuthorizationCodeRequestBody.md +18 -0
- data/docs/PaymentProcessorAuthorizationCodeResponse.md +18 -0
- data/docs/PaymentProcessorAuthorizationCodeResponseBody.md +18 -0
- data/docs/PaymentProcessorTokenResponseBody.md +22 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +347 -131
- data/lib/mx-platform-ruby/configuration.rb +7 -0
- data/lib/mx-platform-ruby/models/payment_account_response.rb +279 -0
- data/lib/mx-platform-ruby/models/payment_account_response_body.rb +218 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +236 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +218 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +219 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +218 -0
- data/lib/mx-platform-ruby/models/payment_processor_token_response_body.rb +239 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +7 -0
- data/openapi/config.yml +1 -1
- data/openapi/templates/README.mustache +7 -7
- data/spec/api/mx_platform_api_spec.rb +55 -15
- data/spec/models/payment_account_response_body_spec.rb +34 -0
- data/spec/models/payment_account_response_spec.rb +70 -0
- data/spec/models/payment_processor_authorization_code_request_body_spec.rb +34 -0
- data/spec/models/payment_processor_authorization_code_request_spec.rb +46 -0
- data/spec/models/payment_processor_authorization_code_response_body_spec.rb +34 -0
- data/spec/models/payment_processor_authorization_code_response_spec.rb +34 -0
- data/spec/models/payment_processor_token_response_body_spec.rb +46 -0
- metadata +30 -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 |
|
@@ -79,13 +79,16 @@ All URIs are relative to *https://api.mx.com*
|
|
79
79
|
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
|
80
80
|
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
|
81
81
|
| [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
|
82
|
+
| [**request_payment_account**](MxPlatformApi.md#request_payment_account) | **GET** /payment_account | Request payment account |
|
83
|
+
| [**request_payment_processor_authorization_code**](MxPlatformApi.md#request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | Request payment processor authorization code |
|
84
|
+
| [**request_payment_processor_token**](MxPlatformApi.md#request_payment_processor_token) | **POST** /payment_processor_token | Request payment processor token |
|
82
85
|
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
|
83
86
|
| [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
|
84
87
|
| [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
|
85
88
|
| [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
|
86
89
|
| [**update_managed_account**](MxPlatformApi.md#update_managed_account) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Update managed account |
|
87
90
|
| [**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 |
|
91
|
+
| [**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
92
|
| [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
|
90
93
|
| [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
|
91
94
|
| [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
|
@@ -313,7 +316,7 @@ end
|
|
313
316
|
|
314
317
|
## create_managed_account
|
315
318
|
|
316
|
-
> <AccountResponseBody> create_managed_account(
|
319
|
+
> <AccountResponseBody> create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
317
320
|
|
318
321
|
Create managed account
|
319
322
|
|
@@ -332,13 +335,13 @@ MxPlatformRuby.configure do |config|
|
|
332
335
|
end
|
333
336
|
|
334
337
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
335
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
336
338
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
339
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
337
340
|
managed_account_create_request_body = MxPlatformRuby::ManagedAccountCreateRequestBody.new # ManagedAccountCreateRequestBody | Managed account to be created.
|
338
341
|
|
339
342
|
begin
|
340
343
|
# Create managed account
|
341
|
-
result = api_instance.create_managed_account(
|
344
|
+
result = api_instance.create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
342
345
|
p result
|
343
346
|
rescue MxPlatformRuby::ApiError => e
|
344
347
|
puts "Error when calling MxPlatformApi->create_managed_account: #{e}"
|
@@ -349,12 +352,12 @@ end
|
|
349
352
|
|
350
353
|
This returns an Array which contains the response data, status code and headers.
|
351
354
|
|
352
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(
|
355
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
353
356
|
|
354
357
|
```ruby
|
355
358
|
begin
|
356
359
|
# Create managed account
|
357
|
-
data, status_code, headers = api_instance.create_managed_account_with_http_info(
|
360
|
+
data, status_code, headers = api_instance.create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
358
361
|
p status_code # => 2xx
|
359
362
|
p headers # => { ... }
|
360
363
|
p data # => <AccountResponseBody>
|
@@ -367,8 +370,8 @@ end
|
|
367
370
|
|
368
371
|
| Name | Type | Description | Notes |
|
369
372
|
| ---- | ---- | ----------- | ----- |
|
370
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
371
373
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
374
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
372
375
|
| **managed_account_create_request_body** | [**ManagedAccountCreateRequestBody**](ManagedAccountCreateRequestBody.md) | Managed account to be created. | |
|
373
376
|
|
374
377
|
### Return type
|
@@ -459,7 +462,7 @@ end
|
|
459
462
|
|
460
463
|
## create_managed_transaction
|
461
464
|
|
462
|
-
> <TransactionResponseBody> create_managed_transaction(
|
465
|
+
> <TransactionResponseBody> create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
463
466
|
|
464
467
|
Create managed transaction
|
465
468
|
|
@@ -478,13 +481,14 @@ MxPlatformRuby.configure do |config|
|
|
478
481
|
end
|
479
482
|
|
480
483
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
481
|
-
|
484
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
482
485
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
486
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
483
487
|
managed_transaction_create_request_body = MxPlatformRuby::ManagedTransactionCreateRequestBody.new # ManagedTransactionCreateRequestBody | Managed transaction to be created.
|
484
488
|
|
485
489
|
begin
|
486
490
|
# Create managed transaction
|
487
|
-
result = api_instance.create_managed_transaction(
|
491
|
+
result = api_instance.create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
488
492
|
p result
|
489
493
|
rescue MxPlatformRuby::ApiError => e
|
490
494
|
puts "Error when calling MxPlatformApi->create_managed_transaction: #{e}"
|
@@ -495,12 +499,12 @@ end
|
|
495
499
|
|
496
500
|
This returns an Array which contains the response data, status code and headers.
|
497
501
|
|
498
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(
|
502
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
499
503
|
|
500
504
|
```ruby
|
501
505
|
begin
|
502
506
|
# Create managed transaction
|
503
|
-
data, status_code, headers = api_instance.create_managed_transaction_with_http_info(
|
507
|
+
data, status_code, headers = api_instance.create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
504
508
|
p status_code # => 2xx
|
505
509
|
p headers # => { ... }
|
506
510
|
p data # => <TransactionResponseBody>
|
@@ -513,8 +517,9 @@ end
|
|
513
517
|
|
514
518
|
| Name | Type | Description | Notes |
|
515
519
|
| ---- | ---- | ----------- | ----- |
|
516
|
-
| **
|
520
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
517
521
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
522
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
518
523
|
| **managed_transaction_create_request_body** | [**ManagedTransactionCreateRequestBody**](ManagedTransactionCreateRequestBody.md) | Managed transaction to be created. | |
|
519
524
|
|
520
525
|
### Return type
|
@@ -962,7 +967,7 @@ nil (empty response body)
|
|
962
967
|
|
963
968
|
## delete_managed_account
|
964
969
|
|
965
|
-
> delete_managed_account(member_guid, user_guid
|
970
|
+
> delete_managed_account(account_guid, member_guid, user_guid)
|
966
971
|
|
967
972
|
Delete managed account
|
968
973
|
|
@@ -981,13 +986,13 @@ MxPlatformRuby.configure do |config|
|
|
981
986
|
end
|
982
987
|
|
983
988
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
989
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
984
990
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
985
991
|
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
992
|
|
988
993
|
begin
|
989
994
|
# Delete managed account
|
990
|
-
api_instance.delete_managed_account(member_guid, user_guid
|
995
|
+
api_instance.delete_managed_account(account_guid, member_guid, user_guid)
|
991
996
|
rescue MxPlatformRuby::ApiError => e
|
992
997
|
puts "Error when calling MxPlatformApi->delete_managed_account: #{e}"
|
993
998
|
end
|
@@ -997,12 +1002,12 @@ end
|
|
997
1002
|
|
998
1003
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
999
1004
|
|
1000
|
-
> <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(member_guid, user_guid
|
1005
|
+
> <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
1001
1006
|
|
1002
1007
|
```ruby
|
1003
1008
|
begin
|
1004
1009
|
# Delete managed account
|
1005
|
-
data, status_code, headers = api_instance.delete_managed_account_with_http_info(member_guid, user_guid
|
1010
|
+
data, status_code, headers = api_instance.delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
1006
1011
|
p status_code # => 2xx
|
1007
1012
|
p headers # => { ... }
|
1008
1013
|
p data # => nil
|
@@ -1015,9 +1020,9 @@ end
|
|
1015
1020
|
|
1016
1021
|
| Name | Type | Description | Notes |
|
1017
1022
|
| ---- | ---- | ----------- | ----- |
|
1023
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
1018
1024
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
1019
1025
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
1020
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
1021
1026
|
|
1022
1027
|
### Return type
|
1023
1028
|
|
@@ -1106,7 +1111,7 @@ nil (empty response body)
|
|
1106
1111
|
|
1107
1112
|
## delete_managed_transaction
|
1108
1113
|
|
1109
|
-
> delete_managed_transaction(member_guid,
|
1114
|
+
> delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
1110
1115
|
|
1111
1116
|
Delete managed transaction
|
1112
1117
|
|
@@ -1125,13 +1130,14 @@ MxPlatformRuby.configure do |config|
|
|
1125
1130
|
end
|
1126
1131
|
|
1127
1132
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1133
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
1128
1134
|
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
1135
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
1136
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1131
1137
|
|
1132
1138
|
begin
|
1133
1139
|
# Delete managed transaction
|
1134
|
-
api_instance.delete_managed_transaction(member_guid,
|
1140
|
+
api_instance.delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
1135
1141
|
rescue MxPlatformRuby::ApiError => e
|
1136
1142
|
puts "Error when calling MxPlatformApi->delete_managed_transaction: #{e}"
|
1137
1143
|
end
|
@@ -1141,12 +1147,12 @@ end
|
|
1141
1147
|
|
1142
1148
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1143
1149
|
|
1144
|
-
> <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(member_guid,
|
1150
|
+
> <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
1145
1151
|
|
1146
1152
|
```ruby
|
1147
1153
|
begin
|
1148
1154
|
# Delete managed transaction
|
1149
|
-
data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(member_guid,
|
1155
|
+
data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
1150
1156
|
p status_code # => 2xx
|
1151
1157
|
p headers # => { ... }
|
1152
1158
|
p data # => nil
|
@@ -1159,9 +1165,10 @@ end
|
|
1159
1165
|
|
1160
1166
|
| Name | Type | Description | Notes |
|
1161
1167
|
| ---- | ---- | ----------- | ----- |
|
1168
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
1162
1169
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
1163
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
1164
1170
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
1171
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1165
1172
|
|
1166
1173
|
### Return type
|
1167
1174
|
|
@@ -2830,7 +2837,7 @@ end
|
|
2830
2837
|
|
2831
2838
|
## list_managed_accounts
|
2832
2839
|
|
2833
|
-
> <AccountsResponseBody> list_managed_accounts(
|
2840
|
+
> <AccountsResponseBody> list_managed_accounts(member_guid, user_guid, opts)
|
2834
2841
|
|
2835
2842
|
List managed accounts
|
2836
2843
|
|
@@ -2849,8 +2856,8 @@ MxPlatformRuby.configure do |config|
|
|
2849
2856
|
end
|
2850
2857
|
|
2851
2858
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2852
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2853
2859
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
2860
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2854
2861
|
opts = {
|
2855
2862
|
page: 1, # Integer | Specify current page.
|
2856
2863
|
records_per_page: 10 # Integer | Specify records per page.
|
@@ -2858,7 +2865,7 @@ opts = {
|
|
2858
2865
|
|
2859
2866
|
begin
|
2860
2867
|
# List managed accounts
|
2861
|
-
result = api_instance.list_managed_accounts(
|
2868
|
+
result = api_instance.list_managed_accounts(member_guid, user_guid, opts)
|
2862
2869
|
p result
|
2863
2870
|
rescue MxPlatformRuby::ApiError => e
|
2864
2871
|
puts "Error when calling MxPlatformApi->list_managed_accounts: #{e}"
|
@@ -2869,12 +2876,12 @@ end
|
|
2869
2876
|
|
2870
2877
|
This returns an Array which contains the response data, status code and headers.
|
2871
2878
|
|
2872
|
-
> <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(
|
2879
|
+
> <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
2873
2880
|
|
2874
2881
|
```ruby
|
2875
2882
|
begin
|
2876
2883
|
# List managed accounts
|
2877
|
-
data, status_code, headers = api_instance.list_managed_accounts_with_http_info(
|
2884
|
+
data, status_code, headers = api_instance.list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
2878
2885
|
p status_code # => 2xx
|
2879
2886
|
p headers # => { ... }
|
2880
2887
|
p data # => <AccountsResponseBody>
|
@@ -2887,8 +2894,8 @@ end
|
|
2887
2894
|
|
2888
2895
|
| Name | Type | Description | Notes |
|
2889
2896
|
| ---- | ---- | ----------- | ----- |
|
2890
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
2891
2897
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
2898
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
2892
2899
|
| **page** | **Integer** | Specify current page. | [optional] |
|
2893
2900
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
2894
2901
|
|
@@ -3058,7 +3065,7 @@ end
|
|
3058
3065
|
|
3059
3066
|
## list_managed_transactions
|
3060
3067
|
|
3061
|
-
> <TransactionsResponseBody> list_managed_transactions(
|
3068
|
+
> <TransactionsResponseBody> list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
3062
3069
|
|
3063
3070
|
List managed transactions
|
3064
3071
|
|
@@ -3077,8 +3084,9 @@ MxPlatformRuby.configure do |config|
|
|
3077
3084
|
end
|
3078
3085
|
|
3079
3086
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3080
|
-
|
3087
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
3081
3088
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
3089
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
3082
3090
|
opts = {
|
3083
3091
|
page: 1, # Integer | Specify current page.
|
3084
3092
|
records_per_page: 10 # Integer | Specify records per page.
|
@@ -3086,7 +3094,7 @@ opts = {
|
|
3086
3094
|
|
3087
3095
|
begin
|
3088
3096
|
# List managed transactions
|
3089
|
-
result = api_instance.list_managed_transactions(
|
3097
|
+
result = api_instance.list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
3090
3098
|
p result
|
3091
3099
|
rescue MxPlatformRuby::ApiError => e
|
3092
3100
|
puts "Error when calling MxPlatformApi->list_managed_transactions: #{e}"
|
@@ -3097,12 +3105,12 @@ end
|
|
3097
3105
|
|
3098
3106
|
This returns an Array which contains the response data, status code and headers.
|
3099
3107
|
|
3100
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(
|
3108
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
3101
3109
|
|
3102
3110
|
```ruby
|
3103
3111
|
begin
|
3104
3112
|
# List managed transactions
|
3105
|
-
data, status_code, headers = api_instance.list_managed_transactions_with_http_info(
|
3113
|
+
data, status_code, headers = api_instance.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
3106
3114
|
p status_code # => 2xx
|
3107
3115
|
p headers # => { ... }
|
3108
3116
|
p data # => <TransactionsResponseBody>
|
@@ -3115,8 +3123,9 @@ end
|
|
3115
3123
|
|
3116
3124
|
| Name | Type | Description | Notes |
|
3117
3125
|
| ---- | ---- | ----------- | ----- |
|
3118
|
-
| **
|
3126
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
3119
3127
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
3128
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
3120
3129
|
| **page** | **Integer** | Specify current page. | [optional] |
|
3121
3130
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
3122
3131
|
|
@@ -4368,7 +4377,7 @@ end
|
|
4368
4377
|
|
4369
4378
|
## read_default_category
|
4370
4379
|
|
4371
|
-
> <CategoryResponseBody> read_default_category(category_guid
|
4380
|
+
> <CategoryResponseBody> read_default_category(category_guid)
|
4372
4381
|
|
4373
4382
|
Read a default category
|
4374
4383
|
|
@@ -4388,11 +4397,10 @@ end
|
|
4388
4397
|
|
4389
4398
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4390
4399
|
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
4391
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4392
4400
|
|
4393
4401
|
begin
|
4394
4402
|
# Read a default category
|
4395
|
-
result = api_instance.read_default_category(category_guid
|
4403
|
+
result = api_instance.read_default_category(category_guid)
|
4396
4404
|
p result
|
4397
4405
|
rescue MxPlatformRuby::ApiError => e
|
4398
4406
|
puts "Error when calling MxPlatformApi->read_default_category: #{e}"
|
@@ -4403,12 +4411,12 @@ end
|
|
4403
4411
|
|
4404
4412
|
This returns an Array which contains the response data, status code and headers.
|
4405
4413
|
|
4406
|
-
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid
|
4414
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid)
|
4407
4415
|
|
4408
4416
|
```ruby
|
4409
4417
|
begin
|
4410
4418
|
# Read a default category
|
4411
|
-
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid
|
4419
|
+
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid)
|
4412
4420
|
p status_code # => 2xx
|
4413
4421
|
p headers # => { ... }
|
4414
4422
|
p data # => <CategoryResponseBody>
|
@@ -4422,7 +4430,6 @@ end
|
|
4422
4430
|
| Name | Type | Description | Notes |
|
4423
4431
|
| ---- | ---- | ----------- | ----- |
|
4424
4432
|
| **category_guid** | **String** | The unique id for a `category`. | |
|
4425
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
4426
4433
|
|
4427
4434
|
### Return type
|
4428
4435
|
|
@@ -4582,7 +4589,7 @@ end
|
|
4582
4589
|
|
4583
4590
|
## read_managed_account
|
4584
4591
|
|
4585
|
-
> <AccountResponseBody> read_managed_account(member_guid, user_guid
|
4592
|
+
> <AccountResponseBody> read_managed_account(account_guid, member_guid, user_guid)
|
4586
4593
|
|
4587
4594
|
Read managed account
|
4588
4595
|
|
@@ -4601,13 +4608,13 @@ MxPlatformRuby.configure do |config|
|
|
4601
4608
|
end
|
4602
4609
|
|
4603
4610
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4611
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4604
4612
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4605
4613
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4606
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4607
4614
|
|
4608
4615
|
begin
|
4609
4616
|
# Read managed account
|
4610
|
-
result = api_instance.read_managed_account(member_guid, user_guid
|
4617
|
+
result = api_instance.read_managed_account(account_guid, member_guid, user_guid)
|
4611
4618
|
p result
|
4612
4619
|
rescue MxPlatformRuby::ApiError => e
|
4613
4620
|
puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
|
@@ -4618,12 +4625,12 @@ end
|
|
4618
4625
|
|
4619
4626
|
This returns an Array which contains the response data, status code and headers.
|
4620
4627
|
|
4621
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(member_guid, user_guid
|
4628
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
4622
4629
|
|
4623
4630
|
```ruby
|
4624
4631
|
begin
|
4625
4632
|
# Read managed account
|
4626
|
-
data, status_code, headers = api_instance.read_managed_account_with_http_info(member_guid, user_guid
|
4633
|
+
data, status_code, headers = api_instance.read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
4627
4634
|
p status_code # => 2xx
|
4628
4635
|
p headers # => { ... }
|
4629
4636
|
p data # => <AccountResponseBody>
|
@@ -4636,9 +4643,9 @@ end
|
|
4636
4643
|
|
4637
4644
|
| Name | Type | Description | Notes |
|
4638
4645
|
| ---- | ---- | ----------- | ----- |
|
4646
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4639
4647
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4640
4648
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4641
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
4642
4649
|
|
4643
4650
|
### Return type
|
4644
4651
|
|
@@ -4728,7 +4735,7 @@ end
|
|
4728
4735
|
|
4729
4736
|
## read_managed_transaction
|
4730
4737
|
|
4731
|
-
> <TransactionResponseBody> read_managed_transaction(member_guid,
|
4738
|
+
> <TransactionResponseBody> read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
4732
4739
|
|
4733
4740
|
Read managed transaction
|
4734
4741
|
|
@@ -4747,13 +4754,14 @@ MxPlatformRuby.configure do |config|
|
|
4747
4754
|
end
|
4748
4755
|
|
4749
4756
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4757
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4750
4758
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4751
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4752
4759
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
4760
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4753
4761
|
|
4754
4762
|
begin
|
4755
4763
|
# Read managed transaction
|
4756
|
-
result = api_instance.read_managed_transaction(member_guid,
|
4764
|
+
result = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
4757
4765
|
p result
|
4758
4766
|
rescue MxPlatformRuby::ApiError => e
|
4759
4767
|
puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
|
@@ -4764,12 +4772,12 @@ end
|
|
4764
4772
|
|
4765
4773
|
This returns an Array which contains the response data, status code and headers.
|
4766
4774
|
|
4767
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(member_guid,
|
4775
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
4768
4776
|
|
4769
4777
|
```ruby
|
4770
4778
|
begin
|
4771
4779
|
# Read managed transaction
|
4772
|
-
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(member_guid,
|
4780
|
+
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
4773
4781
|
p status_code # => 2xx
|
4774
4782
|
p headers # => { ... }
|
4775
4783
|
p data # => <TransactionResponseBody>
|
@@ -4782,9 +4790,10 @@ end
|
|
4782
4790
|
|
4783
4791
|
| Name | Type | Description | Notes |
|
4784
4792
|
| ---- | ---- | ----------- | ----- |
|
4793
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4785
4794
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4786
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
4787
4795
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
4796
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
4788
4797
|
|
4789
4798
|
### Return type
|
4790
4799
|
|
@@ -5518,7 +5527,7 @@ end
|
|
5518
5527
|
|
5519
5528
|
## request_connect_widget_url
|
5520
5529
|
|
5521
|
-
> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid,
|
5530
|
+
> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)
|
5522
5531
|
|
5523
5532
|
Request connect widget url
|
5524
5533
|
|
@@ -5538,13 +5547,11 @@ end
|
|
5538
5547
|
|
5539
5548
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5540
5549
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5541
|
-
|
5542
|
-
connect_widget_request_body: MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
|
5543
|
-
}
|
5550
|
+
connect_widget_request_body = MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
|
5544
5551
|
|
5545
5552
|
begin
|
5546
5553
|
# Request connect widget url
|
5547
|
-
result = api_instance.request_connect_widget_url(user_guid,
|
5554
|
+
result = api_instance.request_connect_widget_url(user_guid, connect_widget_request_body)
|
5548
5555
|
p result
|
5549
5556
|
rescue MxPlatformRuby::ApiError => e
|
5550
5557
|
puts "Error when calling MxPlatformApi->request_connect_widget_url: #{e}"
|
@@ -5555,12 +5562,12 @@ end
|
|
5555
5562
|
|
5556
5563
|
This returns an Array which contains the response data, status code and headers.
|
5557
5564
|
|
5558
|
-
> <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid,
|
5565
|
+
> <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
|
5559
5566
|
|
5560
5567
|
```ruby
|
5561
5568
|
begin
|
5562
5569
|
# Request connect widget url
|
5563
|
-
data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid,
|
5570
|
+
data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
|
5564
5571
|
p status_code # => 2xx
|
5565
5572
|
p headers # => { ... }
|
5566
5573
|
p data # => <ConnectWidgetResponseBody>
|
@@ -5574,7 +5581,7 @@ end
|
|
5574
5581
|
| Name | Type | Description | Notes |
|
5575
5582
|
| ---- | ---- | ----------- | ----- |
|
5576
5583
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5577
|
-
| **connect_widget_request_body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md) | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) |
|
5584
|
+
| **connect_widget_request_body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md) | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) | |
|
5578
5585
|
|
5579
5586
|
### Return type
|
5580
5587
|
|
@@ -5615,8 +5622,8 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique i
|
|
5615
5622
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5616
5623
|
opts = {
|
5617
5624
|
referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
5618
|
-
|
5619
|
-
|
5625
|
+
skip_aggregation: false, # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
5626
|
+
ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
|
5620
5627
|
}
|
5621
5628
|
|
5622
5629
|
begin
|
@@ -5653,8 +5660,8 @@ end
|
|
5653
5660
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
5654
5661
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5655
5662
|
| **referral_source** | **String** | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`. | [optional] |
|
5656
|
-
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
|
5657
5663
|
| **skip_aggregation** | **Boolean** | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
|
5664
|
+
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
|
5658
5665
|
|
5659
5666
|
### Return type
|
5660
5667
|
|
@@ -5670,6 +5677,216 @@ end
|
|
5670
5677
|
- **Accept**: application/vnd.mx.api.v1+json
|
5671
5678
|
|
5672
5679
|
|
5680
|
+
## request_payment_account
|
5681
|
+
|
5682
|
+
> <PaymentAccountResponseBody> request_payment_account
|
5683
|
+
|
5684
|
+
Request payment account
|
5685
|
+
|
5686
|
+
Use this endpoint to request a payment account.
|
5687
|
+
|
5688
|
+
### Examples
|
5689
|
+
|
5690
|
+
```ruby
|
5691
|
+
require 'time'
|
5692
|
+
require 'mx-platform-ruby'
|
5693
|
+
# setup authorization
|
5694
|
+
MxPlatformRuby.configure do |config|
|
5695
|
+
# Configure Bearer authorization: bearerAuth
|
5696
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
5697
|
+
end
|
5698
|
+
|
5699
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5700
|
+
|
5701
|
+
begin
|
5702
|
+
# Request payment account
|
5703
|
+
result = api_instance.request_payment_account
|
5704
|
+
p result
|
5705
|
+
rescue MxPlatformRuby::ApiError => e
|
5706
|
+
puts "Error when calling MxPlatformApi->request_payment_account: #{e}"
|
5707
|
+
end
|
5708
|
+
```
|
5709
|
+
|
5710
|
+
#### Using the request_payment_account_with_http_info variant
|
5711
|
+
|
5712
|
+
This returns an Array which contains the response data, status code and headers.
|
5713
|
+
|
5714
|
+
> <Array(<PaymentAccountResponseBody>, Integer, Hash)> request_payment_account_with_http_info
|
5715
|
+
|
5716
|
+
```ruby
|
5717
|
+
begin
|
5718
|
+
# Request payment account
|
5719
|
+
data, status_code, headers = api_instance.request_payment_account_with_http_info
|
5720
|
+
p status_code # => 2xx
|
5721
|
+
p headers # => { ... }
|
5722
|
+
p data # => <PaymentAccountResponseBody>
|
5723
|
+
rescue MxPlatformRuby::ApiError => e
|
5724
|
+
puts "Error when calling MxPlatformApi->request_payment_account_with_http_info: #{e}"
|
5725
|
+
end
|
5726
|
+
```
|
5727
|
+
|
5728
|
+
### Parameters
|
5729
|
+
|
5730
|
+
This endpoint does not need any parameter.
|
5731
|
+
|
5732
|
+
### Return type
|
5733
|
+
|
5734
|
+
[**PaymentAccountResponseBody**](PaymentAccountResponseBody.md)
|
5735
|
+
|
5736
|
+
### Authorization
|
5737
|
+
|
5738
|
+
[bearerAuth](../README.md#bearerAuth)
|
5739
|
+
|
5740
|
+
### HTTP request headers
|
5741
|
+
|
5742
|
+
- **Content-Type**: Not defined
|
5743
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
5744
|
+
|
5745
|
+
|
5746
|
+
## request_payment_processor_authorization_code
|
5747
|
+
|
5748
|
+
> <PaymentProcessorAuthorizationCodeResponseBody> request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
5749
|
+
|
5750
|
+
Request payment processor authorization code
|
5751
|
+
|
5752
|
+
Use this endpoint to request a payment processor authorization code.
|
5753
|
+
|
5754
|
+
### Examples
|
5755
|
+
|
5756
|
+
```ruby
|
5757
|
+
require 'time'
|
5758
|
+
require 'mx-platform-ruby'
|
5759
|
+
# setup authorization
|
5760
|
+
MxPlatformRuby.configure do |config|
|
5761
|
+
# Configure HTTP basic authorization: basicAuth
|
5762
|
+
config.username = 'YOUR USERNAME'
|
5763
|
+
config.password = 'YOUR PASSWORD'
|
5764
|
+
end
|
5765
|
+
|
5766
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5767
|
+
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | Payment processor authorization code object containing account_guid, member_guid, and user_guid.
|
5768
|
+
|
5769
|
+
begin
|
5770
|
+
# Request payment processor authorization code
|
5771
|
+
result = api_instance.request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
5772
|
+
p result
|
5773
|
+
rescue MxPlatformRuby::ApiError => e
|
5774
|
+
puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code: #{e}"
|
5775
|
+
end
|
5776
|
+
```
|
5777
|
+
|
5778
|
+
#### Using the request_payment_processor_authorization_code_with_http_info variant
|
5779
|
+
|
5780
|
+
This returns an Array which contains the response data, status code and headers.
|
5781
|
+
|
5782
|
+
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
5783
|
+
|
5784
|
+
```ruby
|
5785
|
+
begin
|
5786
|
+
# Request payment processor authorization code
|
5787
|
+
data, status_code, headers = api_instance.request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
5788
|
+
p status_code # => 2xx
|
5789
|
+
p headers # => { ... }
|
5790
|
+
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
|
5791
|
+
rescue MxPlatformRuby::ApiError => e
|
5792
|
+
puts "Error when calling MxPlatformApi->request_payment_processor_authorization_code_with_http_info: #{e}"
|
5793
|
+
end
|
5794
|
+
```
|
5795
|
+
|
5796
|
+
### Parameters
|
5797
|
+
|
5798
|
+
| Name | Type | Description | Notes |
|
5799
|
+
| ---- | ---- | ----------- | ----- |
|
5800
|
+
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | Payment processor authorization code object containing account_guid, member_guid, and user_guid. | |
|
5801
|
+
|
5802
|
+
### Return type
|
5803
|
+
|
5804
|
+
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
|
5805
|
+
|
5806
|
+
### Authorization
|
5807
|
+
|
5808
|
+
[basicAuth](../README.md#basicAuth)
|
5809
|
+
|
5810
|
+
### HTTP request headers
|
5811
|
+
|
5812
|
+
- **Content-Type**: application/json
|
5813
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
5814
|
+
|
5815
|
+
|
5816
|
+
## request_payment_processor_token
|
5817
|
+
|
5818
|
+
> <PaymentProcessorTokenResponseBody> request_payment_processor_token(opts)
|
5819
|
+
|
5820
|
+
Request payment processor token
|
5821
|
+
|
5822
|
+
Use this endpoint to request a payment processor token.
|
5823
|
+
|
5824
|
+
### Examples
|
5825
|
+
|
5826
|
+
```ruby
|
5827
|
+
require 'time'
|
5828
|
+
require 'mx-platform-ruby'
|
5829
|
+
# setup authorization
|
5830
|
+
MxPlatformRuby.configure do |config|
|
5831
|
+
# Configure HTTP basic authorization: basicAuth
|
5832
|
+
config.username = 'YOUR USERNAME'
|
5833
|
+
config.password = 'YOUR PASSWORD'
|
5834
|
+
end
|
5835
|
+
|
5836
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5837
|
+
opts = {
|
5838
|
+
code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request processor token.
|
5839
|
+
grant_type: 'authorization_code' # String | Specify grant type.
|
5840
|
+
}
|
5841
|
+
|
5842
|
+
begin
|
5843
|
+
# Request payment processor token
|
5844
|
+
result = api_instance.request_payment_processor_token(opts)
|
5845
|
+
p result
|
5846
|
+
rescue MxPlatformRuby::ApiError => e
|
5847
|
+
puts "Error when calling MxPlatformApi->request_payment_processor_token: #{e}"
|
5848
|
+
end
|
5849
|
+
```
|
5850
|
+
|
5851
|
+
#### Using the request_payment_processor_token_with_http_info variant
|
5852
|
+
|
5853
|
+
This returns an Array which contains the response data, status code and headers.
|
5854
|
+
|
5855
|
+
> <Array(<PaymentProcessorTokenResponseBody>, Integer, Hash)> request_payment_processor_token_with_http_info(opts)
|
5856
|
+
|
5857
|
+
```ruby
|
5858
|
+
begin
|
5859
|
+
# Request payment processor token
|
5860
|
+
data, status_code, headers = api_instance.request_payment_processor_token_with_http_info(opts)
|
5861
|
+
p status_code # => 2xx
|
5862
|
+
p headers # => { ... }
|
5863
|
+
p data # => <PaymentProcessorTokenResponseBody>
|
5864
|
+
rescue MxPlatformRuby::ApiError => e
|
5865
|
+
puts "Error when calling MxPlatformApi->request_payment_processor_token_with_http_info: #{e}"
|
5866
|
+
end
|
5867
|
+
```
|
5868
|
+
|
5869
|
+
### Parameters
|
5870
|
+
|
5871
|
+
| Name | Type | Description | Notes |
|
5872
|
+
| ---- | ---- | ----------- | ----- |
|
5873
|
+
| **code** | **String** | Code to request processor token. | [optional] |
|
5874
|
+
| **grant_type** | **String** | Specify grant type. | [optional] |
|
5875
|
+
|
5876
|
+
### Return type
|
5877
|
+
|
5878
|
+
[**PaymentProcessorTokenResponseBody**](PaymentProcessorTokenResponseBody.md)
|
5879
|
+
|
5880
|
+
### Authorization
|
5881
|
+
|
5882
|
+
[basicAuth](../README.md#basicAuth)
|
5883
|
+
|
5884
|
+
### HTTP request headers
|
5885
|
+
|
5886
|
+
- **Content-Type**: Not defined
|
5887
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
5888
|
+
|
5889
|
+
|
5673
5890
|
## request_widget_url
|
5674
5891
|
|
5675
5892
|
> <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)
|
@@ -5822,7 +6039,7 @@ end
|
|
5822
6039
|
|
5823
6040
|
## update_account_by_member
|
5824
6041
|
|
5825
|
-
> <AccountResponseBody> update_account_by_member(
|
6042
|
+
> <AccountResponseBody> update_account_by_member(account_guid, member_guid, user_guid, account_update_request_body)
|
5826
6043
|
|
5827
6044
|
Update account by member
|
5828
6045
|
|
@@ -5841,14 +6058,14 @@ MxPlatformRuby.configure do |config|
|
|
5841
6058
|
end
|
5842
6059
|
|
5843
6060
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5844
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5845
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5846
6061
|
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
6062
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6063
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5847
6064
|
account_update_request_body = MxPlatformRuby::AccountUpdateRequestBody.new # AccountUpdateRequestBody | Account object to be created with optional parameters (is_hidden)
|
5848
6065
|
|
5849
6066
|
begin
|
5850
6067
|
# Update account by member
|
5851
|
-
result = api_instance.update_account_by_member(
|
6068
|
+
result = api_instance.update_account_by_member(account_guid, member_guid, user_guid, account_update_request_body)
|
5852
6069
|
p result
|
5853
6070
|
rescue MxPlatformRuby::ApiError => e
|
5854
6071
|
puts "Error when calling MxPlatformApi->update_account_by_member: #{e}"
|
@@ -5859,12 +6076,12 @@ end
|
|
5859
6076
|
|
5860
6077
|
This returns an Array which contains the response data, status code and headers.
|
5861
6078
|
|
5862
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(
|
6079
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(account_guid, member_guid, user_guid, account_update_request_body)
|
5863
6080
|
|
5864
6081
|
```ruby
|
5865
6082
|
begin
|
5866
6083
|
# Update account by member
|
5867
|
-
data, status_code, headers = api_instance.update_account_by_member_with_http_info(
|
6084
|
+
data, status_code, headers = api_instance.update_account_by_member_with_http_info(account_guid, member_guid, user_guid, account_update_request_body)
|
5868
6085
|
p status_code # => 2xx
|
5869
6086
|
p headers # => { ... }
|
5870
6087
|
p data # => <AccountResponseBody>
|
@@ -5877,9 +6094,9 @@ end
|
|
5877
6094
|
|
5878
6095
|
| Name | Type | Description | Notes |
|
5879
6096
|
| ---- | ---- | ----------- | ----- |
|
5880
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5881
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5882
6097
|
| **account_guid** | **String** | The unique id for an `account`. | |
|
6098
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
6099
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
5883
6100
|
| **account_update_request_body** | [**AccountUpdateRequestBody**](AccountUpdateRequestBody.md) | Account object to be created with optional parameters (is_hidden) | |
|
5884
6101
|
|
5885
6102
|
### Return type
|
@@ -5972,7 +6189,7 @@ end
|
|
5972
6189
|
|
5973
6190
|
## update_managed_account
|
5974
6191
|
|
5975
|
-
> <AccountResponseBody> update_managed_account(member_guid, user_guid,
|
6192
|
+
> <AccountResponseBody> update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
5976
6193
|
|
5977
6194
|
Update managed account
|
5978
6195
|
|
@@ -5991,14 +6208,14 @@ MxPlatformRuby.configure do |config|
|
|
5991
6208
|
end
|
5992
6209
|
|
5993
6210
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6211
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5994
6212
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5995
6213
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5996
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5997
6214
|
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)
|
5998
6215
|
|
5999
6216
|
begin
|
6000
6217
|
# Update managed account
|
6001
|
-
result = api_instance.update_managed_account(member_guid, user_guid,
|
6218
|
+
result = api_instance.update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
6002
6219
|
p result
|
6003
6220
|
rescue MxPlatformRuby::ApiError => e
|
6004
6221
|
puts "Error when calling MxPlatformApi->update_managed_account: #{e}"
|
@@ -6009,12 +6226,12 @@ end
|
|
6009
6226
|
|
6010
6227
|
This returns an Array which contains the response data, status code and headers.
|
6011
6228
|
|
6012
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(member_guid, user_guid,
|
6229
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
6013
6230
|
|
6014
6231
|
```ruby
|
6015
6232
|
begin
|
6016
6233
|
# Update managed account
|
6017
|
-
data, status_code, headers = api_instance.update_managed_account_with_http_info(member_guid, user_guid,
|
6234
|
+
data, status_code, headers = api_instance.update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
6018
6235
|
p status_code # => 2xx
|
6019
6236
|
p headers # => { ... }
|
6020
6237
|
p data # => <AccountResponseBody>
|
@@ -6027,9 +6244,9 @@ end
|
|
6027
6244
|
|
6028
6245
|
| Name | Type | Description | Notes |
|
6029
6246
|
| ---- | ---- | ----------- | ----- |
|
6247
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
6030
6248
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
6031
6249
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
6032
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
6033
6250
|
| **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) | |
|
6034
6251
|
|
6035
6252
|
### Return type
|
@@ -6122,7 +6339,7 @@ end
|
|
6122
6339
|
|
6123
6340
|
## update_managed_transaction
|
6124
6341
|
|
6125
|
-
> <TransactionResponseBody> update_managed_transaction(
|
6342
|
+
> <TransactionResponseBody> update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6126
6343
|
|
6127
6344
|
Update managed transaction
|
6128
6345
|
|
@@ -6141,14 +6358,15 @@ MxPlatformRuby.configure do |config|
|
|
6141
6358
|
end
|
6142
6359
|
|
6143
6360
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6361
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
6144
6362
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6145
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6146
6363
|
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
6364
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6147
6365
|
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)
|
6148
6366
|
|
6149
6367
|
begin
|
6150
6368
|
# Update managed transaction
|
6151
|
-
result = api_instance.update_managed_transaction(
|
6369
|
+
result = api_instance.update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6152
6370
|
p result
|
6153
6371
|
rescue MxPlatformRuby::ApiError => e
|
6154
6372
|
puts "Error when calling MxPlatformApi->update_managed_transaction: #{e}"
|
@@ -6159,12 +6377,12 @@ end
|
|
6159
6377
|
|
6160
6378
|
This returns an Array which contains the response data, status code and headers.
|
6161
6379
|
|
6162
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(
|
6380
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
6163
6381
|
|
6164
6382
|
```ruby
|
6165
6383
|
begin
|
6166
6384
|
# Update managed transaction
|
6167
|
-
data, status_code, headers = api_instance.update_managed_transaction_with_http_info(
|
6385
|
+
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)
|
6168
6386
|
p status_code # => 2xx
|
6169
6387
|
p headers # => { ... }
|
6170
6388
|
p data # => <TransactionResponseBody>
|
@@ -6177,9 +6395,10 @@ end
|
|
6177
6395
|
|
6178
6396
|
| Name | Type | Description | Notes |
|
6179
6397
|
| ---- | ---- | ----------- | ----- |
|
6398
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
6180
6399
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
6181
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
6182
6400
|
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
6401
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
6183
6402
|
| **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) | |
|
6184
6403
|
|
6185
6404
|
### Return type
|