mx-platform-ruby 0.4.2 → 0.5.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.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +1 -1
  4. data/docs/AccountResponse.md +15 -1
  5. data/docs/ManagedAccountCreateRequest.md +78 -0
  6. data/docs/ManagedAccountCreateRequestBody.md +18 -0
  7. data/docs/ManagedAccountUpdateRequest.md +78 -0
  8. data/docs/ManagedAccountUpdateRequestBody.md +18 -0
  9. data/docs/ManagedMemberCreateRequest.md +24 -0
  10. data/docs/ManagedMemberCreateRequestBody.md +18 -0
  11. data/docs/ManagedMemberUpdateRequest.md +22 -0
  12. data/docs/ManagedMemberUpdateRequestBody.md +18 -0
  13. data/docs/ManagedTransactionCreateRequest.md +56 -0
  14. data/docs/ManagedTransactionCreateRequestBody.md +18 -0
  15. data/docs/ManagedTransactionUpdateRequest.md +56 -0
  16. data/docs/ManagedTransactionUpdateRequestBody.md +18 -0
  17. data/docs/MemberResponse.md +5 -1
  18. data/docs/MerchantLocationResponse.md +40 -0
  19. data/docs/MerchantLocationResponseBody.md +18 -0
  20. data/docs/MxPlatformApi.md +1397 -119
  21. data/docs/TransactionResponse.md +11 -1
  22. data/lib/mx-platform-ruby/api/mx_platform_api.rb +1379 -125
  23. data/lib/mx-platform-ruby/models/account_response.rb +67 -4
  24. data/lib/mx-platform-ruby/models/managed_account_create_request.rb +503 -0
  25. data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +218 -0
  26. data/lib/mx-platform-ruby/models/managed_account_update_request.rb +488 -0
  27. data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +218 -0
  28. data/lib/mx-platform-ruby/models/managed_member_create_request.rb +250 -0
  29. data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +218 -0
  30. data/lib/mx-platform-ruby/models/managed_member_update_request.rb +236 -0
  31. data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +218 -0
  32. data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +414 -0
  33. data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +218 -0
  34. data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +389 -0
  35. data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +218 -0
  36. data/lib/mx-platform-ruby/models/member_response.rb +22 -4
  37. data/lib/mx-platform-ruby/models/merchant_location_response.rb +317 -0
  38. data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +218 -0
  39. data/lib/mx-platform-ruby/models/transaction_response.rb +49 -4
  40. data/lib/mx-platform-ruby/version.rb +1 -1
  41. data/lib/mx-platform-ruby.rb +14 -0
  42. data/openapi/config.yml +1 -1
  43. data/spec/api/mx_platform_api_spec.rb +237 -0
  44. data/spec/models/account_response_spec.rb +42 -0
  45. data/spec/models/managed_account_create_request_body_spec.rb +34 -0
  46. data/spec/models/managed_account_create_request_spec.rb +214 -0
  47. data/spec/models/managed_account_update_request_body_spec.rb +34 -0
  48. data/spec/models/managed_account_update_request_spec.rb +214 -0
  49. data/spec/models/managed_member_create_request_body_spec.rb +34 -0
  50. data/spec/models/managed_member_create_request_spec.rb +52 -0
  51. data/spec/models/managed_member_update_request_body_spec.rb +34 -0
  52. data/spec/models/managed_member_update_request_spec.rb +46 -0
  53. data/spec/models/managed_transaction_create_request_body_spec.rb +34 -0
  54. data/spec/models/managed_transaction_create_request_spec.rb +148 -0
  55. data/spec/models/managed_transaction_update_request_body_spec.rb +34 -0
  56. data/spec/models/managed_transaction_update_request_spec.rb +148 -0
  57. data/spec/models/member_response_spec.rb +12 -0
  58. data/spec/models/merchant_location_response_body_spec.rb +34 -0
  59. data/spec/models/merchant_location_response_spec.rb +100 -0
  60. data/spec/models/transaction_response_spec.rb +30 -0
  61. metadata +136 -80
@@ -7,12 +7,18 @@ All URIs are relative to *https://api.mx.com*
7
7
  | [**aggregate_member**](MxPlatformApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member |
8
8
  | [**check_balances**](MxPlatformApi.md#check_balances) | **POST** /users/{user_guid}/members/{member_guid}/check_balance | Check balances |
9
9
  | [**create_category**](MxPlatformApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category |
10
+ | [**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
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 |
10
13
  | [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
11
14
  | [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
12
15
  | [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
13
16
  | [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
14
17
  | [**create_user**](MxPlatformApi.md#create_user) | **POST** /users | Create user |
15
18
  | [**delete_category**](MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category |
19
+ | [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
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 |
16
22
  | [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
17
23
  | [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
18
24
  | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
@@ -33,6 +39,10 @@ All URIs are relative to *https://api.mx.com*
33
39
  | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
34
40
  | [**list_institution_credentials**](MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials |
35
41
  | [**list_institutions**](MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions |
42
+ | [**list_managed_accounts**](MxPlatformApi.md#list_managed_accounts) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts | List managed accounts |
43
+ | [**list_managed_institutions**](MxPlatformApi.md#list_managed_institutions) | **GET** /managed_institutions | List managed institutions |
44
+ | [**list_managed_members**](MxPlatformApi.md#list_managed_members) | **GET** /users/{user_guid}/managed_members | List managed members |
45
+ | [**list_managed_transactions**](MxPlatformApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions | List managed transactions |
36
46
  | [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges |
37
47
  | [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
38
48
  | [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
@@ -51,9 +61,13 @@ All URIs are relative to *https://api.mx.com*
51
61
  | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
52
62
  | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
53
63
  | [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
64
+ | [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
65
+ | [**read_managed_member**](MxPlatformApi.md#read_managed_member) | **GET** /users/{user_guid}/managed_members/{member_guid} | Read managed member |
66
+ | [**read_managed_transaction**](MxPlatformApi.md#read_managed_transaction) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Read managed transaction |
54
67
  | [**read_member**](MxPlatformApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member |
55
68
  | [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
56
69
  | [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
70
+ | [**read_merchant_location**](MxPlatformApi.md#read_merchant_location) | **GET** /merchant_locations/{merchant_location_guid} | Read merchant location |
57
71
  | [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
58
72
  | [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
59
73
  | [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
@@ -66,6 +80,9 @@ All URIs are relative to *https://api.mx.com*
66
80
  | [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
67
81
  | [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
68
82
  | [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
83
+ | [**update_managed_account**](MxPlatformApi.md#update_managed_account) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Update managed account |
84
+ | [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
85
+ | [**update_managed_transaction**](MxPlatformApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Update managed transaction |
69
86
  | [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
70
87
  | [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
71
88
  | [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
@@ -291,6 +308,226 @@ end
291
308
  - **Accept**: application/vnd.mx.api.v1+json
292
309
 
293
310
 
311
+ ## create_managed_account
312
+
313
+ > <AccountResponseBody> create_managed_account(user_guid, member_guid, managed_account_create_request_body)
314
+
315
+ Create managed account
316
+
317
+ Use this endpoint to create a partner-managed account.
318
+
319
+ ### Examples
320
+
321
+ ```ruby
322
+ require 'time'
323
+ require 'mx-platform-ruby'
324
+ # setup authorization
325
+ MxPlatformRuby.configure do |config|
326
+ # Configure HTTP basic authorization: basicAuth
327
+ config.username = 'YOUR USERNAME'
328
+ config.password = 'YOUR PASSWORD'
329
+ end
330
+
331
+ api_instance = MxPlatformRuby::MxPlatformApi.new
332
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
333
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
334
+ managed_account_create_request_body = MxPlatformRuby::ManagedAccountCreateRequestBody.new # ManagedAccountCreateRequestBody | Managed account to be created.
335
+
336
+ begin
337
+ # Create managed account
338
+ result = api_instance.create_managed_account(user_guid, member_guid, managed_account_create_request_body)
339
+ p result
340
+ rescue MxPlatformRuby::ApiError => e
341
+ puts "Error when calling MxPlatformApi->create_managed_account: #{e}"
342
+ end
343
+ ```
344
+
345
+ #### Using the create_managed_account_with_http_info variant
346
+
347
+ This returns an Array which contains the response data, status code and headers.
348
+
349
+ > <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body)
350
+
351
+ ```ruby
352
+ begin
353
+ # Create managed account
354
+ data, status_code, headers = api_instance.create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body)
355
+ p status_code # => 2xx
356
+ p headers # => { ... }
357
+ p data # => <AccountResponseBody>
358
+ rescue MxPlatformRuby::ApiError => e
359
+ puts "Error when calling MxPlatformApi->create_managed_account_with_http_info: #{e}"
360
+ end
361
+ ```
362
+
363
+ ### Parameters
364
+
365
+ | Name | Type | Description | Notes |
366
+ | ---- | ---- | ----------- | ----- |
367
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
368
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
369
+ | **managed_account_create_request_body** | [**ManagedAccountCreateRequestBody**](ManagedAccountCreateRequestBody.md) | Managed account to be created. | |
370
+
371
+ ### Return type
372
+
373
+ [**AccountResponseBody**](AccountResponseBody.md)
374
+
375
+ ### Authorization
376
+
377
+ [basicAuth](../README.md#basicAuth)
378
+
379
+ ### HTTP request headers
380
+
381
+ - **Content-Type**: application/json
382
+ - **Accept**: application/vnd.mx.api.v1+json
383
+
384
+
385
+ ## create_managed_member
386
+
387
+ > <MemberResponseBody> create_managed_member(user_guid, managed_member_create_request_body)
388
+
389
+ Create managed member
390
+
391
+ Use this endpoint to create a new partner-managed `member`.
392
+
393
+ ### Examples
394
+
395
+ ```ruby
396
+ require 'time'
397
+ require 'mx-platform-ruby'
398
+ # setup authorization
399
+ MxPlatformRuby.configure do |config|
400
+ # Configure HTTP basic authorization: basicAuth
401
+ config.username = 'YOUR USERNAME'
402
+ config.password = 'YOUR PASSWORD'
403
+ end
404
+
405
+ api_instance = MxPlatformRuby::MxPlatformApi.new
406
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
407
+ managed_member_create_request_body = MxPlatformRuby::ManagedMemberCreateRequestBody.new # ManagedMemberCreateRequestBody | Managed member to be created.
408
+
409
+ begin
410
+ # Create managed member
411
+ result = api_instance.create_managed_member(user_guid, managed_member_create_request_body)
412
+ p result
413
+ rescue MxPlatformRuby::ApiError => e
414
+ puts "Error when calling MxPlatformApi->create_managed_member: #{e}"
415
+ end
416
+ ```
417
+
418
+ #### Using the create_managed_member_with_http_info variant
419
+
420
+ This returns an Array which contains the response data, status code and headers.
421
+
422
+ > <Array(<MemberResponseBody>, Integer, Hash)> create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
423
+
424
+ ```ruby
425
+ begin
426
+ # Create managed member
427
+ data, status_code, headers = api_instance.create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
428
+ p status_code # => 2xx
429
+ p headers # => { ... }
430
+ p data # => <MemberResponseBody>
431
+ rescue MxPlatformRuby::ApiError => e
432
+ puts "Error when calling MxPlatformApi->create_managed_member_with_http_info: #{e}"
433
+ end
434
+ ```
435
+
436
+ ### Parameters
437
+
438
+ | Name | Type | Description | Notes |
439
+ | ---- | ---- | ----------- | ----- |
440
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
441
+ | **managed_member_create_request_body** | [**ManagedMemberCreateRequestBody**](ManagedMemberCreateRequestBody.md) | Managed member to be created. | |
442
+
443
+ ### Return type
444
+
445
+ [**MemberResponseBody**](MemberResponseBody.md)
446
+
447
+ ### Authorization
448
+
449
+ [basicAuth](../README.md#basicAuth)
450
+
451
+ ### HTTP request headers
452
+
453
+ - **Content-Type**: application/json
454
+ - **Accept**: application/vnd.mx.api.v1+json
455
+
456
+
457
+ ## create_managed_transaction
458
+
459
+ > <TransactionResponseBody> create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body)
460
+
461
+ Create managed transaction
462
+
463
+ Use this endpoint to create a new partner-managed `transaction`.
464
+
465
+ ### Examples
466
+
467
+ ```ruby
468
+ require 'time'
469
+ require 'mx-platform-ruby'
470
+ # setup authorization
471
+ MxPlatformRuby.configure do |config|
472
+ # Configure HTTP basic authorization: basicAuth
473
+ config.username = 'YOUR USERNAME'
474
+ config.password = 'YOUR PASSWORD'
475
+ end
476
+
477
+ api_instance = MxPlatformRuby::MxPlatformApi.new
478
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
479
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
480
+ managed_transaction_create_request_body = MxPlatformRuby::ManagedTransactionCreateRequestBody.new # ManagedTransactionCreateRequestBody | Managed transaction to be created.
481
+
482
+ begin
483
+ # Create managed transaction
484
+ result = api_instance.create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body)
485
+ p result
486
+ rescue MxPlatformRuby::ApiError => e
487
+ puts "Error when calling MxPlatformApi->create_managed_transaction: #{e}"
488
+ end
489
+ ```
490
+
491
+ #### Using the create_managed_transaction_with_http_info variant
492
+
493
+ This returns an Array which contains the response data, status code and headers.
494
+
495
+ > <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body)
496
+
497
+ ```ruby
498
+ begin
499
+ # Create managed transaction
500
+ data, status_code, headers = api_instance.create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body)
501
+ p status_code # => 2xx
502
+ p headers # => { ... }
503
+ p data # => <TransactionResponseBody>
504
+ rescue MxPlatformRuby::ApiError => e
505
+ puts "Error when calling MxPlatformApi->create_managed_transaction_with_http_info: #{e}"
506
+ end
507
+ ```
508
+
509
+ ### Parameters
510
+
511
+ | Name | Type | Description | Notes |
512
+ | ---- | ---- | ----------- | ----- |
513
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
514
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
515
+ | **managed_transaction_create_request_body** | [**ManagedTransactionCreateRequestBody**](ManagedTransactionCreateRequestBody.md) | Managed transaction to be created. | |
516
+
517
+ ### Return type
518
+
519
+ [**TransactionResponseBody**](TransactionResponseBody.md)
520
+
521
+ ### Authorization
522
+
523
+ [basicAuth](../README.md#basicAuth)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: application/json
528
+ - **Accept**: application/vnd.mx.api.v1+json
529
+
530
+
294
531
  ## create_member
295
532
 
296
533
  > <MemberResponseBody> create_member(user_guid, member_create_request_body)
@@ -720,13 +957,13 @@ nil (empty response body)
720
957
  - **Accept**: application/vnd.mx.api.v1+json
721
958
 
722
959
 
723
- ## delete_member
960
+ ## delete_managed_account
724
961
 
725
- > delete_member(member_guid, user_guid)
962
+ > delete_managed_account(member_guid, user_guid, account_guid)
726
963
 
727
- Delete member
964
+ Delete managed account
728
965
 
729
- Accessing this endpoint will permanently delete a member.
966
+ Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
730
967
 
731
968
  ### Examples
732
969
 
@@ -743,30 +980,31 @@ end
743
980
  api_instance = MxPlatformRuby::MxPlatformApi.new
744
981
  member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
745
982
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
983
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
746
984
 
747
985
  begin
748
- # Delete member
749
- api_instance.delete_member(member_guid, user_guid)
986
+ # Delete managed account
987
+ api_instance.delete_managed_account(member_guid, user_guid, account_guid)
750
988
  rescue MxPlatformRuby::ApiError => e
751
- puts "Error when calling MxPlatformApi->delete_member: #{e}"
989
+ puts "Error when calling MxPlatformApi->delete_managed_account: #{e}"
752
990
  end
753
991
  ```
754
992
 
755
- #### Using the delete_member_with_http_info variant
993
+ #### Using the delete_managed_account_with_http_info variant
756
994
 
757
995
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
758
996
 
759
- > <Array(nil, Integer, Hash)> delete_member_with_http_info(member_guid, user_guid)
997
+ > <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(member_guid, user_guid, account_guid)
760
998
 
761
999
  ```ruby
762
1000
  begin
763
- # Delete member
764
- data, status_code, headers = api_instance.delete_member_with_http_info(member_guid, user_guid)
1001
+ # Delete managed account
1002
+ data, status_code, headers = api_instance.delete_managed_account_with_http_info(member_guid, user_guid, account_guid)
765
1003
  p status_code # => 2xx
766
1004
  p headers # => { ... }
767
1005
  p data # => nil
768
1006
  rescue MxPlatformRuby::ApiError => e
769
- puts "Error when calling MxPlatformApi->delete_member_with_http_info: #{e}"
1007
+ puts "Error when calling MxPlatformApi->delete_managed_account_with_http_info: #{e}"
770
1008
  end
771
1009
  ```
772
1010
 
@@ -776,6 +1014,7 @@ end
776
1014
  | ---- | ---- | ----------- | ----- |
777
1015
  | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
778
1016
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1017
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
779
1018
 
780
1019
  ### Return type
781
1020
 
@@ -791,13 +1030,13 @@ nil (empty response body)
791
1030
  - **Accept**: application/vnd.mx.api.v1+json
792
1031
 
793
1032
 
794
- ## delete_tag
1033
+ ## delete_managed_member
795
1034
 
796
- > delete_tag(tag_guid, user_guid)
1035
+ > delete_managed_member(member_guid, user_guid)
797
1036
 
798
- Delete tag
1037
+ Delete managed member
799
1038
 
800
- Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1039
+ Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
801
1040
 
802
1041
  ### Examples
803
1042
 
@@ -812,32 +1051,32 @@ MxPlatformRuby.configure do |config|
812
1051
  end
813
1052
 
814
1053
  api_instance = MxPlatformRuby::MxPlatformApi.new
815
- tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
1054
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
816
1055
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
817
1056
 
818
1057
  begin
819
- # Delete tag
820
- api_instance.delete_tag(tag_guid, user_guid)
1058
+ # Delete managed member
1059
+ api_instance.delete_managed_member(member_guid, user_guid)
821
1060
  rescue MxPlatformRuby::ApiError => e
822
- puts "Error when calling MxPlatformApi->delete_tag: #{e}"
1061
+ puts "Error when calling MxPlatformApi->delete_managed_member: #{e}"
823
1062
  end
824
1063
  ```
825
1064
 
826
- #### Using the delete_tag_with_http_info variant
1065
+ #### Using the delete_managed_member_with_http_info variant
827
1066
 
828
1067
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
829
1068
 
830
- > <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
1069
+ > <Array(nil, Integer, Hash)> delete_managed_member_with_http_info(member_guid, user_guid)
831
1070
 
832
1071
  ```ruby
833
1072
  begin
834
- # Delete tag
835
- data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
1073
+ # Delete managed member
1074
+ data, status_code, headers = api_instance.delete_managed_member_with_http_info(member_guid, user_guid)
836
1075
  p status_code # => 2xx
837
1076
  p headers # => { ... }
838
1077
  p data # => nil
839
1078
  rescue MxPlatformRuby::ApiError => e
840
- puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
1079
+ puts "Error when calling MxPlatformApi->delete_managed_member_with_http_info: #{e}"
841
1080
  end
842
1081
  ```
843
1082
 
@@ -845,7 +1084,7 @@ end
845
1084
 
846
1085
  | Name | Type | Description | Notes |
847
1086
  | ---- | ---- | ----------- | ----- |
848
- | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
1087
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
849
1088
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
850
1089
 
851
1090
  ### Return type
@@ -862,13 +1101,13 @@ nil (empty response body)
862
1101
  - **Accept**: application/vnd.mx.api.v1+json
863
1102
 
864
1103
 
865
- ## delete_tagging
1104
+ ## delete_managed_transaction
866
1105
 
867
- > delete_tagging(tagging_guid, user_guid)
1106
+ > delete_managed_transaction(member_guid, user_guid, transaction_guid)
868
1107
 
869
- Delete tagging
1108
+ Delete managed transaction
870
1109
 
871
- Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1110
+ Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
872
1111
 
873
1112
  ### Examples
874
1113
 
@@ -883,32 +1122,33 @@ MxPlatformRuby.configure do |config|
883
1122
  end
884
1123
 
885
1124
  api_instance = MxPlatformRuby::MxPlatformApi.new
886
- tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
1125
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
887
1126
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1127
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
888
1128
 
889
1129
  begin
890
- # Delete tagging
891
- api_instance.delete_tagging(tagging_guid, user_guid)
1130
+ # Delete managed transaction
1131
+ api_instance.delete_managed_transaction(member_guid, user_guid, transaction_guid)
892
1132
  rescue MxPlatformRuby::ApiError => e
893
- puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
1133
+ puts "Error when calling MxPlatformApi->delete_managed_transaction: #{e}"
894
1134
  end
895
1135
  ```
896
1136
 
897
- #### Using the delete_tagging_with_http_info variant
1137
+ #### Using the delete_managed_transaction_with_http_info variant
898
1138
 
899
1139
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
900
1140
 
901
- > <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
1141
+ > <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
902
1142
 
903
1143
  ```ruby
904
1144
  begin
905
- # Delete tagging
906
- data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
1145
+ # Delete managed transaction
1146
+ data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
907
1147
  p status_code # => 2xx
908
1148
  p headers # => { ... }
909
1149
  p data # => nil
910
1150
  rescue MxPlatformRuby::ApiError => e
911
- puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
1151
+ puts "Error when calling MxPlatformApi->delete_managed_transaction_with_http_info: #{e}"
912
1152
  end
913
1153
  ```
914
1154
 
@@ -916,8 +1156,9 @@ end
916
1156
 
917
1157
  | Name | Type | Description | Notes |
918
1158
  | ---- | ---- | ----------- | ----- |
919
- | **tagging_guid** | **String** | The unique id for a &#x60;tagging&#x60;. | |
1159
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
920
1160
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1161
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
921
1162
 
922
1163
  ### Return type
923
1164
 
@@ -933,13 +1174,13 @@ nil (empty response body)
933
1174
  - **Accept**: application/vnd.mx.api.v1+json
934
1175
 
935
1176
 
936
- ## delete_transaction_rule
1177
+ ## delete_member
937
1178
 
938
- > delete_transaction_rule(transaction_rule_guid, user_guid)
1179
+ > delete_member(member_guid, user_guid)
939
1180
 
940
- Delete transaction rule
1181
+ Delete member
941
1182
 
942
- Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1183
+ Accessing this endpoint will permanently delete a member.
943
1184
 
944
1185
  ### Examples
945
1186
 
@@ -954,32 +1195,32 @@ MxPlatformRuby.configure do |config|
954
1195
  end
955
1196
 
956
1197
  api_instance = MxPlatformRuby::MxPlatformApi.new
957
- transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
1198
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
958
1199
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
959
1200
 
960
1201
  begin
961
- # Delete transaction rule
962
- api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
1202
+ # Delete member
1203
+ api_instance.delete_member(member_guid, user_guid)
963
1204
  rescue MxPlatformRuby::ApiError => e
964
- puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
1205
+ puts "Error when calling MxPlatformApi->delete_member: #{e}"
965
1206
  end
966
1207
  ```
967
1208
 
968
- #### Using the delete_transaction_rule_with_http_info variant
1209
+ #### Using the delete_member_with_http_info variant
969
1210
 
970
1211
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
971
1212
 
972
- > <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1213
+ > <Array(nil, Integer, Hash)> delete_member_with_http_info(member_guid, user_guid)
973
1214
 
974
1215
  ```ruby
975
1216
  begin
976
- # Delete transaction rule
977
- data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1217
+ # Delete member
1218
+ data, status_code, headers = api_instance.delete_member_with_http_info(member_guid, user_guid)
978
1219
  p status_code # => 2xx
979
1220
  p headers # => { ... }
980
1221
  p data # => nil
981
1222
  rescue MxPlatformRuby::ApiError => e
982
- puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
1223
+ puts "Error when calling MxPlatformApi->delete_member_with_http_info: #{e}"
983
1224
  end
984
1225
  ```
985
1226
 
@@ -987,7 +1228,7 @@ end
987
1228
 
988
1229
  | Name | Type | Description | Notes |
989
1230
  | ---- | ---- | ----------- | ----- |
990
- | **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. | |
1231
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
991
1232
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
992
1233
 
993
1234
  ### Return type
@@ -1004,7 +1245,220 @@ nil (empty response body)
1004
1245
  - **Accept**: application/vnd.mx.api.v1+json
1005
1246
 
1006
1247
 
1007
- ## delete_user
1248
+ ## delete_tag
1249
+
1250
+ > delete_tag(tag_guid, user_guid)
1251
+
1252
+ Delete tag
1253
+
1254
+ Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1255
+
1256
+ ### Examples
1257
+
1258
+ ```ruby
1259
+ require 'time'
1260
+ require 'mx-platform-ruby'
1261
+ # setup authorization
1262
+ MxPlatformRuby.configure do |config|
1263
+ # Configure HTTP basic authorization: basicAuth
1264
+ config.username = 'YOUR USERNAME'
1265
+ config.password = 'YOUR PASSWORD'
1266
+ end
1267
+
1268
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1269
+ tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
1270
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1271
+
1272
+ begin
1273
+ # Delete tag
1274
+ api_instance.delete_tag(tag_guid, user_guid)
1275
+ rescue MxPlatformRuby::ApiError => e
1276
+ puts "Error when calling MxPlatformApi->delete_tag: #{e}"
1277
+ end
1278
+ ```
1279
+
1280
+ #### Using the delete_tag_with_http_info variant
1281
+
1282
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1283
+
1284
+ > <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
1285
+
1286
+ ```ruby
1287
+ begin
1288
+ # Delete tag
1289
+ data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
1290
+ p status_code # => 2xx
1291
+ p headers # => { ... }
1292
+ p data # => nil
1293
+ rescue MxPlatformRuby::ApiError => e
1294
+ puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
1295
+ end
1296
+ ```
1297
+
1298
+ ### Parameters
1299
+
1300
+ | Name | Type | Description | Notes |
1301
+ | ---- | ---- | ----------- | ----- |
1302
+ | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
1303
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1304
+
1305
+ ### Return type
1306
+
1307
+ nil (empty response body)
1308
+
1309
+ ### Authorization
1310
+
1311
+ [basicAuth](../README.md#basicAuth)
1312
+
1313
+ ### HTTP request headers
1314
+
1315
+ - **Content-Type**: Not defined
1316
+ - **Accept**: application/vnd.mx.api.v1+json
1317
+
1318
+
1319
+ ## delete_tagging
1320
+
1321
+ > delete_tagging(tagging_guid, user_guid)
1322
+
1323
+ Delete tagging
1324
+
1325
+ Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1326
+
1327
+ ### Examples
1328
+
1329
+ ```ruby
1330
+ require 'time'
1331
+ require 'mx-platform-ruby'
1332
+ # setup authorization
1333
+ MxPlatformRuby.configure do |config|
1334
+ # Configure HTTP basic authorization: basicAuth
1335
+ config.username = 'YOUR USERNAME'
1336
+ config.password = 'YOUR PASSWORD'
1337
+ end
1338
+
1339
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1340
+ tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
1341
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1342
+
1343
+ begin
1344
+ # Delete tagging
1345
+ api_instance.delete_tagging(tagging_guid, user_guid)
1346
+ rescue MxPlatformRuby::ApiError => e
1347
+ puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
1348
+ end
1349
+ ```
1350
+
1351
+ #### Using the delete_tagging_with_http_info variant
1352
+
1353
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1354
+
1355
+ > <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
1356
+
1357
+ ```ruby
1358
+ begin
1359
+ # Delete tagging
1360
+ data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
1361
+ p status_code # => 2xx
1362
+ p headers # => { ... }
1363
+ p data # => nil
1364
+ rescue MxPlatformRuby::ApiError => e
1365
+ puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
1366
+ end
1367
+ ```
1368
+
1369
+ ### Parameters
1370
+
1371
+ | Name | Type | Description | Notes |
1372
+ | ---- | ---- | ----------- | ----- |
1373
+ | **tagging_guid** | **String** | The unique id for a &#x60;tagging&#x60;. | |
1374
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1375
+
1376
+ ### Return type
1377
+
1378
+ nil (empty response body)
1379
+
1380
+ ### Authorization
1381
+
1382
+ [basicAuth](../README.md#basicAuth)
1383
+
1384
+ ### HTTP request headers
1385
+
1386
+ - **Content-Type**: Not defined
1387
+ - **Accept**: application/vnd.mx.api.v1+json
1388
+
1389
+
1390
+ ## delete_transaction_rule
1391
+
1392
+ > delete_transaction_rule(transaction_rule_guid, user_guid)
1393
+
1394
+ Delete transaction rule
1395
+
1396
+ Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1397
+
1398
+ ### Examples
1399
+
1400
+ ```ruby
1401
+ require 'time'
1402
+ require 'mx-platform-ruby'
1403
+ # setup authorization
1404
+ MxPlatformRuby.configure do |config|
1405
+ # Configure HTTP basic authorization: basicAuth
1406
+ config.username = 'YOUR USERNAME'
1407
+ config.password = 'YOUR PASSWORD'
1408
+ end
1409
+
1410
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1411
+ transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
1412
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1413
+
1414
+ begin
1415
+ # Delete transaction rule
1416
+ api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
1417
+ rescue MxPlatformRuby::ApiError => e
1418
+ puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
1419
+ end
1420
+ ```
1421
+
1422
+ #### Using the delete_transaction_rule_with_http_info variant
1423
+
1424
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1425
+
1426
+ > <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1427
+
1428
+ ```ruby
1429
+ begin
1430
+ # Delete transaction rule
1431
+ data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1432
+ p status_code # => 2xx
1433
+ p headers # => { ... }
1434
+ p data # => nil
1435
+ rescue MxPlatformRuby::ApiError => e
1436
+ puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
1437
+ end
1438
+ ```
1439
+
1440
+ ### Parameters
1441
+
1442
+ | Name | Type | Description | Notes |
1443
+ | ---- | ---- | ----------- | ----- |
1444
+ | **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. | |
1445
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1446
+
1447
+ ### Return type
1448
+
1449
+ nil (empty response body)
1450
+
1451
+ ### Authorization
1452
+
1453
+ [basicAuth](../README.md#basicAuth)
1454
+
1455
+ ### HTTP request headers
1456
+
1457
+ - **Content-Type**: Not defined
1458
+ - **Accept**: application/vnd.mx.api.v1+json
1459
+
1460
+
1461
+ ## delete_user
1008
1462
 
1009
1463
  > delete_user(user_guid)
1010
1464
 
@@ -2002,25 +2456,337 @@ begin
2002
2456
  result = api_instance.list_holdings_by_member(member_guid, user_guid, opts)
2003
2457
  p result
2004
2458
  rescue MxPlatformRuby::ApiError => e
2005
- puts "Error when calling MxPlatformApi->list_holdings_by_member: #{e}"
2459
+ puts "Error when calling MxPlatformApi->list_holdings_by_member: #{e}"
2460
+ end
2461
+ ```
2462
+
2463
+ #### Using the list_holdings_by_member_with_http_info variant
2464
+
2465
+ This returns an Array which contains the response data, status code and headers.
2466
+
2467
+ > <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
2468
+
2469
+ ```ruby
2470
+ begin
2471
+ # List holdings by member
2472
+ data, status_code, headers = api_instance.list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
2473
+ p status_code # => 2xx
2474
+ p headers # => { ... }
2475
+ p data # => <HoldingsResponseBody>
2476
+ rescue MxPlatformRuby::ApiError => e
2477
+ puts "Error when calling MxPlatformApi->list_holdings_by_member_with_http_info: #{e}"
2478
+ end
2479
+ ```
2480
+
2481
+ ### Parameters
2482
+
2483
+ | Name | Type | Description | Notes |
2484
+ | ---- | ---- | ----------- | ----- |
2485
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2486
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2487
+ | **from_date** | **String** | Filter holdings from this date. | [optional] |
2488
+ | **page** | **Integer** | Specify current page. | [optional] |
2489
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2490
+ | **to_date** | **String** | Filter holdings to this date. | [optional] |
2491
+
2492
+ ### Return type
2493
+
2494
+ [**HoldingsResponseBody**](HoldingsResponseBody.md)
2495
+
2496
+ ### Authorization
2497
+
2498
+ [basicAuth](../README.md#basicAuth)
2499
+
2500
+ ### HTTP request headers
2501
+
2502
+ - **Content-Type**: Not defined
2503
+ - **Accept**: application/vnd.mx.api.v1+json
2504
+
2505
+
2506
+ ## list_institution_credentials
2507
+
2508
+ > <CredentialsResponseBody> list_institution_credentials(institution_code, opts)
2509
+
2510
+ List institution credentials
2511
+
2512
+ Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2513
+
2514
+ ### Examples
2515
+
2516
+ ```ruby
2517
+ require 'time'
2518
+ require 'mx-platform-ruby'
2519
+ # setup authorization
2520
+ MxPlatformRuby.configure do |config|
2521
+ # Configure HTTP basic authorization: basicAuth
2522
+ config.username = 'YOUR USERNAME'
2523
+ config.password = 'YOUR PASSWORD'
2524
+ end
2525
+
2526
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2527
+ institution_code = 'chase' # String | The institution_code of the institution.
2528
+ opts = {
2529
+ page: 1, # Integer | Specify current page.
2530
+ records_per_page: 10 # Integer | Specify records per page.
2531
+ }
2532
+
2533
+ begin
2534
+ # List institution credentials
2535
+ result = api_instance.list_institution_credentials(institution_code, opts)
2536
+ p result
2537
+ rescue MxPlatformRuby::ApiError => e
2538
+ puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}"
2539
+ end
2540
+ ```
2541
+
2542
+ #### Using the list_institution_credentials_with_http_info variant
2543
+
2544
+ This returns an Array which contains the response data, status code and headers.
2545
+
2546
+ > <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts)
2547
+
2548
+ ```ruby
2549
+ begin
2550
+ # List institution credentials
2551
+ data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts)
2552
+ p status_code # => 2xx
2553
+ p headers # => { ... }
2554
+ p data # => <CredentialsResponseBody>
2555
+ rescue MxPlatformRuby::ApiError => e
2556
+ puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}"
2557
+ end
2558
+ ```
2559
+
2560
+ ### Parameters
2561
+
2562
+ | Name | Type | Description | Notes |
2563
+ | ---- | ---- | ----------- | ----- |
2564
+ | **institution_code** | **String** | The institution_code of the institution. | |
2565
+ | **page** | **Integer** | Specify current page. | [optional] |
2566
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2567
+
2568
+ ### Return type
2569
+
2570
+ [**CredentialsResponseBody**](CredentialsResponseBody.md)
2571
+
2572
+ ### Authorization
2573
+
2574
+ [basicAuth](../README.md#basicAuth)
2575
+
2576
+ ### HTTP request headers
2577
+
2578
+ - **Content-Type**: Not defined
2579
+ - **Accept**: application/vnd.mx.api.v1+json
2580
+
2581
+
2582
+ ## list_institutions
2583
+
2584
+ > <InstitutionsResponseBody> list_institutions(opts)
2585
+
2586
+ List institutions
2587
+
2588
+ This endpoint returns a list of institutions based on the specified search term or parameter.
2589
+
2590
+ ### Examples
2591
+
2592
+ ```ruby
2593
+ require 'time'
2594
+ require 'mx-platform-ruby'
2595
+ # setup authorization
2596
+ MxPlatformRuby.configure do |config|
2597
+ # Configure HTTP basic authorization: basicAuth
2598
+ config.username = 'YOUR USERNAME'
2599
+ config.password = 'YOUR PASSWORD'
2600
+ end
2601
+
2602
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2603
+ opts = {
2604
+ name: 'chase', # String | This will list only institutions in which the appended string appears.
2605
+ supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
2606
+ supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
2607
+ supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
2608
+ supports_transaction_history: true # Boolean | Filter only institutions which support extended transaction history.
2609
+ }
2610
+
2611
+ begin
2612
+ # List institutions
2613
+ result = api_instance.list_institutions(opts)
2614
+ p result
2615
+ rescue MxPlatformRuby::ApiError => e
2616
+ puts "Error when calling MxPlatformApi->list_institutions: #{e}"
2617
+ end
2618
+ ```
2619
+
2620
+ #### Using the list_institutions_with_http_info variant
2621
+
2622
+ This returns an Array which contains the response data, status code and headers.
2623
+
2624
+ > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_institutions_with_http_info(opts)
2625
+
2626
+ ```ruby
2627
+ begin
2628
+ # List institutions
2629
+ data, status_code, headers = api_instance.list_institutions_with_http_info(opts)
2630
+ p status_code # => 2xx
2631
+ p headers # => { ... }
2632
+ p data # => <InstitutionsResponseBody>
2633
+ rescue MxPlatformRuby::ApiError => e
2634
+ puts "Error when calling MxPlatformApi->list_institutions_with_http_info: #{e}"
2635
+ end
2636
+ ```
2637
+
2638
+ ### Parameters
2639
+
2640
+ | Name | Type | Description | Notes |
2641
+ | ---- | ---- | ----------- | ----- |
2642
+ | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
2643
+ | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
2644
+ | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
2645
+ | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
2646
+ | **supports_transaction_history** | **Boolean** | Filter only institutions which support extended transaction history. | [optional] |
2647
+
2648
+ ### Return type
2649
+
2650
+ [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2651
+
2652
+ ### Authorization
2653
+
2654
+ [basicAuth](../README.md#basicAuth)
2655
+
2656
+ ### HTTP request headers
2657
+
2658
+ - **Content-Type**: Not defined
2659
+ - **Accept**: application/vnd.mx.api.v1+json
2660
+
2661
+
2662
+ ## list_managed_accounts
2663
+
2664
+ > <AccountsResponseBody> list_managed_accounts(user_guid, member_guid, opts)
2665
+
2666
+ List managed accounts
2667
+
2668
+ Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
2669
+
2670
+ ### Examples
2671
+
2672
+ ```ruby
2673
+ require 'time'
2674
+ require 'mx-platform-ruby'
2675
+ # setup authorization
2676
+ MxPlatformRuby.configure do |config|
2677
+ # Configure HTTP basic authorization: basicAuth
2678
+ config.username = 'YOUR USERNAME'
2679
+ config.password = 'YOUR PASSWORD'
2680
+ end
2681
+
2682
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2683
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2684
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
2685
+ opts = {
2686
+ page: 1, # Integer | Specify current page.
2687
+ records_per_page: 10 # Integer | Specify records per page.
2688
+ }
2689
+
2690
+ begin
2691
+ # List managed accounts
2692
+ result = api_instance.list_managed_accounts(user_guid, member_guid, opts)
2693
+ p result
2694
+ rescue MxPlatformRuby::ApiError => e
2695
+ puts "Error when calling MxPlatformApi->list_managed_accounts: #{e}"
2696
+ end
2697
+ ```
2698
+
2699
+ #### Using the list_managed_accounts_with_http_info variant
2700
+
2701
+ This returns an Array which contains the response data, status code and headers.
2702
+
2703
+ > <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(user_guid, member_guid, opts)
2704
+
2705
+ ```ruby
2706
+ begin
2707
+ # List managed accounts
2708
+ data, status_code, headers = api_instance.list_managed_accounts_with_http_info(user_guid, member_guid, opts)
2709
+ p status_code # => 2xx
2710
+ p headers # => { ... }
2711
+ p data # => <AccountsResponseBody>
2712
+ rescue MxPlatformRuby::ApiError => e
2713
+ puts "Error when calling MxPlatformApi->list_managed_accounts_with_http_info: #{e}"
2714
+ end
2715
+ ```
2716
+
2717
+ ### Parameters
2718
+
2719
+ | Name | Type | Description | Notes |
2720
+ | ---- | ---- | ----------- | ----- |
2721
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2722
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2723
+ | **page** | **Integer** | Specify current page. | [optional] |
2724
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2725
+
2726
+ ### Return type
2727
+
2728
+ [**AccountsResponseBody**](AccountsResponseBody.md)
2729
+
2730
+ ### Authorization
2731
+
2732
+ [basicAuth](../README.md#basicAuth)
2733
+
2734
+ ### HTTP request headers
2735
+
2736
+ - **Content-Type**: Not defined
2737
+ - **Accept**: application/vnd.mx.api.v1+json
2738
+
2739
+
2740
+ ## list_managed_institutions
2741
+
2742
+ > <InstitutionsResponseBody> list_managed_institutions(opts)
2743
+
2744
+ List managed institutions
2745
+
2746
+ This endpoint returns a list of institutions which can be used to create partner-managed members.
2747
+
2748
+ ### Examples
2749
+
2750
+ ```ruby
2751
+ require 'time'
2752
+ require 'mx-platform-ruby'
2753
+ # setup authorization
2754
+ MxPlatformRuby.configure do |config|
2755
+ # Configure HTTP basic authorization: basicAuth
2756
+ config.username = 'YOUR USERNAME'
2757
+ config.password = 'YOUR PASSWORD'
2758
+ end
2759
+
2760
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2761
+ opts = {
2762
+ page: 1, # Integer | Specify current page.
2763
+ records_per_page: 10 # Integer | Specify records per page.
2764
+ }
2765
+
2766
+ begin
2767
+ # List managed institutions
2768
+ result = api_instance.list_managed_institutions(opts)
2769
+ p result
2770
+ rescue MxPlatformRuby::ApiError => e
2771
+ puts "Error when calling MxPlatformApi->list_managed_institutions: #{e}"
2006
2772
  end
2007
2773
  ```
2008
2774
 
2009
- #### Using the list_holdings_by_member_with_http_info variant
2775
+ #### Using the list_managed_institutions_with_http_info variant
2010
2776
 
2011
2777
  This returns an Array which contains the response data, status code and headers.
2012
2778
 
2013
- > <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
2779
+ > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_managed_institutions_with_http_info(opts)
2014
2780
 
2015
2781
  ```ruby
2016
2782
  begin
2017
- # List holdings by member
2018
- data, status_code, headers = api_instance.list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
2783
+ # List managed institutions
2784
+ data, status_code, headers = api_instance.list_managed_institutions_with_http_info(opts)
2019
2785
  p status_code # => 2xx
2020
2786
  p headers # => { ... }
2021
- p data # => <HoldingsResponseBody>
2787
+ p data # => <InstitutionsResponseBody>
2022
2788
  rescue MxPlatformRuby::ApiError => e
2023
- puts "Error when calling MxPlatformApi->list_holdings_by_member_with_http_info: #{e}"
2789
+ puts "Error when calling MxPlatformApi->list_managed_institutions_with_http_info: #{e}"
2024
2790
  end
2025
2791
  ```
2026
2792
 
@@ -2028,16 +2794,12 @@ end
2028
2794
 
2029
2795
  | Name | Type | Description | Notes |
2030
2796
  | ---- | ---- | ----------- | ----- |
2031
- | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2032
- | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2033
- | **from_date** | **String** | Filter holdings from this date. | [optional] |
2034
2797
  | **page** | **Integer** | Specify current page. | [optional] |
2035
2798
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2036
- | **to_date** | **String** | Filter holdings to this date. | [optional] |
2037
2799
 
2038
2800
  ### Return type
2039
2801
 
2040
- [**HoldingsResponseBody**](HoldingsResponseBody.md)
2802
+ [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2041
2803
 
2042
2804
  ### Authorization
2043
2805
 
@@ -2049,13 +2811,13 @@ end
2049
2811
  - **Accept**: application/vnd.mx.api.v1+json
2050
2812
 
2051
2813
 
2052
- ## list_institution_credentials
2814
+ ## list_managed_members
2053
2815
 
2054
- > <CredentialsResponseBody> list_institution_credentials(institution_code, opts)
2816
+ > <MembersResponseBody> list_managed_members(user_guid, opts)
2055
2817
 
2056
- List institution credentials
2818
+ List managed members
2057
2819
 
2058
- Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2820
+ This endpoint returns a list of all the partner-managed members associated with the specified `user`.
2059
2821
 
2060
2822
  ### Examples
2061
2823
 
@@ -2070,36 +2832,36 @@ MxPlatformRuby.configure do |config|
2070
2832
  end
2071
2833
 
2072
2834
  api_instance = MxPlatformRuby::MxPlatformApi.new
2073
- institution_code = 'chase' # String | The institution_code of the institution.
2835
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2074
2836
  opts = {
2075
2837
  page: 1, # Integer | Specify current page.
2076
2838
  records_per_page: 10 # Integer | Specify records per page.
2077
2839
  }
2078
2840
 
2079
2841
  begin
2080
- # List institution credentials
2081
- result = api_instance.list_institution_credentials(institution_code, opts)
2842
+ # List managed members
2843
+ result = api_instance.list_managed_members(user_guid, opts)
2082
2844
  p result
2083
2845
  rescue MxPlatformRuby::ApiError => e
2084
- puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}"
2846
+ puts "Error when calling MxPlatformApi->list_managed_members: #{e}"
2085
2847
  end
2086
2848
  ```
2087
2849
 
2088
- #### Using the list_institution_credentials_with_http_info variant
2850
+ #### Using the list_managed_members_with_http_info variant
2089
2851
 
2090
2852
  This returns an Array which contains the response data, status code and headers.
2091
2853
 
2092
- > <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts)
2854
+ > <Array(<MembersResponseBody>, Integer, Hash)> list_managed_members_with_http_info(user_guid, opts)
2093
2855
 
2094
2856
  ```ruby
2095
2857
  begin
2096
- # List institution credentials
2097
- data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts)
2858
+ # List managed members
2859
+ data, status_code, headers = api_instance.list_managed_members_with_http_info(user_guid, opts)
2098
2860
  p status_code # => 2xx
2099
2861
  p headers # => { ... }
2100
- p data # => <CredentialsResponseBody>
2862
+ p data # => <MembersResponseBody>
2101
2863
  rescue MxPlatformRuby::ApiError => e
2102
- puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}"
2864
+ puts "Error when calling MxPlatformApi->list_managed_members_with_http_info: #{e}"
2103
2865
  end
2104
2866
  ```
2105
2867
 
@@ -2107,13 +2869,13 @@ end
2107
2869
 
2108
2870
  | Name | Type | Description | Notes |
2109
2871
  | ---- | ---- | ----------- | ----- |
2110
- | **institution_code** | **String** | The institution_code of the institution. | |
2872
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2111
2873
  | **page** | **Integer** | Specify current page. | [optional] |
2112
2874
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2113
2875
 
2114
2876
  ### Return type
2115
2877
 
2116
- [**CredentialsResponseBody**](CredentialsResponseBody.md)
2878
+ [**MembersResponseBody**](MembersResponseBody.md)
2117
2879
 
2118
2880
  ### Authorization
2119
2881
 
@@ -2125,13 +2887,13 @@ end
2125
2887
  - **Accept**: application/vnd.mx.api.v1+json
2126
2888
 
2127
2889
 
2128
- ## list_institutions
2890
+ ## list_managed_transactions
2129
2891
 
2130
- > <InstitutionsResponseBody> list_institutions(opts)
2892
+ > <TransactionsResponseBody> list_managed_transactions(user_guid, member_guid, opts)
2131
2893
 
2132
- List institutions
2894
+ List managed transactions
2133
2895
 
2134
- This endpoint returns a list of institutions based on the specified search term or parameter.
2896
+ This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
2135
2897
 
2136
2898
  ### Examples
2137
2899
 
@@ -2146,38 +2908,37 @@ MxPlatformRuby.configure do |config|
2146
2908
  end
2147
2909
 
2148
2910
  api_instance = MxPlatformRuby::MxPlatformApi.new
2911
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2912
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
2149
2913
  opts = {
2150
- name: 'chase', # String | This will list only institutions in which the appended string appears.
2151
- supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
2152
- supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
2153
- supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
2154
- supports_transaction_history: true # Boolean | Filter only institutions which support extended transaction history.
2914
+ page: 1, # Integer | Specify current page.
2915
+ records_per_page: 10 # Integer | Specify records per page.
2155
2916
  }
2156
2917
 
2157
2918
  begin
2158
- # List institutions
2159
- result = api_instance.list_institutions(opts)
2919
+ # List managed transactions
2920
+ result = api_instance.list_managed_transactions(user_guid, member_guid, opts)
2160
2921
  p result
2161
2922
  rescue MxPlatformRuby::ApiError => e
2162
- puts "Error when calling MxPlatformApi->list_institutions: #{e}"
2923
+ puts "Error when calling MxPlatformApi->list_managed_transactions: #{e}"
2163
2924
  end
2164
2925
  ```
2165
2926
 
2166
- #### Using the list_institutions_with_http_info variant
2927
+ #### Using the list_managed_transactions_with_http_info variant
2167
2928
 
2168
2929
  This returns an Array which contains the response data, status code and headers.
2169
2930
 
2170
- > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_institutions_with_http_info(opts)
2931
+ > <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(user_guid, member_guid, opts)
2171
2932
 
2172
2933
  ```ruby
2173
2934
  begin
2174
- # List institutions
2175
- data, status_code, headers = api_instance.list_institutions_with_http_info(opts)
2935
+ # List managed transactions
2936
+ data, status_code, headers = api_instance.list_managed_transactions_with_http_info(user_guid, member_guid, opts)
2176
2937
  p status_code # => 2xx
2177
2938
  p headers # => { ... }
2178
- p data # => <InstitutionsResponseBody>
2939
+ p data # => <TransactionsResponseBody>
2179
2940
  rescue MxPlatformRuby::ApiError => e
2180
- puts "Error when calling MxPlatformApi->list_institutions_with_http_info: #{e}"
2941
+ puts "Error when calling MxPlatformApi->list_managed_transactions_with_http_info: #{e}"
2181
2942
  end
2182
2943
  ```
2183
2944
 
@@ -2185,15 +2946,14 @@ end
2185
2946
 
2186
2947
  | Name | Type | Description | Notes |
2187
2948
  | ---- | ---- | ----------- | ----- |
2188
- | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
2189
- | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
2190
- | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
2191
- | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
2192
- | **supports_transaction_history** | **Boolean** | Filter only institutions which support extended transaction history. | [optional] |
2949
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2950
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2951
+ | **page** | **Integer** | Specify current page. | [optional] |
2952
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2193
2953
 
2194
2954
  ### Return type
2195
2955
 
2196
- [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2956
+ [**TransactionsResponseBody**](TransactionsResponseBody.md)
2197
2957
 
2198
2958
  ### Authorization
2199
2959
 
@@ -3523,29 +4283,247 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
3523
4283
  institution_code = 'chase' # String | The institution_code of the institution.
3524
4284
 
3525
4285
  begin
3526
- # Read institution
3527
- result = api_instance.read_institution(institution_code)
4286
+ # Read institution
4287
+ result = api_instance.read_institution(institution_code)
4288
+ p result
4289
+ rescue MxPlatformRuby::ApiError => e
4290
+ puts "Error when calling MxPlatformApi->read_institution: #{e}"
4291
+ end
4292
+ ```
4293
+
4294
+ #### Using the read_institution_with_http_info variant
4295
+
4296
+ This returns an Array which contains the response data, status code and headers.
4297
+
4298
+ > <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
4299
+
4300
+ ```ruby
4301
+ begin
4302
+ # Read institution
4303
+ data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
4304
+ p status_code # => 2xx
4305
+ p headers # => { ... }
4306
+ p data # => <InstitutionResponseBody>
4307
+ rescue MxPlatformRuby::ApiError => e
4308
+ puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
4309
+ end
4310
+ ```
4311
+
4312
+ ### Parameters
4313
+
4314
+ | Name | Type | Description | Notes |
4315
+ | ---- | ---- | ----------- | ----- |
4316
+ | **institution_code** | **String** | The institution_code of the institution. | |
4317
+
4318
+ ### Return type
4319
+
4320
+ [**InstitutionResponseBody**](InstitutionResponseBody.md)
4321
+
4322
+ ### Authorization
4323
+
4324
+ [basicAuth](../README.md#basicAuth)
4325
+
4326
+ ### HTTP request headers
4327
+
4328
+ - **Content-Type**: Not defined
4329
+ - **Accept**: application/vnd.mx.api.v1+json
4330
+
4331
+
4332
+ ## read_managed_account
4333
+
4334
+ > <AccountResponseBody> read_managed_account(member_guid, user_guid, account_guid)
4335
+
4336
+ Read managed account
4337
+
4338
+ Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
4339
+
4340
+ ### Examples
4341
+
4342
+ ```ruby
4343
+ require 'time'
4344
+ require 'mx-platform-ruby'
4345
+ # setup authorization
4346
+ MxPlatformRuby.configure do |config|
4347
+ # Configure HTTP basic authorization: basicAuth
4348
+ config.username = 'YOUR USERNAME'
4349
+ config.password = 'YOUR PASSWORD'
4350
+ end
4351
+
4352
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4353
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4354
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4355
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
4356
+
4357
+ begin
4358
+ # Read managed account
4359
+ result = api_instance.read_managed_account(member_guid, user_guid, account_guid)
4360
+ p result
4361
+ rescue MxPlatformRuby::ApiError => e
4362
+ puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
4363
+ end
4364
+ ```
4365
+
4366
+ #### Using the read_managed_account_with_http_info variant
4367
+
4368
+ This returns an Array which contains the response data, status code and headers.
4369
+
4370
+ > <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(member_guid, user_guid, account_guid)
4371
+
4372
+ ```ruby
4373
+ begin
4374
+ # Read managed account
4375
+ data, status_code, headers = api_instance.read_managed_account_with_http_info(member_guid, user_guid, account_guid)
4376
+ p status_code # => 2xx
4377
+ p headers # => { ... }
4378
+ p data # => <AccountResponseBody>
4379
+ rescue MxPlatformRuby::ApiError => e
4380
+ puts "Error when calling MxPlatformApi->read_managed_account_with_http_info: #{e}"
4381
+ end
4382
+ ```
4383
+
4384
+ ### Parameters
4385
+
4386
+ | Name | Type | Description | Notes |
4387
+ | ---- | ---- | ----------- | ----- |
4388
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4389
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4390
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
4391
+
4392
+ ### Return type
4393
+
4394
+ [**AccountResponseBody**](AccountResponseBody.md)
4395
+
4396
+ ### Authorization
4397
+
4398
+ [basicAuth](../README.md#basicAuth)
4399
+
4400
+ ### HTTP request headers
4401
+
4402
+ - **Content-Type**: Not defined
4403
+ - **Accept**: application/vnd.mx.api.v1+json
4404
+
4405
+
4406
+ ## read_managed_member
4407
+
4408
+ > <MemberResponseBody> read_managed_member(member_guid, user_guid)
4409
+
4410
+ Read managed member
4411
+
4412
+ This endpoint returns the attributes of the specified partner-managed `member`.
4413
+
4414
+ ### Examples
4415
+
4416
+ ```ruby
4417
+ require 'time'
4418
+ require 'mx-platform-ruby'
4419
+ # setup authorization
4420
+ MxPlatformRuby.configure do |config|
4421
+ # Configure HTTP basic authorization: basicAuth
4422
+ config.username = 'YOUR USERNAME'
4423
+ config.password = 'YOUR PASSWORD'
4424
+ end
4425
+
4426
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4427
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4428
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4429
+
4430
+ begin
4431
+ # Read managed member
4432
+ result = api_instance.read_managed_member(member_guid, user_guid)
4433
+ p result
4434
+ rescue MxPlatformRuby::ApiError => e
4435
+ puts "Error when calling MxPlatformApi->read_managed_member: #{e}"
4436
+ end
4437
+ ```
4438
+
4439
+ #### Using the read_managed_member_with_http_info variant
4440
+
4441
+ This returns an Array which contains the response data, status code and headers.
4442
+
4443
+ > <Array(<MemberResponseBody>, Integer, Hash)> read_managed_member_with_http_info(member_guid, user_guid)
4444
+
4445
+ ```ruby
4446
+ begin
4447
+ # Read managed member
4448
+ data, status_code, headers = api_instance.read_managed_member_with_http_info(member_guid, user_guid)
4449
+ p status_code # => 2xx
4450
+ p headers # => { ... }
4451
+ p data # => <MemberResponseBody>
4452
+ rescue MxPlatformRuby::ApiError => e
4453
+ puts "Error when calling MxPlatformApi->read_managed_member_with_http_info: #{e}"
4454
+ end
4455
+ ```
4456
+
4457
+ ### Parameters
4458
+
4459
+ | Name | Type | Description | Notes |
4460
+ | ---- | ---- | ----------- | ----- |
4461
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4462
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4463
+
4464
+ ### Return type
4465
+
4466
+ [**MemberResponseBody**](MemberResponseBody.md)
4467
+
4468
+ ### Authorization
4469
+
4470
+ [basicAuth](../README.md#basicAuth)
4471
+
4472
+ ### HTTP request headers
4473
+
4474
+ - **Content-Type**: Not defined
4475
+ - **Accept**: application/vnd.mx.api.v1+json
4476
+
4477
+
4478
+ ## read_managed_transaction
4479
+
4480
+ > <TransactionResponseBody> read_managed_transaction(member_guid, user_guid, transaction_guid)
4481
+
4482
+ Read managed transaction
4483
+
4484
+ Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
4485
+
4486
+ ### Examples
4487
+
4488
+ ```ruby
4489
+ require 'time'
4490
+ require 'mx-platform-ruby'
4491
+ # setup authorization
4492
+ MxPlatformRuby.configure do |config|
4493
+ # Configure HTTP basic authorization: basicAuth
4494
+ config.username = 'YOUR USERNAME'
4495
+ config.password = 'YOUR PASSWORD'
4496
+ end
4497
+
4498
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4499
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4500
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4501
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
4502
+
4503
+ begin
4504
+ # Read managed transaction
4505
+ result = api_instance.read_managed_transaction(member_guid, user_guid, transaction_guid)
3528
4506
  p result
3529
4507
  rescue MxPlatformRuby::ApiError => e
3530
- puts "Error when calling MxPlatformApi->read_institution: #{e}"
4508
+ puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
3531
4509
  end
3532
4510
  ```
3533
4511
 
3534
- #### Using the read_institution_with_http_info variant
4512
+ #### Using the read_managed_transaction_with_http_info variant
3535
4513
 
3536
4514
  This returns an Array which contains the response data, status code and headers.
3537
4515
 
3538
- > <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
4516
+ > <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
3539
4517
 
3540
4518
  ```ruby
3541
4519
  begin
3542
- # Read institution
3543
- data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
4520
+ # Read managed transaction
4521
+ data, status_code, headers = api_instance.read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
3544
4522
  p status_code # => 2xx
3545
4523
  p headers # => { ... }
3546
- p data # => <InstitutionResponseBody>
4524
+ p data # => <TransactionResponseBody>
3547
4525
  rescue MxPlatformRuby::ApiError => e
3548
- puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
4526
+ puts "Error when calling MxPlatformApi->read_managed_transaction_with_http_info: #{e}"
3549
4527
  end
3550
4528
  ```
3551
4529
 
@@ -3553,11 +4531,13 @@ end
3553
4531
 
3554
4532
  | Name | Type | Description | Notes |
3555
4533
  | ---- | ---- | ----------- | ----- |
3556
- | **institution_code** | **String** | The institution_code of the institution. | |
4534
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4535
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4536
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
3557
4537
 
3558
4538
  ### Return type
3559
4539
 
3560
- [**InstitutionResponseBody**](InstitutionResponseBody.md)
4540
+ [**TransactionResponseBody**](TransactionResponseBody.md)
3561
4541
 
3562
4542
  ### Authorization
3563
4543
 
@@ -3783,6 +4763,76 @@ end
3783
4763
  - **Accept**: application/vnd.mx.api.v1+json
3784
4764
 
3785
4765
 
4766
+ ## read_merchant_location
4767
+
4768
+ > <MerchantLocationResponseBody> read_merchant_location(merchant_location_guid)
4769
+
4770
+ Read merchant location
4771
+
4772
+ This endpoint returns the specified merchant_location resource.
4773
+
4774
+ ### Examples
4775
+
4776
+ ```ruby
4777
+ require 'time'
4778
+ require 'mx-platform-ruby'
4779
+ # setup authorization
4780
+ MxPlatformRuby.configure do |config|
4781
+ # Configure HTTP basic authorization: basicAuth
4782
+ config.username = 'YOUR USERNAME'
4783
+ config.password = 'YOUR PASSWORD'
4784
+ end
4785
+
4786
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4787
+ merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # String | The unique id for a `merchant_location`.
4788
+
4789
+ begin
4790
+ # Read merchant location
4791
+ result = api_instance.read_merchant_location(merchant_location_guid)
4792
+ p result
4793
+ rescue MxPlatformRuby::ApiError => e
4794
+ puts "Error when calling MxPlatformApi->read_merchant_location: #{e}"
4795
+ end
4796
+ ```
4797
+
4798
+ #### Using the read_merchant_location_with_http_info variant
4799
+
4800
+ This returns an Array which contains the response data, status code and headers.
4801
+
4802
+ > <Array(<MerchantLocationResponseBody>, Integer, Hash)> read_merchant_location_with_http_info(merchant_location_guid)
4803
+
4804
+ ```ruby
4805
+ begin
4806
+ # Read merchant location
4807
+ data, status_code, headers = api_instance.read_merchant_location_with_http_info(merchant_location_guid)
4808
+ p status_code # => 2xx
4809
+ p headers # => { ... }
4810
+ p data # => <MerchantLocationResponseBody>
4811
+ rescue MxPlatformRuby::ApiError => e
4812
+ puts "Error when calling MxPlatformApi->read_merchant_location_with_http_info: #{e}"
4813
+ end
4814
+ ```
4815
+
4816
+ ### Parameters
4817
+
4818
+ | Name | Type | Description | Notes |
4819
+ | ---- | ---- | ----------- | ----- |
4820
+ | **merchant_location_guid** | **String** | The unique id for a &#x60;merchant_location&#x60;. | |
4821
+
4822
+ ### Return type
4823
+
4824
+ [**MerchantLocationResponseBody**](MerchantLocationResponseBody.md)
4825
+
4826
+ ### Authorization
4827
+
4828
+ [basicAuth](../README.md#basicAuth)
4829
+
4830
+ ### HTTP request headers
4831
+
4832
+ - **Content-Type**: Not defined
4833
+ - **Accept**: application/vnd.mx.api.v1+json
4834
+
4835
+
3786
4836
  ## read_statement_by_member
3787
4837
 
3788
4838
  > <StatementResponseBody> read_statement_by_member(member_guid, statement_guid, user_guid)
@@ -4314,7 +5364,8 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique i
4314
5364
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4315
5365
  opts = {
4316
5366
  referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
4317
- ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
5367
+ ui_message_webview_url_scheme: 'mx', # String | A scheme for routing the user back to the application state they were previously in.
5368
+ skip_aggregation: false # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
4318
5369
  }
4319
5370
 
4320
5371
  begin
@@ -4352,6 +5403,7 @@ end
4352
5403
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4353
5404
  | **referral_source** | **String** | Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;. | [optional] |
4354
5405
  | **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
5406
+ | **skip_aggregation** | **Boolean** | Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
4355
5407
 
4356
5408
  ### Return type
4357
5409
 
@@ -4667,6 +5719,232 @@ end
4667
5719
  - **Accept**: application/vnd.mx.api.v1+json
4668
5720
 
4669
5721
 
5722
+ ## update_managed_account
5723
+
5724
+ > <AccountResponseBody> update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body)
5725
+
5726
+ Update managed account
5727
+
5728
+ Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
5729
+
5730
+ ### Examples
5731
+
5732
+ ```ruby
5733
+ require 'time'
5734
+ require 'mx-platform-ruby'
5735
+ # setup authorization
5736
+ MxPlatformRuby.configure do |config|
5737
+ # Configure HTTP basic authorization: basicAuth
5738
+ config.username = 'YOUR USERNAME'
5739
+ config.password = 'YOUR PASSWORD'
5740
+ end
5741
+
5742
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5743
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5744
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5745
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
5746
+ 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)
5747
+
5748
+ begin
5749
+ # Update managed account
5750
+ result = api_instance.update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body)
5751
+ p result
5752
+ rescue MxPlatformRuby::ApiError => e
5753
+ puts "Error when calling MxPlatformApi->update_managed_account: #{e}"
5754
+ end
5755
+ ```
5756
+
5757
+ #### Using the update_managed_account_with_http_info variant
5758
+
5759
+ This returns an Array which contains the response data, status code and headers.
5760
+
5761
+ > <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body)
5762
+
5763
+ ```ruby
5764
+ begin
5765
+ # Update managed account
5766
+ data, status_code, headers = api_instance.update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body)
5767
+ p status_code # => 2xx
5768
+ p headers # => { ... }
5769
+ p data # => <AccountResponseBody>
5770
+ rescue MxPlatformRuby::ApiError => e
5771
+ puts "Error when calling MxPlatformApi->update_managed_account_with_http_info: #{e}"
5772
+ end
5773
+ ```
5774
+
5775
+ ### Parameters
5776
+
5777
+ | Name | Type | Description | Notes |
5778
+ | ---- | ---- | ----------- | ----- |
5779
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5780
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5781
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
5782
+ | **managed_account_update_request_body** | [**ManagedAccountUpdateRequestBody**](ManagedAccountUpdateRequestBody.md) | Managed account object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5783
+
5784
+ ### Return type
5785
+
5786
+ [**AccountResponseBody**](AccountResponseBody.md)
5787
+
5788
+ ### Authorization
5789
+
5790
+ [basicAuth](../README.md#basicAuth)
5791
+
5792
+ ### HTTP request headers
5793
+
5794
+ - **Content-Type**: application/json
5795
+ - **Accept**: application/vnd.mx.api.v1+json
5796
+
5797
+
5798
+ ## update_managed_member
5799
+
5800
+ > <MemberResponseBody> update_managed_member(member_guid, user_guid, managed_member_update_request_body)
5801
+
5802
+ Update managed member
5803
+
5804
+ Use this endpoint to update the attributes of the specified partner_managed `member`.
5805
+
5806
+ ### Examples
5807
+
5808
+ ```ruby
5809
+ require 'time'
5810
+ require 'mx-platform-ruby'
5811
+ # setup authorization
5812
+ MxPlatformRuby.configure do |config|
5813
+ # Configure HTTP basic authorization: basicAuth
5814
+ config.username = 'YOUR USERNAME'
5815
+ config.password = 'YOUR PASSWORD'
5816
+ end
5817
+
5818
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5819
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5820
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5821
+ managed_member_update_request_body = MxPlatformRuby::ManagedMemberUpdateRequestBody.new # ManagedMemberUpdateRequestBody | Managed member object to be updated (While no single parameter is required, the request body can't be empty)
5822
+
5823
+ begin
5824
+ # Update managed member
5825
+ result = api_instance.update_managed_member(member_guid, user_guid, managed_member_update_request_body)
5826
+ p result
5827
+ rescue MxPlatformRuby::ApiError => e
5828
+ puts "Error when calling MxPlatformApi->update_managed_member: #{e}"
5829
+ end
5830
+ ```
5831
+
5832
+ #### Using the update_managed_member_with_http_info variant
5833
+
5834
+ This returns an Array which contains the response data, status code and headers.
5835
+
5836
+ > <Array(<MemberResponseBody>, Integer, Hash)> update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
5837
+
5838
+ ```ruby
5839
+ begin
5840
+ # Update managed member
5841
+ data, status_code, headers = api_instance.update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
5842
+ p status_code # => 2xx
5843
+ p headers # => { ... }
5844
+ p data # => <MemberResponseBody>
5845
+ rescue MxPlatformRuby::ApiError => e
5846
+ puts "Error when calling MxPlatformApi->update_managed_member_with_http_info: #{e}"
5847
+ end
5848
+ ```
5849
+
5850
+ ### Parameters
5851
+
5852
+ | Name | Type | Description | Notes |
5853
+ | ---- | ---- | ----------- | ----- |
5854
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5855
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5856
+ | **managed_member_update_request_body** | [**ManagedMemberUpdateRequestBody**](ManagedMemberUpdateRequestBody.md) | Managed member object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5857
+
5858
+ ### Return type
5859
+
5860
+ [**MemberResponseBody**](MemberResponseBody.md)
5861
+
5862
+ ### Authorization
5863
+
5864
+ [basicAuth](../README.md#basicAuth)
5865
+
5866
+ ### HTTP request headers
5867
+
5868
+ - **Content-Type**: application/json
5869
+ - **Accept**: application/vnd.mx.api.v1+json
5870
+
5871
+
5872
+ ## update_managed_transaction
5873
+
5874
+ > <TransactionResponseBody> update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5875
+
5876
+ Update managed transaction
5877
+
5878
+ Use this endpoint to update the attributes of the specified partner_managed `transaction`.
5879
+
5880
+ ### Examples
5881
+
5882
+ ```ruby
5883
+ require 'time'
5884
+ require 'mx-platform-ruby'
5885
+ # setup authorization
5886
+ MxPlatformRuby.configure do |config|
5887
+ # Configure HTTP basic authorization: basicAuth
5888
+ config.username = 'YOUR USERNAME'
5889
+ config.password = 'YOUR PASSWORD'
5890
+ end
5891
+
5892
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5893
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5894
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5895
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
5896
+ 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)
5897
+
5898
+ begin
5899
+ # Update managed transaction
5900
+ result = api_instance.update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5901
+ p result
5902
+ rescue MxPlatformRuby::ApiError => e
5903
+ puts "Error when calling MxPlatformApi->update_managed_transaction: #{e}"
5904
+ end
5905
+ ```
5906
+
5907
+ #### Using the update_managed_transaction_with_http_info variant
5908
+
5909
+ This returns an Array which contains the response data, status code and headers.
5910
+
5911
+ > <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5912
+
5913
+ ```ruby
5914
+ begin
5915
+ # Update managed transaction
5916
+ data, status_code, headers = api_instance.update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5917
+ p status_code # => 2xx
5918
+ p headers # => { ... }
5919
+ p data # => <TransactionResponseBody>
5920
+ rescue MxPlatformRuby::ApiError => e
5921
+ puts "Error when calling MxPlatformApi->update_managed_transaction_with_http_info: #{e}"
5922
+ end
5923
+ ```
5924
+
5925
+ ### Parameters
5926
+
5927
+ | Name | Type | Description | Notes |
5928
+ | ---- | ---- | ----------- | ----- |
5929
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5930
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5931
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
5932
+ | **managed_transaction_update_request_body** | [**ManagedTransactionUpdateRequestBody**](ManagedTransactionUpdateRequestBody.md) | Managed transaction object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5933
+
5934
+ ### Return type
5935
+
5936
+ [**TransactionResponseBody**](TransactionResponseBody.md)
5937
+
5938
+ ### Authorization
5939
+
5940
+ [basicAuth](../README.md#basicAuth)
5941
+
5942
+ ### HTTP request headers
5943
+
5944
+ - **Content-Type**: application/json
5945
+ - **Accept**: application/vnd.mx.api.v1+json
5946
+
5947
+
4670
5948
  ## update_member
4671
5949
 
4672
5950
  > <MemberResponseBody> update_member(member_guid, user_guid, member_update_request_body)