mx-platform-ruby 0.23.0 → 0.24.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/MxPlatformApi.md +506 -1585
- data/docs/SpendingPlanApi.md +1086 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +6 -1060
- data/lib/mx-platform-ruby/api/spending_plan_api.rb +1076 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +1 -0
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +0 -204
- data/spec/api/spending_plan_api_spec.rb +239 -0
- metadata +5 -1
data/docs/MxPlatformApi.md
CHANGED
@@ -12,8 +12,6 @@ All URIs are relative to *https://api.mx.com*
|
|
12
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_manual_account**](MxPlatformApi.md#create_manual_account) | **POST** /users/{user_guid}/accounts | Create manual account |
|
14
14
|
| [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
|
15
|
-
| [**create_spending_plan**](MxPlatformApi.md#create_spending_plan) | **POST** /users/{user_guid}/spending_plans | Create spending plan |
|
16
|
-
| [**create_spending_plan_iteration_item**](MxPlatformApi.md#create_spending_plan_iteration_item) | **POST** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | Create spending plan iteration item |
|
17
15
|
| [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
|
18
16
|
| [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
|
19
17
|
| [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
|
@@ -24,9 +22,6 @@ All URIs are relative to *https://api.mx.com*
|
|
24
22
|
| [**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 |
|
25
23
|
| [**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account |
|
26
24
|
| [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
|
27
|
-
| [**delete_spending_plan**](MxPlatformApi.md#delete_spending_plan) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid} | Delete spending plan |
|
28
|
-
| [**delete_spending_plan_account**](MxPlatformApi.md#delete_spending_plan_account) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Delete spending plan account |
|
29
|
-
| [**delete_spending_plan_iteration_item**](MxPlatformApi.md#delete_spending_plan_iteration_item) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Delete spending plan iteration item |
|
30
25
|
| [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
|
31
26
|
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
|
32
27
|
| [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
|
@@ -60,10 +55,6 @@ All URIs are relative to *https://api.mx.com*
|
|
60
55
|
| [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
|
61
56
|
| [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
|
62
57
|
| [**list_merchants**](MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants |
|
63
|
-
| [**list_spending_plan_accounts**](MxPlatformApi.md#list_spending_plan_accounts) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts | List spending plan accounts |
|
64
|
-
| [**list_spending_plan_iteration_items**](MxPlatformApi.md#list_spending_plan_iteration_items) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | List spending plan iteration items |
|
65
|
-
| [**list_spending_plan_iterations**](MxPlatformApi.md#list_spending_plan_iterations) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations | List spending plan iterations |
|
66
|
-
| [**list_spending_plans**](MxPlatformApi.md#list_spending_plans) | **GET** /users/{user_guid}/spending_plans | List spending plans |
|
67
58
|
| [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
|
68
59
|
| [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
|
69
60
|
| [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags |
|
@@ -88,10 +79,6 @@ All URIs are relative to *https://api.mx.com*
|
|
88
79
|
| [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
|
89
80
|
| [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
|
90
81
|
| [**read_merchant_location**](MxPlatformApi.md#read_merchant_location) | **GET** /merchant_locations/{merchant_location_guid} | Read merchant location |
|
91
|
-
| [**read_spending_plan_account**](MxPlatformApi.md#read_spending_plan_account) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Read spending plan account |
|
92
|
-
| [**read_spending_plan_iteration**](MxPlatformApi.md#read_spending_plan_iteration) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} | Read a spending plan iteration |
|
93
|
-
| [**read_spending_plan_iteration_item**](MxPlatformApi.md#read_spending_plan_iteration_item) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Read a spending plan iteration item |
|
94
|
-
| [**read_spending_plan_user**](MxPlatformApi.md#read_spending_plan_user) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid} | Read a spending plan for a user |
|
95
82
|
| [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
|
96
83
|
| [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
|
97
84
|
| [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
|
@@ -110,7 +97,6 @@ All URIs are relative to *https://api.mx.com*
|
|
110
97
|
| [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
|
111
98
|
| [**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 |
|
112
99
|
| [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
|
113
|
-
| [**update_spending_plan_iteration_item**](MxPlatformApi.md#update_spending_plan_iteration_item) | **PUT** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Update a spending plan iteration item |
|
114
100
|
| [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
|
115
101
|
| [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
|
116
102
|
| [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction |
|
@@ -701,150 +687,6 @@ end
|
|
701
687
|
- **Accept**: application/vnd.mx.api.v1+json
|
702
688
|
|
703
689
|
|
704
|
-
## create_spending_plan
|
705
|
-
|
706
|
-
> <SpendingPlanResponse> create_spending_plan(user_guid)
|
707
|
-
|
708
|
-
Create spending plan
|
709
|
-
|
710
|
-
This endpoint creates a new `spending_plan` for the user.
|
711
|
-
|
712
|
-
### Examples
|
713
|
-
|
714
|
-
```ruby
|
715
|
-
require 'time'
|
716
|
-
require 'mx-platform-ruby'
|
717
|
-
# setup authorization
|
718
|
-
MxPlatformRuby.configure do |config|
|
719
|
-
# Configure HTTP basic authorization: basicAuth
|
720
|
-
config.username = 'YOUR USERNAME'
|
721
|
-
config.password = 'YOUR PASSWORD'
|
722
|
-
end
|
723
|
-
|
724
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
725
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
726
|
-
|
727
|
-
begin
|
728
|
-
# Create spending plan
|
729
|
-
result = api_instance.create_spending_plan(user_guid)
|
730
|
-
p result
|
731
|
-
rescue MxPlatformRuby::ApiError => e
|
732
|
-
puts "Error when calling MxPlatformApi->create_spending_plan: #{e}"
|
733
|
-
end
|
734
|
-
```
|
735
|
-
|
736
|
-
#### Using the create_spending_plan_with_http_info variant
|
737
|
-
|
738
|
-
This returns an Array which contains the response data, status code and headers.
|
739
|
-
|
740
|
-
> <Array(<SpendingPlanResponse>, Integer, Hash)> create_spending_plan_with_http_info(user_guid)
|
741
|
-
|
742
|
-
```ruby
|
743
|
-
begin
|
744
|
-
# Create spending plan
|
745
|
-
data, status_code, headers = api_instance.create_spending_plan_with_http_info(user_guid)
|
746
|
-
p status_code # => 2xx
|
747
|
-
p headers # => { ... }
|
748
|
-
p data # => <SpendingPlanResponse>
|
749
|
-
rescue MxPlatformRuby::ApiError => e
|
750
|
-
puts "Error when calling MxPlatformApi->create_spending_plan_with_http_info: #{e}"
|
751
|
-
end
|
752
|
-
```
|
753
|
-
|
754
|
-
### Parameters
|
755
|
-
|
756
|
-
| Name | Type | Description | Notes |
|
757
|
-
| ---- | ---- | ----------- | ----- |
|
758
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
759
|
-
|
760
|
-
### Return type
|
761
|
-
|
762
|
-
[**SpendingPlanResponse**](SpendingPlanResponse.md)
|
763
|
-
|
764
|
-
### Authorization
|
765
|
-
|
766
|
-
[basicAuth](../README.md#basicAuth)
|
767
|
-
|
768
|
-
### HTTP request headers
|
769
|
-
|
770
|
-
- **Content-Type**: Not defined
|
771
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
772
|
-
|
773
|
-
|
774
|
-
## create_spending_plan_iteration_item
|
775
|
-
|
776
|
-
> <SpendingPlanIterationItemResponse> create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
777
|
-
|
778
|
-
Create spending plan iteration item
|
779
|
-
|
780
|
-
This endpoint creates a new `spending_plan_iteration_item`.
|
781
|
-
|
782
|
-
### Examples
|
783
|
-
|
784
|
-
```ruby
|
785
|
-
require 'time'
|
786
|
-
require 'mx-platform-ruby'
|
787
|
-
# setup authorization
|
788
|
-
MxPlatformRuby.configure do |config|
|
789
|
-
# Configure HTTP basic authorization: basicAuth
|
790
|
-
config.username = 'YOUR USERNAME'
|
791
|
-
config.password = 'YOUR PASSWORD'
|
792
|
-
end
|
793
|
-
|
794
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
795
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
796
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
797
|
-
spending_plan_iteration_item_create_request_body = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new({planned_amount: 110}) # SpendingPlanIterationItemCreateRequestBody | Iteration item to be created with required parameters (planned_amount)
|
798
|
-
|
799
|
-
begin
|
800
|
-
# Create spending plan iteration item
|
801
|
-
result = api_instance.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
802
|
-
p result
|
803
|
-
rescue MxPlatformRuby::ApiError => e
|
804
|
-
puts "Error when calling MxPlatformApi->create_spending_plan_iteration_item: #{e}"
|
805
|
-
end
|
806
|
-
```
|
807
|
-
|
808
|
-
#### Using the create_spending_plan_iteration_item_with_http_info variant
|
809
|
-
|
810
|
-
This returns an Array which contains the response data, status code and headers.
|
811
|
-
|
812
|
-
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
813
|
-
|
814
|
-
```ruby
|
815
|
-
begin
|
816
|
-
# Create spending plan iteration item
|
817
|
-
data, status_code, headers = api_instance.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
818
|
-
p status_code # => 2xx
|
819
|
-
p headers # => { ... }
|
820
|
-
p data # => <SpendingPlanIterationItemResponse>
|
821
|
-
rescue MxPlatformRuby::ApiError => e
|
822
|
-
puts "Error when calling MxPlatformApi->create_spending_plan_iteration_item_with_http_info: #{e}"
|
823
|
-
end
|
824
|
-
```
|
825
|
-
|
826
|
-
### Parameters
|
827
|
-
|
828
|
-
| Name | Type | Description | Notes |
|
829
|
-
| ---- | ---- | ----------- | ----- |
|
830
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
831
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
832
|
-
| **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md) | Iteration item to be created with required parameters (planned_amount) | |
|
833
|
-
|
834
|
-
### Return type
|
835
|
-
|
836
|
-
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
837
|
-
|
838
|
-
### Authorization
|
839
|
-
|
840
|
-
[basicAuth](../README.md#basicAuth)
|
841
|
-
|
842
|
-
### HTTP request headers
|
843
|
-
|
844
|
-
- **Content-Type**: application/json
|
845
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
846
|
-
|
847
|
-
|
848
690
|
## create_tag
|
849
691
|
|
850
692
|
> <TagResponseBody> create_tag(user_guid, tag_create_request_body)
|
@@ -1563,13 +1405,13 @@ nil (empty response body)
|
|
1563
1405
|
- **Accept**: Not defined
|
1564
1406
|
|
1565
1407
|
|
1566
|
-
##
|
1408
|
+
## delete_tag
|
1567
1409
|
|
1568
|
-
>
|
1410
|
+
> delete_tag(tag_guid, user_guid)
|
1569
1411
|
|
1570
|
-
Delete
|
1412
|
+
Delete tag
|
1571
1413
|
|
1572
|
-
Use this endpoint to delete a
|
1414
|
+
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`.
|
1573
1415
|
|
1574
1416
|
### Examples
|
1575
1417
|
|
@@ -1584,32 +1426,32 @@ MxPlatformRuby.configure do |config|
|
|
1584
1426
|
end
|
1585
1427
|
|
1586
1428
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1587
|
-
|
1588
|
-
|
1429
|
+
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
1430
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1589
1431
|
|
1590
1432
|
begin
|
1591
|
-
# Delete
|
1592
|
-
api_instance.
|
1433
|
+
# Delete tag
|
1434
|
+
api_instance.delete_tag(tag_guid, user_guid)
|
1593
1435
|
rescue MxPlatformRuby::ApiError => e
|
1594
|
-
puts "Error when calling MxPlatformApi->
|
1436
|
+
puts "Error when calling MxPlatformApi->delete_tag: #{e}"
|
1595
1437
|
end
|
1596
1438
|
```
|
1597
1439
|
|
1598
|
-
#### Using the
|
1440
|
+
#### Using the delete_tag_with_http_info variant
|
1599
1441
|
|
1600
1442
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1601
1443
|
|
1602
|
-
> <Array(nil, Integer, Hash)>
|
1444
|
+
> <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
|
1603
1445
|
|
1604
1446
|
```ruby
|
1605
1447
|
begin
|
1606
|
-
# Delete
|
1607
|
-
data, status_code, headers = api_instance.
|
1448
|
+
# Delete tag
|
1449
|
+
data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
|
1608
1450
|
p status_code # => 2xx
|
1609
1451
|
p headers # => { ... }
|
1610
1452
|
p data # => nil
|
1611
1453
|
rescue MxPlatformRuby::ApiError => e
|
1612
|
-
puts "Error when calling MxPlatformApi->
|
1454
|
+
puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
|
1613
1455
|
end
|
1614
1456
|
```
|
1615
1457
|
|
@@ -1617,8 +1459,8 @@ end
|
|
1617
1459
|
|
1618
1460
|
| Name | Type | Description | Notes |
|
1619
1461
|
| ---- | ---- | ----------- | ----- |
|
1620
|
-
| **
|
1621
|
-
| **
|
1462
|
+
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
1463
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1622
1464
|
|
1623
1465
|
### Return type
|
1624
1466
|
|
@@ -1634,13 +1476,13 @@ nil (empty response body)
|
|
1634
1476
|
- **Accept**: Not defined
|
1635
1477
|
|
1636
1478
|
|
1637
|
-
##
|
1479
|
+
## delete_tagging
|
1638
1480
|
|
1639
|
-
>
|
1481
|
+
> delete_tagging(tagging_guid, user_guid)
|
1640
1482
|
|
1641
|
-
Delete
|
1483
|
+
Delete tagging
|
1642
1484
|
|
1643
|
-
Use this endpoint to delete a
|
1485
|
+
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.
|
1644
1486
|
|
1645
1487
|
### Examples
|
1646
1488
|
|
@@ -1655,33 +1497,32 @@ MxPlatformRuby.configure do |config|
|
|
1655
1497
|
end
|
1656
1498
|
|
1657
1499
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1658
|
-
|
1659
|
-
|
1660
|
-
spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # String | The unique ID for the specified account.
|
1500
|
+
tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
|
1501
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1661
1502
|
|
1662
1503
|
begin
|
1663
|
-
# Delete
|
1664
|
-
api_instance.
|
1504
|
+
# Delete tagging
|
1505
|
+
api_instance.delete_tagging(tagging_guid, user_guid)
|
1665
1506
|
rescue MxPlatformRuby::ApiError => e
|
1666
|
-
puts "Error when calling MxPlatformApi->
|
1507
|
+
puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
|
1667
1508
|
end
|
1668
1509
|
```
|
1669
1510
|
|
1670
|
-
#### Using the
|
1511
|
+
#### Using the delete_tagging_with_http_info variant
|
1671
1512
|
|
1672
1513
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1673
1514
|
|
1674
|
-
> <Array(nil, Integer, Hash)>
|
1515
|
+
> <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
|
1675
1516
|
|
1676
1517
|
```ruby
|
1677
1518
|
begin
|
1678
|
-
# Delete
|
1679
|
-
data, status_code, headers = api_instance.
|
1519
|
+
# Delete tagging
|
1520
|
+
data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
|
1680
1521
|
p status_code # => 2xx
|
1681
1522
|
p headers # => { ... }
|
1682
1523
|
p data # => nil
|
1683
1524
|
rescue MxPlatformRuby::ApiError => e
|
1684
|
-
puts "Error when calling MxPlatformApi->
|
1525
|
+
puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
|
1685
1526
|
end
|
1686
1527
|
```
|
1687
1528
|
|
@@ -1689,9 +1530,8 @@ end
|
|
1689
1530
|
|
1690
1531
|
| Name | Type | Description | Notes |
|
1691
1532
|
| ---- | ---- | ----------- | ----- |
|
1692
|
-
| **
|
1693
|
-
| **
|
1694
|
-
| **spending_plan_account_guid** | **String** | The unique ID for the specified account. | |
|
1533
|
+
| **tagging_guid** | **String** | The unique id for a `tagging`. | |
|
1534
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1695
1535
|
|
1696
1536
|
### Return type
|
1697
1537
|
|
@@ -1707,13 +1547,13 @@ nil (empty response body)
|
|
1707
1547
|
- **Accept**: Not defined
|
1708
1548
|
|
1709
1549
|
|
1710
|
-
##
|
1550
|
+
## delete_transaction_rule
|
1711
1551
|
|
1712
|
-
>
|
1552
|
+
> delete_transaction_rule(transaction_rule_guid, user_guid)
|
1713
1553
|
|
1714
|
-
Delete
|
1554
|
+
Delete transaction rule
|
1715
1555
|
|
1716
|
-
Use this endpoint to delete a
|
1556
|
+
Use this endpoint to permanently delete a transaction rule based on its unique GUID.
|
1717
1557
|
|
1718
1558
|
### Examples
|
1719
1559
|
|
@@ -1728,33 +1568,32 @@ MxPlatformRuby.configure do |config|
|
|
1728
1568
|
end
|
1729
1569
|
|
1730
1570
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1731
|
-
|
1732
|
-
|
1733
|
-
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
1571
|
+
transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
|
1572
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1734
1573
|
|
1735
1574
|
begin
|
1736
|
-
# Delete
|
1737
|
-
api_instance.
|
1575
|
+
# Delete transaction rule
|
1576
|
+
api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
|
1738
1577
|
rescue MxPlatformRuby::ApiError => e
|
1739
|
-
puts "Error when calling MxPlatformApi->
|
1578
|
+
puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
|
1740
1579
|
end
|
1741
1580
|
```
|
1742
1581
|
|
1743
|
-
#### Using the
|
1582
|
+
#### Using the delete_transaction_rule_with_http_info variant
|
1744
1583
|
|
1745
1584
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1746
1585
|
|
1747
|
-
> <Array(nil, Integer, Hash)>
|
1586
|
+
> <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
|
1748
1587
|
|
1749
1588
|
```ruby
|
1750
1589
|
begin
|
1751
|
-
# Delete
|
1752
|
-
data, status_code, headers = api_instance.
|
1590
|
+
# Delete transaction rule
|
1591
|
+
data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
|
1753
1592
|
p status_code # => 2xx
|
1754
1593
|
p headers # => { ... }
|
1755
1594
|
p data # => nil
|
1756
1595
|
rescue MxPlatformRuby::ApiError => e
|
1757
|
-
puts "Error when calling MxPlatformApi->
|
1596
|
+
puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
|
1758
1597
|
end
|
1759
1598
|
```
|
1760
1599
|
|
@@ -1762,9 +1601,8 @@ end
|
|
1762
1601
|
|
1763
1602
|
| Name | Type | Description | Notes |
|
1764
1603
|
| ---- | ---- | ----------- | ----- |
|
1765
|
-
| **
|
1766
|
-
| **
|
1767
|
-
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
1604
|
+
| **transaction_rule_guid** | **String** | The unique id for a `transaction_rule`. | |
|
1605
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1768
1606
|
|
1769
1607
|
### Return type
|
1770
1608
|
|
@@ -1780,13 +1618,13 @@ nil (empty response body)
|
|
1780
1618
|
- **Accept**: Not defined
|
1781
1619
|
|
1782
1620
|
|
1783
|
-
##
|
1621
|
+
## delete_user
|
1784
1622
|
|
1785
|
-
>
|
1623
|
+
> delete_user(user_guid)
|
1786
1624
|
|
1787
|
-
Delete
|
1625
|
+
Delete user
|
1788
1626
|
|
1789
|
-
Use this endpoint to
|
1627
|
+
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
|
1790
1628
|
|
1791
1629
|
### Examples
|
1792
1630
|
|
@@ -1801,32 +1639,31 @@ MxPlatformRuby.configure do |config|
|
|
1801
1639
|
end
|
1802
1640
|
|
1803
1641
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1804
|
-
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
1805
1642
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1806
1643
|
|
1807
1644
|
begin
|
1808
|
-
# Delete
|
1809
|
-
api_instance.
|
1645
|
+
# Delete user
|
1646
|
+
api_instance.delete_user(user_guid)
|
1810
1647
|
rescue MxPlatformRuby::ApiError => e
|
1811
|
-
puts "Error when calling MxPlatformApi->
|
1648
|
+
puts "Error when calling MxPlatformApi->delete_user: #{e}"
|
1812
1649
|
end
|
1813
1650
|
```
|
1814
1651
|
|
1815
|
-
#### Using the
|
1652
|
+
#### Using the delete_user_with_http_info variant
|
1816
1653
|
|
1817
1654
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1818
1655
|
|
1819
|
-
> <Array(nil, Integer, Hash)>
|
1656
|
+
> <Array(nil, Integer, Hash)> delete_user_with_http_info(user_guid)
|
1820
1657
|
|
1821
1658
|
```ruby
|
1822
1659
|
begin
|
1823
|
-
# Delete
|
1824
|
-
data, status_code, headers = api_instance.
|
1660
|
+
# Delete user
|
1661
|
+
data, status_code, headers = api_instance.delete_user_with_http_info(user_guid)
|
1825
1662
|
p status_code # => 2xx
|
1826
1663
|
p headers # => { ... }
|
1827
1664
|
p data # => nil
|
1828
1665
|
rescue MxPlatformRuby::ApiError => e
|
1829
|
-
puts "Error when calling MxPlatformApi->
|
1666
|
+
puts "Error when calling MxPlatformApi->delete_user_with_http_info: #{e}"
|
1830
1667
|
end
|
1831
1668
|
```
|
1832
1669
|
|
@@ -1834,7 +1671,6 @@ end
|
|
1834
1671
|
|
1835
1672
|
| Name | Type | Description | Notes |
|
1836
1673
|
| ---- | ---- | ----------- | ----- |
|
1837
|
-
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
1838
1674
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
1839
1675
|
|
1840
1676
|
### Return type
|
@@ -1851,13 +1687,13 @@ nil (empty response body)
|
|
1851
1687
|
- **Accept**: Not defined
|
1852
1688
|
|
1853
1689
|
|
1854
|
-
##
|
1690
|
+
## deprecated_request_payment_processor_authorization_code
|
1855
1691
|
|
1856
|
-
>
|
1692
|
+
> <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
1857
1693
|
|
1858
|
-
|
1694
|
+
(Deprecated) Request an authorization code.
|
1859
1695
|
|
1860
|
-
|
1696
|
+
(This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
|
1861
1697
|
|
1862
1698
|
### Examples
|
1863
1699
|
|
@@ -1872,32 +1708,32 @@ MxPlatformRuby.configure do |config|
|
|
1872
1708
|
end
|
1873
1709
|
|
1874
1710
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1875
|
-
|
1876
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1711
|
+
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
|
1877
1712
|
|
1878
1713
|
begin
|
1879
|
-
#
|
1880
|
-
api_instance.
|
1714
|
+
# (Deprecated) Request an authorization code.
|
1715
|
+
result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
1716
|
+
p result
|
1881
1717
|
rescue MxPlatformRuby::ApiError => e
|
1882
|
-
puts "Error when calling MxPlatformApi->
|
1718
|
+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
|
1883
1719
|
end
|
1884
1720
|
```
|
1885
1721
|
|
1886
|
-
#### Using the
|
1722
|
+
#### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
|
1887
1723
|
|
1888
|
-
This returns an Array which contains the response data
|
1724
|
+
This returns an Array which contains the response data, status code and headers.
|
1889
1725
|
|
1890
|
-
> <Array(
|
1726
|
+
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
1891
1727
|
|
1892
1728
|
```ruby
|
1893
1729
|
begin
|
1894
|
-
#
|
1895
|
-
data, status_code, headers = api_instance.
|
1730
|
+
# (Deprecated) Request an authorization code.
|
1731
|
+
data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
1896
1732
|
p status_code # => 2xx
|
1897
1733
|
p headers # => { ... }
|
1898
|
-
p data # =>
|
1734
|
+
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
|
1899
1735
|
rescue MxPlatformRuby::ApiError => e
|
1900
|
-
puts "Error when calling MxPlatformApi->
|
1736
|
+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
|
1901
1737
|
end
|
1902
1738
|
```
|
1903
1739
|
|
@@ -1905,12 +1741,11 @@ end
|
|
1905
1741
|
|
1906
1742
|
| Name | Type | Description | Notes |
|
1907
1743
|
| ---- | ---- | ----------- | ----- |
|
1908
|
-
| **
|
1909
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
1744
|
+
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
|
1910
1745
|
|
1911
1746
|
### Return type
|
1912
1747
|
|
1913
|
-
|
1748
|
+
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
|
1914
1749
|
|
1915
1750
|
### Authorization
|
1916
1751
|
|
@@ -1918,17 +1753,17 @@ nil (empty response body)
|
|
1918
1753
|
|
1919
1754
|
### HTTP request headers
|
1920
1755
|
|
1921
|
-
- **Content-Type**:
|
1922
|
-
- **Accept**:
|
1756
|
+
- **Content-Type**: application/json
|
1757
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
1923
1758
|
|
1924
1759
|
|
1925
|
-
##
|
1760
|
+
## download_statement_pdf
|
1926
1761
|
|
1927
|
-
>
|
1762
|
+
> File download_statement_pdf(member_guid, statement_guid, user_guid)
|
1928
1763
|
|
1929
|
-
|
1764
|
+
Download statement pdf
|
1930
1765
|
|
1931
|
-
Use this endpoint to
|
1766
|
+
Use this endpoint to download a specified statement PDF.
|
1932
1767
|
|
1933
1768
|
### Examples
|
1934
1769
|
|
@@ -1943,239 +1778,29 @@ MxPlatformRuby.configure do |config|
|
|
1943
1778
|
end
|
1944
1779
|
|
1945
1780
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1946
|
-
|
1781
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
1782
|
+
statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for a `statement`.
|
1947
1783
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1948
1784
|
|
1949
1785
|
begin
|
1950
|
-
#
|
1951
|
-
api_instance.
|
1786
|
+
# Download statement pdf
|
1787
|
+
result = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid)
|
1788
|
+
p result
|
1952
1789
|
rescue MxPlatformRuby::ApiError => e
|
1953
|
-
puts "Error when calling MxPlatformApi->
|
1790
|
+
puts "Error when calling MxPlatformApi->download_statement_pdf: #{e}"
|
1954
1791
|
end
|
1955
1792
|
```
|
1956
1793
|
|
1957
|
-
#### Using the
|
1794
|
+
#### Using the download_statement_pdf_with_http_info variant
|
1958
1795
|
|
1959
|
-
This returns an Array which contains the response data
|
1796
|
+
This returns an Array which contains the response data, status code and headers.
|
1960
1797
|
|
1961
|
-
> <Array(
|
1798
|
+
> <Array(File, Integer, Hash)> download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid)
|
1962
1799
|
|
1963
1800
|
```ruby
|
1964
1801
|
begin
|
1965
|
-
#
|
1966
|
-
data, status_code, headers = api_instance.
|
1967
|
-
p status_code # => 2xx
|
1968
|
-
p headers # => { ... }
|
1969
|
-
p data # => nil
|
1970
|
-
rescue MxPlatformRuby::ApiError => e
|
1971
|
-
puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
|
1972
|
-
end
|
1973
|
-
```
|
1974
|
-
|
1975
|
-
### Parameters
|
1976
|
-
|
1977
|
-
| Name | Type | Description | Notes |
|
1978
|
-
| ---- | ---- | ----------- | ----- |
|
1979
|
-
| **transaction_rule_guid** | **String** | The unique id for a `transaction_rule`. | |
|
1980
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
1981
|
-
|
1982
|
-
### Return type
|
1983
|
-
|
1984
|
-
nil (empty response body)
|
1985
|
-
|
1986
|
-
### Authorization
|
1987
|
-
|
1988
|
-
[basicAuth](../README.md#basicAuth)
|
1989
|
-
|
1990
|
-
### HTTP request headers
|
1991
|
-
|
1992
|
-
- **Content-Type**: Not defined
|
1993
|
-
- **Accept**: Not defined
|
1994
|
-
|
1995
|
-
|
1996
|
-
## delete_user
|
1997
|
-
|
1998
|
-
> delete_user(user_guid)
|
1999
|
-
|
2000
|
-
Delete user
|
2001
|
-
|
2002
|
-
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
|
2003
|
-
|
2004
|
-
### Examples
|
2005
|
-
|
2006
|
-
```ruby
|
2007
|
-
require 'time'
|
2008
|
-
require 'mx-platform-ruby'
|
2009
|
-
# setup authorization
|
2010
|
-
MxPlatformRuby.configure do |config|
|
2011
|
-
# Configure HTTP basic authorization: basicAuth
|
2012
|
-
config.username = 'YOUR USERNAME'
|
2013
|
-
config.password = 'YOUR PASSWORD'
|
2014
|
-
end
|
2015
|
-
|
2016
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2017
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2018
|
-
|
2019
|
-
begin
|
2020
|
-
# Delete user
|
2021
|
-
api_instance.delete_user(user_guid)
|
2022
|
-
rescue MxPlatformRuby::ApiError => e
|
2023
|
-
puts "Error when calling MxPlatformApi->delete_user: #{e}"
|
2024
|
-
end
|
2025
|
-
```
|
2026
|
-
|
2027
|
-
#### Using the delete_user_with_http_info variant
|
2028
|
-
|
2029
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2030
|
-
|
2031
|
-
> <Array(nil, Integer, Hash)> delete_user_with_http_info(user_guid)
|
2032
|
-
|
2033
|
-
```ruby
|
2034
|
-
begin
|
2035
|
-
# Delete user
|
2036
|
-
data, status_code, headers = api_instance.delete_user_with_http_info(user_guid)
|
2037
|
-
p status_code # => 2xx
|
2038
|
-
p headers # => { ... }
|
2039
|
-
p data # => nil
|
2040
|
-
rescue MxPlatformRuby::ApiError => e
|
2041
|
-
puts "Error when calling MxPlatformApi->delete_user_with_http_info: #{e}"
|
2042
|
-
end
|
2043
|
-
```
|
2044
|
-
|
2045
|
-
### Parameters
|
2046
|
-
|
2047
|
-
| Name | Type | Description | Notes |
|
2048
|
-
| ---- | ---- | ----------- | ----- |
|
2049
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
2050
|
-
|
2051
|
-
### Return type
|
2052
|
-
|
2053
|
-
nil (empty response body)
|
2054
|
-
|
2055
|
-
### Authorization
|
2056
|
-
|
2057
|
-
[basicAuth](../README.md#basicAuth)
|
2058
|
-
|
2059
|
-
### HTTP request headers
|
2060
|
-
|
2061
|
-
- **Content-Type**: Not defined
|
2062
|
-
- **Accept**: Not defined
|
2063
|
-
|
2064
|
-
|
2065
|
-
## deprecated_request_payment_processor_authorization_code
|
2066
|
-
|
2067
|
-
> <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
2068
|
-
|
2069
|
-
(Deprecated) Request an authorization code.
|
2070
|
-
|
2071
|
-
(This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
|
2072
|
-
|
2073
|
-
### Examples
|
2074
|
-
|
2075
|
-
```ruby
|
2076
|
-
require 'time'
|
2077
|
-
require 'mx-platform-ruby'
|
2078
|
-
# setup authorization
|
2079
|
-
MxPlatformRuby.configure do |config|
|
2080
|
-
# Configure HTTP basic authorization: basicAuth
|
2081
|
-
config.username = 'YOUR USERNAME'
|
2082
|
-
config.password = 'YOUR PASSWORD'
|
2083
|
-
end
|
2084
|
-
|
2085
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2086
|
-
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
|
2087
|
-
|
2088
|
-
begin
|
2089
|
-
# (Deprecated) Request an authorization code.
|
2090
|
-
result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
2091
|
-
p result
|
2092
|
-
rescue MxPlatformRuby::ApiError => e
|
2093
|
-
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
|
2094
|
-
end
|
2095
|
-
```
|
2096
|
-
|
2097
|
-
#### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
|
2098
|
-
|
2099
|
-
This returns an Array which contains the response data, status code and headers.
|
2100
|
-
|
2101
|
-
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
2102
|
-
|
2103
|
-
```ruby
|
2104
|
-
begin
|
2105
|
-
# (Deprecated) Request an authorization code.
|
2106
|
-
data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
2107
|
-
p status_code # => 2xx
|
2108
|
-
p headers # => { ... }
|
2109
|
-
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
|
2110
|
-
rescue MxPlatformRuby::ApiError => e
|
2111
|
-
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
|
2112
|
-
end
|
2113
|
-
```
|
2114
|
-
|
2115
|
-
### Parameters
|
2116
|
-
|
2117
|
-
| Name | Type | Description | Notes |
|
2118
|
-
| ---- | ---- | ----------- | ----- |
|
2119
|
-
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
|
2120
|
-
|
2121
|
-
### Return type
|
2122
|
-
|
2123
|
-
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
|
2124
|
-
|
2125
|
-
### Authorization
|
2126
|
-
|
2127
|
-
[basicAuth](../README.md#basicAuth)
|
2128
|
-
|
2129
|
-
### HTTP request headers
|
2130
|
-
|
2131
|
-
- **Content-Type**: application/json
|
2132
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
2133
|
-
|
2134
|
-
|
2135
|
-
## download_statement_pdf
|
2136
|
-
|
2137
|
-
> File download_statement_pdf(member_guid, statement_guid, user_guid)
|
2138
|
-
|
2139
|
-
Download statement pdf
|
2140
|
-
|
2141
|
-
Use this endpoint to download a specified statement PDF.
|
2142
|
-
|
2143
|
-
### Examples
|
2144
|
-
|
2145
|
-
```ruby
|
2146
|
-
require 'time'
|
2147
|
-
require 'mx-platform-ruby'
|
2148
|
-
# setup authorization
|
2149
|
-
MxPlatformRuby.configure do |config|
|
2150
|
-
# Configure HTTP basic authorization: basicAuth
|
2151
|
-
config.username = 'YOUR USERNAME'
|
2152
|
-
config.password = 'YOUR PASSWORD'
|
2153
|
-
end
|
2154
|
-
|
2155
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2156
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
2157
|
-
statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for a `statement`.
|
2158
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2159
|
-
|
2160
|
-
begin
|
2161
|
-
# Download statement pdf
|
2162
|
-
result = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid)
|
2163
|
-
p result
|
2164
|
-
rescue MxPlatformRuby::ApiError => e
|
2165
|
-
puts "Error when calling MxPlatformApi->download_statement_pdf: #{e}"
|
2166
|
-
end
|
2167
|
-
```
|
2168
|
-
|
2169
|
-
#### Using the download_statement_pdf_with_http_info variant
|
2170
|
-
|
2171
|
-
This returns an Array which contains the response data, status code and headers.
|
2172
|
-
|
2173
|
-
> <Array(File, Integer, Hash)> download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid)
|
2174
|
-
|
2175
|
-
```ruby
|
2176
|
-
begin
|
2177
|
-
# Download statement pdf
|
2178
|
-
data, status_code, headers = api_instance.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid)
|
1802
|
+
# Download statement pdf
|
1803
|
+
data, status_code, headers = api_instance.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid)
|
2179
1804
|
p status_code # => 2xx
|
2180
1805
|
p headers # => { ... }
|
2181
1806
|
p data # => File
|
@@ -4270,13 +3895,13 @@ end
|
|
4270
3895
|
- **Accept**: application/vnd.mx.api.v1+json
|
4271
3896
|
|
4272
3897
|
|
4273
|
-
##
|
3898
|
+
## list_statements_by_member
|
4274
3899
|
|
4275
|
-
> <
|
3900
|
+
> <StatementsResponseBody> list_statements_by_member(member_guid, user_guid, opts)
|
4276
3901
|
|
4277
|
-
List
|
3902
|
+
List statements by member
|
4278
3903
|
|
4279
|
-
Use this endpoint to
|
3904
|
+
Use this endpoint to get an array of available statements.
|
4280
3905
|
|
4281
3906
|
### Examples
|
4282
3907
|
|
@@ -4291,37 +3916,37 @@ MxPlatformRuby.configure do |config|
|
|
4291
3916
|
end
|
4292
3917
|
|
4293
3918
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3919
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4294
3920
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4295
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
4296
3921
|
opts = {
|
4297
3922
|
page: 1, # Integer | Specify current page.
|
4298
3923
|
records_per_page: 10 # Integer | Specify records per page.
|
4299
3924
|
}
|
4300
3925
|
|
4301
3926
|
begin
|
4302
|
-
# List
|
4303
|
-
result = api_instance.
|
3927
|
+
# List statements by member
|
3928
|
+
result = api_instance.list_statements_by_member(member_guid, user_guid, opts)
|
4304
3929
|
p result
|
4305
3930
|
rescue MxPlatformRuby::ApiError => e
|
4306
|
-
puts "Error when calling MxPlatformApi->
|
3931
|
+
puts "Error when calling MxPlatformApi->list_statements_by_member: #{e}"
|
4307
3932
|
end
|
4308
3933
|
```
|
4309
3934
|
|
4310
|
-
#### Using the
|
3935
|
+
#### Using the list_statements_by_member_with_http_info variant
|
4311
3936
|
|
4312
3937
|
This returns an Array which contains the response data, status code and headers.
|
4313
3938
|
|
4314
|
-
> <Array(<
|
3939
|
+
> <Array(<StatementsResponseBody>, Integer, Hash)> list_statements_by_member_with_http_info(member_guid, user_guid, opts)
|
4315
3940
|
|
4316
3941
|
```ruby
|
4317
3942
|
begin
|
4318
|
-
# List
|
4319
|
-
data, status_code, headers = api_instance.
|
3943
|
+
# List statements by member
|
3944
|
+
data, status_code, headers = api_instance.list_statements_by_member_with_http_info(member_guid, user_guid, opts)
|
4320
3945
|
p status_code # => 2xx
|
4321
3946
|
p headers # => { ... }
|
4322
|
-
p data # => <
|
3947
|
+
p data # => <StatementsResponseBody>
|
4323
3948
|
rescue MxPlatformRuby::ApiError => e
|
4324
|
-
puts "Error when calling MxPlatformApi->
|
3949
|
+
puts "Error when calling MxPlatformApi->list_statements_by_member_with_http_info: #{e}"
|
4325
3950
|
end
|
4326
3951
|
```
|
4327
3952
|
|
@@ -4329,14 +3954,14 @@ end
|
|
4329
3954
|
|
4330
3955
|
| Name | Type | Description | Notes |
|
4331
3956
|
| ---- | ---- | ----------- | ----- |
|
3957
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
4332
3958
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4333
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
4334
3959
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4335
3960
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4336
3961
|
|
4337
3962
|
### Return type
|
4338
3963
|
|
4339
|
-
[**
|
3964
|
+
[**StatementsResponseBody**](StatementsResponseBody.md)
|
4340
3965
|
|
4341
3966
|
### Authorization
|
4342
3967
|
|
@@ -4348,13 +3973,13 @@ end
|
|
4348
3973
|
- **Accept**: application/vnd.mx.api.v1+json
|
4349
3974
|
|
4350
3975
|
|
4351
|
-
##
|
3976
|
+
## list_taggings
|
4352
3977
|
|
4353
|
-
> <
|
3978
|
+
> <TaggingsResponseBody> list_taggings(user_guid, opts)
|
4354
3979
|
|
4355
|
-
List
|
3980
|
+
List taggings
|
4356
3981
|
|
4357
|
-
Use this endpoint to list all the
|
3982
|
+
Use this endpoint to retrieve a list of all the taggings associated with a specific user.
|
4358
3983
|
|
4359
3984
|
### Examples
|
4360
3985
|
|
@@ -4370,36 +3995,35 @@ end
|
|
4370
3995
|
|
4371
3996
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4372
3997
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4373
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
4374
3998
|
opts = {
|
4375
3999
|
page: 1, # Integer | Specify current page.
|
4376
4000
|
records_per_page: 10 # Integer | Specify records per page.
|
4377
4001
|
}
|
4378
4002
|
|
4379
4003
|
begin
|
4380
|
-
# List
|
4381
|
-
result = api_instance.
|
4004
|
+
# List taggings
|
4005
|
+
result = api_instance.list_taggings(user_guid, opts)
|
4382
4006
|
p result
|
4383
4007
|
rescue MxPlatformRuby::ApiError => e
|
4384
|
-
puts "Error when calling MxPlatformApi->
|
4008
|
+
puts "Error when calling MxPlatformApi->list_taggings: #{e}"
|
4385
4009
|
end
|
4386
4010
|
```
|
4387
4011
|
|
4388
|
-
#### Using the
|
4012
|
+
#### Using the list_taggings_with_http_info variant
|
4389
4013
|
|
4390
4014
|
This returns an Array which contains the response data, status code and headers.
|
4391
4015
|
|
4392
|
-
> <Array(<
|
4016
|
+
> <Array(<TaggingsResponseBody>, Integer, Hash)> list_taggings_with_http_info(user_guid, opts)
|
4393
4017
|
|
4394
4018
|
```ruby
|
4395
4019
|
begin
|
4396
|
-
# List
|
4397
|
-
data, status_code, headers = api_instance.
|
4020
|
+
# List taggings
|
4021
|
+
data, status_code, headers = api_instance.list_taggings_with_http_info(user_guid, opts)
|
4398
4022
|
p status_code # => 2xx
|
4399
4023
|
p headers # => { ... }
|
4400
|
-
p data # => <
|
4024
|
+
p data # => <TaggingsResponseBody>
|
4401
4025
|
rescue MxPlatformRuby::ApiError => e
|
4402
|
-
puts "Error when calling MxPlatformApi->
|
4026
|
+
puts "Error when calling MxPlatformApi->list_taggings_with_http_info: #{e}"
|
4403
4027
|
end
|
4404
4028
|
```
|
4405
4029
|
|
@@ -4408,13 +4032,12 @@ end
|
|
4408
4032
|
| Name | Type | Description | Notes |
|
4409
4033
|
| ---- | ---- | ----------- | ----- |
|
4410
4034
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4411
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
4412
4035
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4413
4036
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4414
4037
|
|
4415
4038
|
### Return type
|
4416
4039
|
|
4417
|
-
[**
|
4040
|
+
[**TaggingsResponseBody**](TaggingsResponseBody.md)
|
4418
4041
|
|
4419
4042
|
### Authorization
|
4420
4043
|
|
@@ -4426,13 +4049,13 @@ end
|
|
4426
4049
|
- **Accept**: application/vnd.mx.api.v1+json
|
4427
4050
|
|
4428
4051
|
|
4429
|
-
##
|
4052
|
+
## list_tags
|
4430
4053
|
|
4431
|
-
> <
|
4054
|
+
> <TagsResponseBody> list_tags(user_guid, opts)
|
4432
4055
|
|
4433
|
-
List
|
4056
|
+
List tags
|
4434
4057
|
|
4435
|
-
Use this endpoint to list all the
|
4058
|
+
Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.
|
4436
4059
|
|
4437
4060
|
### Examples
|
4438
4061
|
|
@@ -4448,36 +4071,35 @@ end
|
|
4448
4071
|
|
4449
4072
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4450
4073
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4451
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
4452
4074
|
opts = {
|
4453
4075
|
page: 1, # Integer | Specify current page.
|
4454
4076
|
records_per_page: 10 # Integer | Specify records per page.
|
4455
4077
|
}
|
4456
4078
|
|
4457
4079
|
begin
|
4458
|
-
# List
|
4459
|
-
result = api_instance.
|
4080
|
+
# List tags
|
4081
|
+
result = api_instance.list_tags(user_guid, opts)
|
4460
4082
|
p result
|
4461
4083
|
rescue MxPlatformRuby::ApiError => e
|
4462
|
-
puts "Error when calling MxPlatformApi->
|
4084
|
+
puts "Error when calling MxPlatformApi->list_tags: #{e}"
|
4463
4085
|
end
|
4464
4086
|
```
|
4465
4087
|
|
4466
|
-
#### Using the
|
4088
|
+
#### Using the list_tags_with_http_info variant
|
4467
4089
|
|
4468
4090
|
This returns an Array which contains the response data, status code and headers.
|
4469
4091
|
|
4470
|
-
> <Array(<
|
4092
|
+
> <Array(<TagsResponseBody>, Integer, Hash)> list_tags_with_http_info(user_guid, opts)
|
4471
4093
|
|
4472
4094
|
```ruby
|
4473
4095
|
begin
|
4474
|
-
# List
|
4475
|
-
data, status_code, headers = api_instance.
|
4096
|
+
# List tags
|
4097
|
+
data, status_code, headers = api_instance.list_tags_with_http_info(user_guid, opts)
|
4476
4098
|
p status_code # => 2xx
|
4477
4099
|
p headers # => { ... }
|
4478
|
-
p data # => <
|
4100
|
+
p data # => <TagsResponseBody>
|
4479
4101
|
rescue MxPlatformRuby::ApiError => e
|
4480
|
-
puts "Error when calling MxPlatformApi->
|
4102
|
+
puts "Error when calling MxPlatformApi->list_tags_with_http_info: #{e}"
|
4481
4103
|
end
|
4482
4104
|
```
|
4483
4105
|
|
@@ -4486,13 +4108,12 @@ end
|
|
4486
4108
|
| Name | Type | Description | Notes |
|
4487
4109
|
| ---- | ---- | ----------- | ----- |
|
4488
4110
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4489
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
4490
4111
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4491
4112
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4492
4113
|
|
4493
4114
|
### Return type
|
4494
4115
|
|
4495
|
-
[**
|
4116
|
+
[**TagsResponseBody**](TagsResponseBody.md)
|
4496
4117
|
|
4497
4118
|
### Authorization
|
4498
4119
|
|
@@ -4504,13 +4125,13 @@ end
|
|
4504
4125
|
- **Accept**: application/vnd.mx.api.v1+json
|
4505
4126
|
|
4506
4127
|
|
4507
|
-
##
|
4128
|
+
## list_tax_documents
|
4508
4129
|
|
4509
|
-
> <
|
4130
|
+
> <TaxDocumentsResponseBody> list_tax_documents(member_guid, user_guid, opts)
|
4510
4131
|
|
4511
|
-
List
|
4132
|
+
List Tax Documents
|
4512
4133
|
|
4513
|
-
Use this endpoint to
|
4134
|
+
Use this endpoint to get a paginated list of tax documents.
|
4514
4135
|
|
4515
4136
|
### Examples
|
4516
4137
|
|
@@ -4525,6 +4146,7 @@ MxPlatformRuby.configure do |config|
|
|
4525
4146
|
end
|
4526
4147
|
|
4527
4148
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4149
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4528
4150
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4529
4151
|
opts = {
|
4530
4152
|
page: 1, # Integer | Specify current page.
|
@@ -4532,29 +4154,29 @@ opts = {
|
|
4532
4154
|
}
|
4533
4155
|
|
4534
4156
|
begin
|
4535
|
-
# List
|
4536
|
-
result = api_instance.
|
4157
|
+
# List Tax Documents
|
4158
|
+
result = api_instance.list_tax_documents(member_guid, user_guid, opts)
|
4537
4159
|
p result
|
4538
4160
|
rescue MxPlatformRuby::ApiError => e
|
4539
|
-
puts "Error when calling MxPlatformApi->
|
4161
|
+
puts "Error when calling MxPlatformApi->list_tax_documents: #{e}"
|
4540
4162
|
end
|
4541
4163
|
```
|
4542
4164
|
|
4543
|
-
#### Using the
|
4165
|
+
#### Using the list_tax_documents_with_http_info variant
|
4544
4166
|
|
4545
4167
|
This returns an Array which contains the response data, status code and headers.
|
4546
4168
|
|
4547
|
-
> <Array(<
|
4169
|
+
> <Array(<TaxDocumentsResponseBody>, Integer, Hash)> list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4548
4170
|
|
4549
4171
|
```ruby
|
4550
4172
|
begin
|
4551
|
-
# List
|
4552
|
-
data, status_code, headers = api_instance.
|
4173
|
+
# List Tax Documents
|
4174
|
+
data, status_code, headers = api_instance.list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4553
4175
|
p status_code # => 2xx
|
4554
4176
|
p headers # => { ... }
|
4555
|
-
p data # => <
|
4177
|
+
p data # => <TaxDocumentsResponseBody>
|
4556
4178
|
rescue MxPlatformRuby::ApiError => e
|
4557
|
-
puts "Error when calling MxPlatformApi->
|
4179
|
+
puts "Error when calling MxPlatformApi->list_tax_documents_with_http_info: #{e}"
|
4558
4180
|
end
|
4559
4181
|
```
|
4560
4182
|
|
@@ -4562,13 +4184,14 @@ end
|
|
4562
4184
|
|
4563
4185
|
| Name | Type | Description | Notes |
|
4564
4186
|
| ---- | ---- | ----------- | ----- |
|
4187
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
4565
4188
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4566
4189
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4567
4190
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4568
4191
|
|
4569
4192
|
### Return type
|
4570
4193
|
|
4571
|
-
[**
|
4194
|
+
[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md)
|
4572
4195
|
|
4573
4196
|
### Authorization
|
4574
4197
|
|
@@ -4580,13 +4203,13 @@ end
|
|
4580
4203
|
- **Accept**: application/vnd.mx.api.v1+json
|
4581
4204
|
|
4582
4205
|
|
4583
|
-
##
|
4206
|
+
## list_transaction_rules
|
4584
4207
|
|
4585
|
-
> <
|
4208
|
+
> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
|
4586
4209
|
|
4587
|
-
List
|
4210
|
+
List transaction rules
|
4588
4211
|
|
4589
|
-
Use this endpoint to
|
4212
|
+
Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
|
4590
4213
|
|
4591
4214
|
### Examples
|
4592
4215
|
|
@@ -4601,7 +4224,6 @@ MxPlatformRuby.configure do |config|
|
|
4601
4224
|
end
|
4602
4225
|
|
4603
4226
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4604
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4605
4227
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4606
4228
|
opts = {
|
4607
4229
|
page: 1, # Integer | Specify current page.
|
@@ -4609,29 +4231,29 @@ opts = {
|
|
4609
4231
|
}
|
4610
4232
|
|
4611
4233
|
begin
|
4612
|
-
# List
|
4613
|
-
result = api_instance.
|
4234
|
+
# List transaction rules
|
4235
|
+
result = api_instance.list_transaction_rules(user_guid, opts)
|
4614
4236
|
p result
|
4615
4237
|
rescue MxPlatformRuby::ApiError => e
|
4616
|
-
puts "Error when calling MxPlatformApi->
|
4238
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules: #{e}"
|
4617
4239
|
end
|
4618
4240
|
```
|
4619
4241
|
|
4620
|
-
#### Using the
|
4242
|
+
#### Using the list_transaction_rules_with_http_info variant
|
4621
4243
|
|
4622
4244
|
This returns an Array which contains the response data, status code and headers.
|
4623
4245
|
|
4624
|
-
> <Array(<
|
4246
|
+
> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_with_http_info(user_guid, opts)
|
4625
4247
|
|
4626
4248
|
```ruby
|
4627
4249
|
begin
|
4628
|
-
# List
|
4629
|
-
data, status_code, headers = api_instance.
|
4250
|
+
# List transaction rules
|
4251
|
+
data, status_code, headers = api_instance.list_transaction_rules_with_http_info(user_guid, opts)
|
4630
4252
|
p status_code # => 2xx
|
4631
4253
|
p headers # => { ... }
|
4632
|
-
p data # => <
|
4254
|
+
p data # => <TransactionRulesResponseBody>
|
4633
4255
|
rescue MxPlatformRuby::ApiError => e
|
4634
|
-
puts "Error when calling MxPlatformApi->
|
4256
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules_with_http_info: #{e}"
|
4635
4257
|
end
|
4636
4258
|
```
|
4637
4259
|
|
@@ -4639,14 +4261,13 @@ end
|
|
4639
4261
|
|
4640
4262
|
| Name | Type | Description | Notes |
|
4641
4263
|
| ---- | ---- | ----------- | ----- |
|
4642
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
4643
4264
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4644
4265
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4645
4266
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4646
4267
|
|
4647
4268
|
### Return type
|
4648
4269
|
|
4649
|
-
[**
|
4270
|
+
[**TransactionRulesResponseBody**](TransactionRulesResponseBody.md)
|
4650
4271
|
|
4651
4272
|
### Authorization
|
4652
4273
|
|
@@ -4658,13 +4279,13 @@ end
|
|
4658
4279
|
- **Accept**: application/vnd.mx.api.v1+json
|
4659
4280
|
|
4660
4281
|
|
4661
|
-
##
|
4282
|
+
## list_transactions
|
4662
4283
|
|
4663
|
-
> <
|
4284
|
+
> <TransactionsResponseBody> list_transactions(user_guid, opts)
|
4664
4285
|
|
4665
|
-
List
|
4286
|
+
List transactions
|
4666
4287
|
|
4667
|
-
|
4288
|
+
Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
|
4668
4289
|
|
4669
4290
|
### Examples
|
4670
4291
|
|
@@ -4681,34 +4302,36 @@ end
|
|
4681
4302
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4682
4303
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4683
4304
|
opts = {
|
4305
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4684
4306
|
page: 1, # Integer | Specify current page.
|
4685
|
-
records_per_page: 10 # Integer | Specify records per page.
|
4307
|
+
records_per_page: 10, # Integer | Specify records per page.
|
4308
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4686
4309
|
}
|
4687
4310
|
|
4688
4311
|
begin
|
4689
|
-
# List
|
4690
|
-
result = api_instance.
|
4312
|
+
# List transactions
|
4313
|
+
result = api_instance.list_transactions(user_guid, opts)
|
4691
4314
|
p result
|
4692
4315
|
rescue MxPlatformRuby::ApiError => e
|
4693
|
-
puts "Error when calling MxPlatformApi->
|
4316
|
+
puts "Error when calling MxPlatformApi->list_transactions: #{e}"
|
4694
4317
|
end
|
4695
4318
|
```
|
4696
4319
|
|
4697
|
-
#### Using the
|
4320
|
+
#### Using the list_transactions_with_http_info variant
|
4698
4321
|
|
4699
4322
|
This returns an Array which contains the response data, status code and headers.
|
4700
4323
|
|
4701
|
-
> <Array(<
|
4324
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_with_http_info(user_guid, opts)
|
4702
4325
|
|
4703
4326
|
```ruby
|
4704
4327
|
begin
|
4705
|
-
# List
|
4706
|
-
data, status_code, headers = api_instance.
|
4328
|
+
# List transactions
|
4329
|
+
data, status_code, headers = api_instance.list_transactions_with_http_info(user_guid, opts)
|
4707
4330
|
p status_code # => 2xx
|
4708
4331
|
p headers # => { ... }
|
4709
|
-
p data # => <
|
4332
|
+
p data # => <TransactionsResponseBody>
|
4710
4333
|
rescue MxPlatformRuby::ApiError => e
|
4711
|
-
puts "Error when calling MxPlatformApi->
|
4334
|
+
puts "Error when calling MxPlatformApi->list_transactions_with_http_info: #{e}"
|
4712
4335
|
end
|
4713
4336
|
```
|
4714
4337
|
|
@@ -4717,12 +4340,14 @@ end
|
|
4717
4340
|
| Name | Type | Description | Notes |
|
4718
4341
|
| ---- | ---- | ----------- | ----- |
|
4719
4342
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4343
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4720
4344
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4721
4345
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4346
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4722
4347
|
|
4723
4348
|
### Return type
|
4724
4349
|
|
4725
|
-
[**
|
4350
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4726
4351
|
|
4727
4352
|
### Authorization
|
4728
4353
|
|
@@ -4734,13 +4359,13 @@ end
|
|
4734
4359
|
- **Accept**: application/vnd.mx.api.v1+json
|
4735
4360
|
|
4736
4361
|
|
4737
|
-
##
|
4362
|
+
## list_transactions_by_account
|
4738
4363
|
|
4739
|
-
> <
|
4364
|
+
> <TransactionsResponseBody> list_transactions_by_account(account_guid, user_guid, opts)
|
4740
4365
|
|
4741
|
-
List
|
4366
|
+
List transactions by account
|
4742
4367
|
|
4743
|
-
|
4368
|
+
This endpoint returns a list of the last 90 days of transactions associated with the specified account.
|
4744
4369
|
|
4745
4370
|
### Examples
|
4746
4371
|
|
@@ -4755,36 +4380,39 @@ MxPlatformRuby.configure do |config|
|
|
4755
4380
|
end
|
4756
4381
|
|
4757
4382
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4383
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4758
4384
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4759
4385
|
opts = {
|
4386
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4760
4387
|
page: 1, # Integer | Specify current page.
|
4761
|
-
records_per_page: 10 # Integer | Specify records per page.
|
4388
|
+
records_per_page: 10, # Integer | Specify records per page.
|
4389
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4762
4390
|
}
|
4763
4391
|
|
4764
4392
|
begin
|
4765
|
-
# List
|
4766
|
-
result = api_instance.
|
4393
|
+
# List transactions by account
|
4394
|
+
result = api_instance.list_transactions_by_account(account_guid, user_guid, opts)
|
4767
4395
|
p result
|
4768
4396
|
rescue MxPlatformRuby::ApiError => e
|
4769
|
-
puts "Error when calling MxPlatformApi->
|
4397
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account: #{e}"
|
4770
4398
|
end
|
4771
4399
|
```
|
4772
4400
|
|
4773
|
-
#### Using the
|
4401
|
+
#### Using the list_transactions_by_account_with_http_info variant
|
4774
4402
|
|
4775
4403
|
This returns an Array which contains the response data, status code and headers.
|
4776
4404
|
|
4777
|
-
> <Array(<
|
4405
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
4778
4406
|
|
4779
4407
|
```ruby
|
4780
4408
|
begin
|
4781
|
-
# List
|
4782
|
-
data, status_code, headers = api_instance.
|
4409
|
+
# List transactions by account
|
4410
|
+
data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
4783
4411
|
p status_code # => 2xx
|
4784
4412
|
p headers # => { ... }
|
4785
|
-
p data # => <
|
4413
|
+
p data # => <TransactionsResponseBody>
|
4786
4414
|
rescue MxPlatformRuby::ApiError => e
|
4787
|
-
puts "Error when calling MxPlatformApi->
|
4415
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account_with_http_info: #{e}"
|
4788
4416
|
end
|
4789
4417
|
```
|
4790
4418
|
|
@@ -4792,13 +4420,16 @@ end
|
|
4792
4420
|
|
4793
4421
|
| Name | Type | Description | Notes |
|
4794
4422
|
| ---- | ---- | ----------- | ----- |
|
4423
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4795
4424
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4425
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4796
4426
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4797
4427
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4428
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4798
4429
|
|
4799
4430
|
### Return type
|
4800
4431
|
|
4801
|
-
[**
|
4432
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4802
4433
|
|
4803
4434
|
### Authorization
|
4804
4435
|
|
@@ -4810,13 +4441,13 @@ end
|
|
4810
4441
|
- **Accept**: application/vnd.mx.api.v1+json
|
4811
4442
|
|
4812
4443
|
|
4813
|
-
##
|
4444
|
+
## list_transactions_by_member
|
4814
4445
|
|
4815
|
-
> <
|
4446
|
+
> <TransactionsResponseBody> list_transactions_by_member(member_guid, user_guid, opts)
|
4816
4447
|
|
4817
|
-
List
|
4448
|
+
List transactions by member
|
4818
4449
|
|
4819
|
-
|
4450
|
+
Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
|
4820
4451
|
|
4821
4452
|
### Examples
|
4822
4453
|
|
@@ -4834,34 +4465,36 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
4834
4465
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4835
4466
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4836
4467
|
opts = {
|
4468
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4837
4469
|
page: 1, # Integer | Specify current page.
|
4838
|
-
records_per_page: 10 # Integer | Specify records per page.
|
4470
|
+
records_per_page: 10, # Integer | Specify records per page.
|
4471
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4839
4472
|
}
|
4840
4473
|
|
4841
4474
|
begin
|
4842
|
-
# List
|
4843
|
-
result = api_instance.
|
4475
|
+
# List transactions by member
|
4476
|
+
result = api_instance.list_transactions_by_member(member_guid, user_guid, opts)
|
4844
4477
|
p result
|
4845
4478
|
rescue MxPlatformRuby::ApiError => e
|
4846
|
-
puts "Error when calling MxPlatformApi->
|
4479
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member: #{e}"
|
4847
4480
|
end
|
4848
4481
|
```
|
4849
4482
|
|
4850
|
-
#### Using the
|
4483
|
+
#### Using the list_transactions_by_member_with_http_info variant
|
4851
4484
|
|
4852
4485
|
This returns an Array which contains the response data, status code and headers.
|
4853
4486
|
|
4854
|
-
> <Array(<
|
4487
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
4855
4488
|
|
4856
4489
|
```ruby
|
4857
4490
|
begin
|
4858
|
-
# List
|
4859
|
-
data, status_code, headers = api_instance.
|
4491
|
+
# List transactions by member
|
4492
|
+
data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
4860
4493
|
p status_code # => 2xx
|
4861
4494
|
p headers # => { ... }
|
4862
|
-
p data # => <
|
4495
|
+
p data # => <TransactionsResponseBody>
|
4863
4496
|
rescue MxPlatformRuby::ApiError => e
|
4864
|
-
puts "Error when calling MxPlatformApi->
|
4497
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member_with_http_info: #{e}"
|
4865
4498
|
end
|
4866
4499
|
```
|
4867
4500
|
|
@@ -4871,12 +4504,14 @@ end
|
|
4871
4504
|
| ---- | ---- | ----------- | ----- |
|
4872
4505
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4873
4506
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4507
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4874
4508
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4875
4509
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4510
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4876
4511
|
|
4877
4512
|
### Return type
|
4878
4513
|
|
4879
|
-
[**
|
4514
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4880
4515
|
|
4881
4516
|
### Authorization
|
4882
4517
|
|
@@ -4888,13 +4523,13 @@ end
|
|
4888
4523
|
- **Accept**: application/vnd.mx.api.v1+json
|
4889
4524
|
|
4890
4525
|
|
4891
|
-
##
|
4526
|
+
## list_transactions_by_tag
|
4892
4527
|
|
4893
|
-
> <
|
4528
|
+
> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts)
|
4894
4529
|
|
4895
|
-
List
|
4530
|
+
List transactions by tag
|
4896
4531
|
|
4897
|
-
Use this endpoint to
|
4532
|
+
Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.
|
4898
4533
|
|
4899
4534
|
### Examples
|
4900
4535
|
|
@@ -4909,36 +4544,39 @@ MxPlatformRuby.configure do |config|
|
|
4909
4544
|
end
|
4910
4545
|
|
4911
4546
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4547
|
+
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
4912
4548
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4913
4549
|
opts = {
|
4550
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4914
4551
|
page: 1, # Integer | Specify current page.
|
4915
|
-
records_per_page: 10 # Integer | Specify records per page.
|
4552
|
+
records_per_page: 10, # Integer | Specify records per page.
|
4553
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4916
4554
|
}
|
4917
4555
|
|
4918
4556
|
begin
|
4919
|
-
# List
|
4920
|
-
result = api_instance.
|
4557
|
+
# List transactions by tag
|
4558
|
+
result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts)
|
4921
4559
|
p result
|
4922
4560
|
rescue MxPlatformRuby::ApiError => e
|
4923
|
-
puts "Error when calling MxPlatformApi->
|
4561
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
|
4924
4562
|
end
|
4925
4563
|
```
|
4926
4564
|
|
4927
|
-
#### Using the
|
4565
|
+
#### Using the list_transactions_by_tag_with_http_info variant
|
4928
4566
|
|
4929
4567
|
This returns an Array which contains the response data, status code and headers.
|
4930
4568
|
|
4931
|
-
> <Array(<
|
4569
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
4932
4570
|
|
4933
4571
|
```ruby
|
4934
4572
|
begin
|
4935
|
-
# List
|
4936
|
-
data, status_code, headers = api_instance.
|
4573
|
+
# List transactions by tag
|
4574
|
+
data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
4937
4575
|
p status_code # => 2xx
|
4938
4576
|
p headers # => { ... }
|
4939
|
-
p data # => <
|
4577
|
+
p data # => <TransactionsResponseBody>
|
4940
4578
|
rescue MxPlatformRuby::ApiError => e
|
4941
|
-
puts "Error when calling MxPlatformApi->
|
4579
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}"
|
4942
4580
|
end
|
4943
4581
|
```
|
4944
4582
|
|
@@ -4946,13 +4584,16 @@ end
|
|
4946
4584
|
|
4947
4585
|
| Name | Type | Description | Notes |
|
4948
4586
|
| ---- | ---- | ----------- | ----- |
|
4587
|
+
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
4949
4588
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4589
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4950
4590
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4951
4591
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4592
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4952
4593
|
|
4953
4594
|
### Return type
|
4954
4595
|
|
4955
|
-
[**
|
4596
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4956
4597
|
|
4957
4598
|
### Authorization
|
4958
4599
|
|
@@ -4964,13 +4605,13 @@ end
|
|
4964
4605
|
- **Accept**: application/vnd.mx.api.v1+json
|
4965
4606
|
|
4966
4607
|
|
4967
|
-
##
|
4608
|
+
## list_user_accounts
|
4968
4609
|
|
4969
|
-
> <
|
4610
|
+
> <AccountsResponseBody> list_user_accounts(user_guid, opts)
|
4970
4611
|
|
4971
|
-
List
|
4612
|
+
List accounts
|
4972
4613
|
|
4973
|
-
|
4614
|
+
This endpoint returns a list of all the accounts associated with the specified `user`.
|
4974
4615
|
|
4975
4616
|
### Examples
|
4976
4617
|
|
@@ -4987,36 +4628,36 @@ end
|
|
4987
4628
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4988
4629
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4989
4630
|
opts = {
|
4990
|
-
|
4631
|
+
member_is_managed_by_user: true, # Boolean | List only accounts whose member is managed by the user.
|
4991
4632
|
page: 1, # Integer | Specify current page.
|
4992
|
-
|
4993
|
-
|
4633
|
+
is_manual: true, # Boolean | List only accounts that were manually created.
|
4634
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4994
4635
|
}
|
4995
4636
|
|
4996
4637
|
begin
|
4997
|
-
# List
|
4998
|
-
result = api_instance.
|
4638
|
+
# List accounts
|
4639
|
+
result = api_instance.list_user_accounts(user_guid, opts)
|
4999
4640
|
p result
|
5000
4641
|
rescue MxPlatformRuby::ApiError => e
|
5001
|
-
puts "Error when calling MxPlatformApi->
|
4642
|
+
puts "Error when calling MxPlatformApi->list_user_accounts: #{e}"
|
5002
4643
|
end
|
5003
4644
|
```
|
5004
4645
|
|
5005
|
-
#### Using the
|
4646
|
+
#### Using the list_user_accounts_with_http_info variant
|
5006
4647
|
|
5007
4648
|
This returns an Array which contains the response data, status code and headers.
|
5008
4649
|
|
5009
|
-
> <Array(<
|
4650
|
+
> <Array(<AccountsResponseBody>, Integer, Hash)> list_user_accounts_with_http_info(user_guid, opts)
|
5010
4651
|
|
5011
4652
|
```ruby
|
5012
4653
|
begin
|
5013
|
-
# List
|
5014
|
-
data, status_code, headers = api_instance.
|
4654
|
+
# List accounts
|
4655
|
+
data, status_code, headers = api_instance.list_user_accounts_with_http_info(user_guid, opts)
|
5015
4656
|
p status_code # => 2xx
|
5016
4657
|
p headers # => { ... }
|
5017
|
-
p data # => <
|
4658
|
+
p data # => <AccountsResponseBody>
|
5018
4659
|
rescue MxPlatformRuby::ApiError => e
|
5019
|
-
puts "Error when calling MxPlatformApi->
|
4660
|
+
puts "Error when calling MxPlatformApi->list_user_accounts_with_http_info: #{e}"
|
5020
4661
|
end
|
5021
4662
|
```
|
5022
4663
|
|
@@ -5025,14 +4666,14 @@ end
|
|
5025
4666
|
| Name | Type | Description | Notes |
|
5026
4667
|
| ---- | ---- | ----------- | ----- |
|
5027
4668
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5028
|
-
| **
|
4669
|
+
| **member_is_managed_by_user** | **Boolean** | List only accounts whose member is managed by the user. | [optional] |
|
5029
4670
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4671
|
+
| **is_manual** | **Boolean** | List only accounts that were manually created. | [optional] |
|
5030
4672
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5031
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
5032
4673
|
|
5033
4674
|
### Return type
|
5034
4675
|
|
5035
|
-
[**
|
4676
|
+
[**AccountsResponseBody**](AccountsResponseBody.md)
|
5036
4677
|
|
5037
4678
|
### Authorization
|
5038
4679
|
|
@@ -5044,13 +4685,13 @@ end
|
|
5044
4685
|
- **Accept**: application/vnd.mx.api.v1+json
|
5045
4686
|
|
5046
4687
|
|
5047
|
-
##
|
4688
|
+
## list_users
|
5048
4689
|
|
5049
|
-
> <
|
4690
|
+
> <UsersResponseBody> list_users(opts)
|
5050
4691
|
|
5051
|
-
List
|
4692
|
+
List users
|
5052
4693
|
|
5053
|
-
|
4694
|
+
Use this endpoint to list every user you've created in the MX Platform API.
|
5054
4695
|
|
5055
4696
|
### Examples
|
5056
4697
|
|
@@ -5065,39 +4706,38 @@ MxPlatformRuby.configure do |config|
|
|
5065
4706
|
end
|
5066
4707
|
|
5067
4708
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5068
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5069
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5070
4709
|
opts = {
|
5071
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
5072
4710
|
page: 1, # Integer | Specify current page.
|
5073
4711
|
records_per_page: 10, # Integer | Specify records per page.
|
5074
|
-
|
4712
|
+
id: 'u-12324-abdc', # String | The user `id` to search for.
|
4713
|
+
email: 'example@example.com', # String | The user `email` to search for.
|
4714
|
+
is_disabled: true # Boolean | Search for users that are diabled.
|
5075
4715
|
}
|
5076
4716
|
|
5077
4717
|
begin
|
5078
|
-
# List
|
5079
|
-
result = api_instance.
|
4718
|
+
# List users
|
4719
|
+
result = api_instance.list_users(opts)
|
5080
4720
|
p result
|
5081
4721
|
rescue MxPlatformRuby::ApiError => e
|
5082
|
-
puts "Error when calling MxPlatformApi->
|
4722
|
+
puts "Error when calling MxPlatformApi->list_users: #{e}"
|
5083
4723
|
end
|
5084
4724
|
```
|
5085
4725
|
|
5086
|
-
#### Using the
|
4726
|
+
#### Using the list_users_with_http_info variant
|
5087
4727
|
|
5088
4728
|
This returns an Array which contains the response data, status code and headers.
|
5089
4729
|
|
5090
|
-
> <Array(<
|
4730
|
+
> <Array(<UsersResponseBody>, Integer, Hash)> list_users_with_http_info(opts)
|
5091
4731
|
|
5092
4732
|
```ruby
|
5093
4733
|
begin
|
5094
|
-
# List
|
5095
|
-
data, status_code, headers = api_instance.
|
4734
|
+
# List users
|
4735
|
+
data, status_code, headers = api_instance.list_users_with_http_info(opts)
|
5096
4736
|
p status_code # => 2xx
|
5097
4737
|
p headers # => { ... }
|
5098
|
-
p data # => <
|
4738
|
+
p data # => <UsersResponseBody>
|
5099
4739
|
rescue MxPlatformRuby::ApiError => e
|
5100
|
-
puts "Error when calling MxPlatformApi->
|
4740
|
+
puts "Error when calling MxPlatformApi->list_users_with_http_info: #{e}"
|
5101
4741
|
end
|
5102
4742
|
```
|
5103
4743
|
|
@@ -5105,16 +4745,15 @@ end
|
|
5105
4745
|
|
5106
4746
|
| Name | Type | Description | Notes |
|
5107
4747
|
| ---- | ---- | ----------- | ----- |
|
5108
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
5109
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5110
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
5111
4748
|
| **page** | **Integer** | Specify current page. | [optional] |
|
5112
4749
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5113
|
-
| **
|
4750
|
+
| **id** | **String** | The user `id` to search for. | [optional] |
|
4751
|
+
| **email** | **String** | The user `email` to search for. | [optional] |
|
4752
|
+
| **is_disabled** | **Boolean** | Search for users that are diabled. | [optional] |
|
5114
4753
|
|
5115
4754
|
### Return type
|
5116
4755
|
|
5117
|
-
[**
|
4756
|
+
[**UsersResponseBody**](UsersResponseBody.md)
|
5118
4757
|
|
5119
4758
|
### Authorization
|
5120
4759
|
|
@@ -5126,13 +4765,13 @@ end
|
|
5126
4765
|
- **Accept**: application/vnd.mx.api.v1+json
|
5127
4766
|
|
5128
4767
|
|
5129
|
-
##
|
4768
|
+
## read_account
|
5130
4769
|
|
5131
|
-
> <
|
4770
|
+
> <AccountResponseBody> read_account(account_guid, user_guid)
|
5132
4771
|
|
5133
|
-
|
4772
|
+
Read account
|
5134
4773
|
|
5135
|
-
|
4774
|
+
This endpoint returns the specified `account` resource.
|
5136
4775
|
|
5137
4776
|
### Examples
|
5138
4777
|
|
@@ -5147,39 +4786,33 @@ MxPlatformRuby.configure do |config|
|
|
5147
4786
|
end
|
5148
4787
|
|
5149
4788
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5150
|
-
|
4789
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5151
4790
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5152
|
-
opts = {
|
5153
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
5154
|
-
page: 1, # Integer | Specify current page.
|
5155
|
-
records_per_page: 10, # Integer | Specify records per page.
|
5156
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
5157
|
-
}
|
5158
4791
|
|
5159
4792
|
begin
|
5160
|
-
#
|
5161
|
-
result = api_instance.
|
4793
|
+
# Read account
|
4794
|
+
result = api_instance.read_account(account_guid, user_guid)
|
5162
4795
|
p result
|
5163
4796
|
rescue MxPlatformRuby::ApiError => e
|
5164
|
-
puts "Error when calling MxPlatformApi->
|
4797
|
+
puts "Error when calling MxPlatformApi->read_account: #{e}"
|
5165
4798
|
end
|
5166
4799
|
```
|
5167
4800
|
|
5168
|
-
#### Using the
|
4801
|
+
#### Using the read_account_with_http_info variant
|
5169
4802
|
|
5170
4803
|
This returns an Array which contains the response data, status code and headers.
|
5171
4804
|
|
5172
|
-
> <Array(<
|
4805
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_account_with_http_info(account_guid, user_guid)
|
5173
4806
|
|
5174
4807
|
```ruby
|
5175
4808
|
begin
|
5176
|
-
#
|
5177
|
-
data, status_code, headers = api_instance.
|
4809
|
+
# Read account
|
4810
|
+
data, status_code, headers = api_instance.read_account_with_http_info(account_guid, user_guid)
|
5178
4811
|
p status_code # => 2xx
|
5179
4812
|
p headers # => { ... }
|
5180
|
-
p data # => <
|
4813
|
+
p data # => <AccountResponseBody>
|
5181
4814
|
rescue MxPlatformRuby::ApiError => e
|
5182
|
-
puts "Error when calling MxPlatformApi->
|
4815
|
+
puts "Error when calling MxPlatformApi->read_account_with_http_info: #{e}"
|
5183
4816
|
end
|
5184
4817
|
```
|
5185
4818
|
|
@@ -5187,16 +4820,12 @@ end
|
|
5187
4820
|
|
5188
4821
|
| Name | Type | Description | Notes |
|
5189
4822
|
| ---- | ---- | ----------- | ----- |
|
5190
|
-
| **
|
4823
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
5191
4824
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5192
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
5193
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
5194
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5195
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
5196
4825
|
|
5197
4826
|
### Return type
|
5198
4827
|
|
5199
|
-
[**
|
4828
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
5200
4829
|
|
5201
4830
|
### Authorization
|
5202
4831
|
|
@@ -5208,13 +4837,13 @@ end
|
|
5208
4837
|
- **Accept**: application/vnd.mx.api.v1+json
|
5209
4838
|
|
5210
4839
|
|
5211
|
-
##
|
4840
|
+
## read_account_by_member
|
5212
4841
|
|
5213
|
-
> <
|
4842
|
+
> <AccountResponseBody> read_account_by_member(account_guid, member_guid, user_guid)
|
5214
4843
|
|
5215
|
-
|
4844
|
+
Read account by member
|
5216
4845
|
|
5217
|
-
|
4846
|
+
This endpoint allows you to read the attributes of an `account` resource.
|
5218
4847
|
|
5219
4848
|
### Examples
|
5220
4849
|
|
@@ -5229,39 +4858,34 @@ MxPlatformRuby.configure do |config|
|
|
5229
4858
|
end
|
5230
4859
|
|
5231
4860
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5232
|
-
|
4861
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4862
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5233
4863
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5234
|
-
opts = {
|
5235
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
5236
|
-
page: 1, # Integer | Specify current page.
|
5237
|
-
records_per_page: 10, # Integer | Specify records per page.
|
5238
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
5239
|
-
}
|
5240
4864
|
|
5241
4865
|
begin
|
5242
|
-
#
|
5243
|
-
result = api_instance.
|
4866
|
+
# Read account by member
|
4867
|
+
result = api_instance.read_account_by_member(account_guid, member_guid, user_guid)
|
5244
4868
|
p result
|
5245
4869
|
rescue MxPlatformRuby::ApiError => e
|
5246
|
-
puts "Error when calling MxPlatformApi->
|
4870
|
+
puts "Error when calling MxPlatformApi->read_account_by_member: #{e}"
|
5247
4871
|
end
|
5248
4872
|
```
|
5249
4873
|
|
5250
|
-
#### Using the
|
4874
|
+
#### Using the read_account_by_member_with_http_info variant
|
5251
4875
|
|
5252
4876
|
This returns an Array which contains the response data, status code and headers.
|
5253
4877
|
|
5254
|
-
> <Array(<
|
4878
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
|
5255
4879
|
|
5256
4880
|
```ruby
|
5257
4881
|
begin
|
5258
|
-
#
|
5259
|
-
data, status_code, headers = api_instance.
|
4882
|
+
# Read account by member
|
4883
|
+
data, status_code, headers = api_instance.read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
|
5260
4884
|
p status_code # => 2xx
|
5261
4885
|
p headers # => { ... }
|
5262
|
-
p data # => <
|
4886
|
+
p data # => <AccountResponseBody>
|
5263
4887
|
rescue MxPlatformRuby::ApiError => e
|
5264
|
-
puts "Error when calling MxPlatformApi->
|
4888
|
+
puts "Error when calling MxPlatformApi->read_account_by_member_with_http_info: #{e}"
|
5265
4889
|
end
|
5266
4890
|
```
|
5267
4891
|
|
@@ -5269,16 +4893,13 @@ end
|
|
5269
4893
|
|
5270
4894
|
| Name | Type | Description | Notes |
|
5271
4895
|
| ---- | ---- | ----------- | ----- |
|
5272
|
-
| **
|
4896
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
4897
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
5273
4898
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5274
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
5275
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
5276
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5277
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
5278
4899
|
|
5279
4900
|
### Return type
|
5280
4901
|
|
5281
|
-
[**
|
4902
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
5282
4903
|
|
5283
4904
|
### Authorization
|
5284
4905
|
|
@@ -5290,13 +4911,13 @@ end
|
|
5290
4911
|
- **Accept**: application/vnd.mx.api.v1+json
|
5291
4912
|
|
5292
4913
|
|
5293
|
-
##
|
4914
|
+
## read_category
|
5294
4915
|
|
5295
|
-
> <
|
4916
|
+
> <CategoryResponseBody> read_category(category_guid, user_guid)
|
5296
4917
|
|
5297
|
-
|
4918
|
+
Read a custom category
|
5298
4919
|
|
5299
|
-
|
4920
|
+
Use this endpoint to read the attributes of either a default category or a custom category.
|
5300
4921
|
|
5301
4922
|
### Examples
|
5302
4923
|
|
@@ -5311,38 +4932,33 @@ MxPlatformRuby.configure do |config|
|
|
5311
4932
|
end
|
5312
4933
|
|
5313
4934
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4935
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
5314
4936
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5315
|
-
opts = {
|
5316
|
-
member_is_managed_by_user: true, # Boolean | List only accounts whose member is managed by the user.
|
5317
|
-
page: 1, # Integer | Specify current page.
|
5318
|
-
is_manual: true, # Boolean | List only accounts that were manually created.
|
5319
|
-
records_per_page: 10 # Integer | Specify records per page.
|
5320
|
-
}
|
5321
4937
|
|
5322
4938
|
begin
|
5323
|
-
#
|
5324
|
-
result = api_instance.
|
4939
|
+
# Read a custom category
|
4940
|
+
result = api_instance.read_category(category_guid, user_guid)
|
5325
4941
|
p result
|
5326
4942
|
rescue MxPlatformRuby::ApiError => e
|
5327
|
-
puts "Error when calling MxPlatformApi->
|
4943
|
+
puts "Error when calling MxPlatformApi->read_category: #{e}"
|
5328
4944
|
end
|
5329
4945
|
```
|
5330
4946
|
|
5331
|
-
#### Using the
|
4947
|
+
#### Using the read_category_with_http_info variant
|
5332
4948
|
|
5333
4949
|
This returns an Array which contains the response data, status code and headers.
|
5334
4950
|
|
5335
|
-
> <Array(<
|
4951
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_category_with_http_info(category_guid, user_guid)
|
5336
4952
|
|
5337
4953
|
```ruby
|
5338
4954
|
begin
|
5339
|
-
#
|
5340
|
-
data, status_code, headers = api_instance.
|
4955
|
+
# Read a custom category
|
4956
|
+
data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
|
5341
4957
|
p status_code # => 2xx
|
5342
4958
|
p headers # => { ... }
|
5343
|
-
p data # => <
|
4959
|
+
p data # => <CategoryResponseBody>
|
5344
4960
|
rescue MxPlatformRuby::ApiError => e
|
5345
|
-
puts "Error when calling MxPlatformApi->
|
4961
|
+
puts "Error when calling MxPlatformApi->read_category_with_http_info: #{e}"
|
5346
4962
|
end
|
5347
4963
|
```
|
5348
4964
|
|
@@ -5350,15 +4966,12 @@ end
|
|
5350
4966
|
|
5351
4967
|
| Name | Type | Description | Notes |
|
5352
4968
|
| ---- | ---- | ----------- | ----- |
|
4969
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
5353
4970
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5354
|
-
| **member_is_managed_by_user** | **Boolean** | List only accounts whose member is managed by the user. | [optional] |
|
5355
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
5356
|
-
| **is_manual** | **Boolean** | List only accounts that were manually created. | [optional] |
|
5357
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5358
4971
|
|
5359
4972
|
### Return type
|
5360
4973
|
|
5361
|
-
[**
|
4974
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
5362
4975
|
|
5363
4976
|
### Authorization
|
5364
4977
|
|
@@ -5370,13 +4983,13 @@ end
|
|
5370
4983
|
- **Accept**: application/vnd.mx.api.v1+json
|
5371
4984
|
|
5372
4985
|
|
5373
|
-
##
|
4986
|
+
## read_default_category
|
5374
4987
|
|
5375
|
-
> <
|
4988
|
+
> <CategoryResponseBody> read_default_category(category_guid)
|
5376
4989
|
|
5377
|
-
|
4990
|
+
Read a default category
|
5378
4991
|
|
5379
|
-
Use this endpoint to
|
4992
|
+
Use this endpoint to read the attributes of a default category.
|
5380
4993
|
|
5381
4994
|
### Examples
|
5382
4995
|
|
@@ -5391,38 +5004,32 @@ MxPlatformRuby.configure do |config|
|
|
5391
5004
|
end
|
5392
5005
|
|
5393
5006
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5394
|
-
|
5395
|
-
page: 1, # Integer | Specify current page.
|
5396
|
-
records_per_page: 10, # Integer | Specify records per page.
|
5397
|
-
id: 'u-12324-abdc', # String | The user `id` to search for.
|
5398
|
-
email: 'example@example.com', # String | The user `email` to search for.
|
5399
|
-
is_disabled: true # Boolean | Search for users that are diabled.
|
5400
|
-
}
|
5007
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
5401
5008
|
|
5402
5009
|
begin
|
5403
|
-
#
|
5404
|
-
result = api_instance.
|
5010
|
+
# Read a default category
|
5011
|
+
result = api_instance.read_default_category(category_guid)
|
5405
5012
|
p result
|
5406
5013
|
rescue MxPlatformRuby::ApiError => e
|
5407
|
-
puts "Error when calling MxPlatformApi->
|
5014
|
+
puts "Error when calling MxPlatformApi->read_default_category: #{e}"
|
5408
5015
|
end
|
5409
5016
|
```
|
5410
5017
|
|
5411
|
-
#### Using the
|
5018
|
+
#### Using the read_default_category_with_http_info variant
|
5412
5019
|
|
5413
5020
|
This returns an Array which contains the response data, status code and headers.
|
5414
5021
|
|
5415
|
-
> <Array(<
|
5022
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid)
|
5416
5023
|
|
5417
5024
|
```ruby
|
5418
5025
|
begin
|
5419
|
-
#
|
5420
|
-
data, status_code, headers = api_instance.
|
5026
|
+
# Read a default category
|
5027
|
+
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid)
|
5421
5028
|
p status_code # => 2xx
|
5422
5029
|
p headers # => { ... }
|
5423
|
-
p data # => <
|
5030
|
+
p data # => <CategoryResponseBody>
|
5424
5031
|
rescue MxPlatformRuby::ApiError => e
|
5425
|
-
puts "Error when calling MxPlatformApi->
|
5032
|
+
puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
|
5426
5033
|
end
|
5427
5034
|
```
|
5428
5035
|
|
@@ -5430,15 +5037,11 @@ end
|
|
5430
5037
|
|
5431
5038
|
| Name | Type | Description | Notes |
|
5432
5039
|
| ---- | ---- | ----------- | ----- |
|
5433
|
-
| **
|
5434
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5435
|
-
| **id** | **String** | The user `id` to search for. | [optional] |
|
5436
|
-
| **email** | **String** | The user `email` to search for. | [optional] |
|
5437
|
-
| **is_disabled** | **Boolean** | Search for users that are diabled. | [optional] |
|
5040
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
5438
5041
|
|
5439
5042
|
### Return type
|
5440
5043
|
|
5441
|
-
[**
|
5044
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
5442
5045
|
|
5443
5046
|
### Authorization
|
5444
5047
|
|
@@ -5450,13 +5053,13 @@ end
|
|
5450
5053
|
- **Accept**: application/vnd.mx.api.v1+json
|
5451
5054
|
|
5452
5055
|
|
5453
|
-
##
|
5056
|
+
## read_holding
|
5454
5057
|
|
5455
|
-
> <
|
5058
|
+
> <HoldingResponseBody> read_holding(holding_guid, user_guid)
|
5456
5059
|
|
5457
|
-
Read
|
5060
|
+
Read holding
|
5458
5061
|
|
5459
|
-
|
5062
|
+
Use this endpoint to read the attributes of a specific `holding`.
|
5460
5063
|
|
5461
5064
|
### Examples
|
5462
5065
|
|
@@ -5471,33 +5074,33 @@ MxPlatformRuby.configure do |config|
|
|
5471
5074
|
end
|
5472
5075
|
|
5473
5076
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5474
|
-
|
5077
|
+
holding_guid = 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2' # String | The unique id for a `holding`.
|
5475
5078
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5476
5079
|
|
5477
5080
|
begin
|
5478
|
-
# Read
|
5479
|
-
result = api_instance.
|
5081
|
+
# Read holding
|
5082
|
+
result = api_instance.read_holding(holding_guid, user_guid)
|
5480
5083
|
p result
|
5481
5084
|
rescue MxPlatformRuby::ApiError => e
|
5482
|
-
puts "Error when calling MxPlatformApi->
|
5085
|
+
puts "Error when calling MxPlatformApi->read_holding: #{e}"
|
5483
5086
|
end
|
5484
5087
|
```
|
5485
5088
|
|
5486
|
-
#### Using the
|
5089
|
+
#### Using the read_holding_with_http_info variant
|
5487
5090
|
|
5488
5091
|
This returns an Array which contains the response data, status code and headers.
|
5489
5092
|
|
5490
|
-
> <Array(<
|
5093
|
+
> <Array(<HoldingResponseBody>, Integer, Hash)> read_holding_with_http_info(holding_guid, user_guid)
|
5491
5094
|
|
5492
5095
|
```ruby
|
5493
5096
|
begin
|
5494
|
-
# Read
|
5495
|
-
data, status_code, headers = api_instance.
|
5097
|
+
# Read holding
|
5098
|
+
data, status_code, headers = api_instance.read_holding_with_http_info(holding_guid, user_guid)
|
5496
5099
|
p status_code # => 2xx
|
5497
5100
|
p headers # => { ... }
|
5498
|
-
p data # => <
|
5101
|
+
p data # => <HoldingResponseBody>
|
5499
5102
|
rescue MxPlatformRuby::ApiError => e
|
5500
|
-
puts "Error when calling MxPlatformApi->
|
5103
|
+
puts "Error when calling MxPlatformApi->read_holding_with_http_info: #{e}"
|
5501
5104
|
end
|
5502
5105
|
```
|
5503
5106
|
|
@@ -5505,12 +5108,12 @@ end
|
|
5505
5108
|
|
5506
5109
|
| Name | Type | Description | Notes |
|
5507
5110
|
| ---- | ---- | ----------- | ----- |
|
5508
|
-
| **
|
5111
|
+
| **holding_guid** | **String** | The unique id for a `holding`. | |
|
5509
5112
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5510
5113
|
|
5511
5114
|
### Return type
|
5512
5115
|
|
5513
|
-
[**
|
5116
|
+
[**HoldingResponseBody**](HoldingResponseBody.md)
|
5514
5117
|
|
5515
5118
|
### Authorization
|
5516
5119
|
|
@@ -5522,13 +5125,13 @@ end
|
|
5522
5125
|
- **Accept**: application/vnd.mx.api.v1+json
|
5523
5126
|
|
5524
5127
|
|
5525
|
-
##
|
5128
|
+
## read_institution
|
5526
5129
|
|
5527
|
-
> <
|
5130
|
+
> <InstitutionResponseBody> read_institution(institution_code)
|
5528
5131
|
|
5529
|
-
Read
|
5132
|
+
Read institution
|
5530
5133
|
|
5531
|
-
This endpoint
|
5134
|
+
This endpoint returns information about the institution specified by `institution_code`.
|
5532
5135
|
|
5533
5136
|
### Examples
|
5534
5137
|
|
@@ -5543,613 +5146,32 @@ MxPlatformRuby.configure do |config|
|
|
5543
5146
|
end
|
5544
5147
|
|
5545
5148
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5546
|
-
|
5547
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5548
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5149
|
+
institution_code = 'chase' # String | The institution_code of the institution.
|
5549
5150
|
|
5550
5151
|
begin
|
5551
|
-
# Read
|
5552
|
-
result = api_instance.
|
5152
|
+
# Read institution
|
5153
|
+
result = api_instance.read_institution(institution_code)
|
5553
5154
|
p result
|
5554
5155
|
rescue MxPlatformRuby::ApiError => e
|
5555
|
-
puts "Error when calling MxPlatformApi->
|
5156
|
+
puts "Error when calling MxPlatformApi->read_institution: #{e}"
|
5556
5157
|
end
|
5557
5158
|
```
|
5558
5159
|
|
5559
|
-
#### Using the
|
5160
|
+
#### Using the read_institution_with_http_info variant
|
5560
5161
|
|
5561
5162
|
This returns an Array which contains the response data, status code and headers.
|
5562
5163
|
|
5563
|
-
> <Array(<
|
5164
|
+
> <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
|
5564
5165
|
|
5565
5166
|
```ruby
|
5566
5167
|
begin
|
5567
|
-
# Read
|
5568
|
-
data, status_code, headers = api_instance.
|
5168
|
+
# Read institution
|
5169
|
+
data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
|
5569
5170
|
p status_code # => 2xx
|
5570
5171
|
p headers # => { ... }
|
5571
|
-
p data # => <
|
5172
|
+
p data # => <InstitutionResponseBody>
|
5572
5173
|
rescue MxPlatformRuby::ApiError => e
|
5573
|
-
puts "Error when calling MxPlatformApi->
|
5574
|
-
end
|
5575
|
-
```
|
5576
|
-
|
5577
|
-
### Parameters
|
5578
|
-
|
5579
|
-
| Name | Type | Description | Notes |
|
5580
|
-
| ---- | ---- | ----------- | ----- |
|
5581
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
5582
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5583
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5584
|
-
|
5585
|
-
### Return type
|
5586
|
-
|
5587
|
-
[**AccountResponseBody**](AccountResponseBody.md)
|
5588
|
-
|
5589
|
-
### Authorization
|
5590
|
-
|
5591
|
-
[basicAuth](../README.md#basicAuth)
|
5592
|
-
|
5593
|
-
### HTTP request headers
|
5594
|
-
|
5595
|
-
- **Content-Type**: Not defined
|
5596
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5597
|
-
|
5598
|
-
|
5599
|
-
## read_category
|
5600
|
-
|
5601
|
-
> <CategoryResponseBody> read_category(category_guid, user_guid)
|
5602
|
-
|
5603
|
-
Read a custom category
|
5604
|
-
|
5605
|
-
Use this endpoint to read the attributes of either a default category or a custom category.
|
5606
|
-
|
5607
|
-
### Examples
|
5608
|
-
|
5609
|
-
```ruby
|
5610
|
-
require 'time'
|
5611
|
-
require 'mx-platform-ruby'
|
5612
|
-
# setup authorization
|
5613
|
-
MxPlatformRuby.configure do |config|
|
5614
|
-
# Configure HTTP basic authorization: basicAuth
|
5615
|
-
config.username = 'YOUR USERNAME'
|
5616
|
-
config.password = 'YOUR PASSWORD'
|
5617
|
-
end
|
5618
|
-
|
5619
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5620
|
-
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
5621
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5622
|
-
|
5623
|
-
begin
|
5624
|
-
# Read a custom category
|
5625
|
-
result = api_instance.read_category(category_guid, user_guid)
|
5626
|
-
p result
|
5627
|
-
rescue MxPlatformRuby::ApiError => e
|
5628
|
-
puts "Error when calling MxPlatformApi->read_category: #{e}"
|
5629
|
-
end
|
5630
|
-
```
|
5631
|
-
|
5632
|
-
#### Using the read_category_with_http_info variant
|
5633
|
-
|
5634
|
-
This returns an Array which contains the response data, status code and headers.
|
5635
|
-
|
5636
|
-
> <Array(<CategoryResponseBody>, Integer, Hash)> read_category_with_http_info(category_guid, user_guid)
|
5637
|
-
|
5638
|
-
```ruby
|
5639
|
-
begin
|
5640
|
-
# Read a custom category
|
5641
|
-
data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
|
5642
|
-
p status_code # => 2xx
|
5643
|
-
p headers # => { ... }
|
5644
|
-
p data # => <CategoryResponseBody>
|
5645
|
-
rescue MxPlatformRuby::ApiError => e
|
5646
|
-
puts "Error when calling MxPlatformApi->read_category_with_http_info: #{e}"
|
5647
|
-
end
|
5648
|
-
```
|
5649
|
-
|
5650
|
-
### Parameters
|
5651
|
-
|
5652
|
-
| Name | Type | Description | Notes |
|
5653
|
-
| ---- | ---- | ----------- | ----- |
|
5654
|
-
| **category_guid** | **String** | The unique id for a `category`. | |
|
5655
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5656
|
-
|
5657
|
-
### Return type
|
5658
|
-
|
5659
|
-
[**CategoryResponseBody**](CategoryResponseBody.md)
|
5660
|
-
|
5661
|
-
### Authorization
|
5662
|
-
|
5663
|
-
[basicAuth](../README.md#basicAuth)
|
5664
|
-
|
5665
|
-
### HTTP request headers
|
5666
|
-
|
5667
|
-
- **Content-Type**: Not defined
|
5668
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5669
|
-
|
5670
|
-
|
5671
|
-
## read_default_category
|
5672
|
-
|
5673
|
-
> <CategoryResponseBody> read_default_category(category_guid)
|
5674
|
-
|
5675
|
-
Read a default category
|
5676
|
-
|
5677
|
-
Use this endpoint to read the attributes of a default category.
|
5678
|
-
|
5679
|
-
### Examples
|
5680
|
-
|
5681
|
-
```ruby
|
5682
|
-
require 'time'
|
5683
|
-
require 'mx-platform-ruby'
|
5684
|
-
# setup authorization
|
5685
|
-
MxPlatformRuby.configure do |config|
|
5686
|
-
# Configure HTTP basic authorization: basicAuth
|
5687
|
-
config.username = 'YOUR USERNAME'
|
5688
|
-
config.password = 'YOUR PASSWORD'
|
5689
|
-
end
|
5690
|
-
|
5691
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5692
|
-
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
5693
|
-
|
5694
|
-
begin
|
5695
|
-
# Read a default category
|
5696
|
-
result = api_instance.read_default_category(category_guid)
|
5697
|
-
p result
|
5698
|
-
rescue MxPlatformRuby::ApiError => e
|
5699
|
-
puts "Error when calling MxPlatformApi->read_default_category: #{e}"
|
5700
|
-
end
|
5701
|
-
```
|
5702
|
-
|
5703
|
-
#### Using the read_default_category_with_http_info variant
|
5704
|
-
|
5705
|
-
This returns an Array which contains the response data, status code and headers.
|
5706
|
-
|
5707
|
-
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid)
|
5708
|
-
|
5709
|
-
```ruby
|
5710
|
-
begin
|
5711
|
-
# Read a default category
|
5712
|
-
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid)
|
5713
|
-
p status_code # => 2xx
|
5714
|
-
p headers # => { ... }
|
5715
|
-
p data # => <CategoryResponseBody>
|
5716
|
-
rescue MxPlatformRuby::ApiError => e
|
5717
|
-
puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
|
5718
|
-
end
|
5719
|
-
```
|
5720
|
-
|
5721
|
-
### Parameters
|
5722
|
-
|
5723
|
-
| Name | Type | Description | Notes |
|
5724
|
-
| ---- | ---- | ----------- | ----- |
|
5725
|
-
| **category_guid** | **String** | The unique id for a `category`. | |
|
5726
|
-
|
5727
|
-
### Return type
|
5728
|
-
|
5729
|
-
[**CategoryResponseBody**](CategoryResponseBody.md)
|
5730
|
-
|
5731
|
-
### Authorization
|
5732
|
-
|
5733
|
-
[basicAuth](../README.md#basicAuth)
|
5734
|
-
|
5735
|
-
### HTTP request headers
|
5736
|
-
|
5737
|
-
- **Content-Type**: Not defined
|
5738
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5739
|
-
|
5740
|
-
|
5741
|
-
## read_holding
|
5742
|
-
|
5743
|
-
> <HoldingResponseBody> read_holding(holding_guid, user_guid)
|
5744
|
-
|
5745
|
-
Read holding
|
5746
|
-
|
5747
|
-
Use this endpoint to read the attributes of a specific `holding`.
|
5748
|
-
|
5749
|
-
### Examples
|
5750
|
-
|
5751
|
-
```ruby
|
5752
|
-
require 'time'
|
5753
|
-
require 'mx-platform-ruby'
|
5754
|
-
# setup authorization
|
5755
|
-
MxPlatformRuby.configure do |config|
|
5756
|
-
# Configure HTTP basic authorization: basicAuth
|
5757
|
-
config.username = 'YOUR USERNAME'
|
5758
|
-
config.password = 'YOUR PASSWORD'
|
5759
|
-
end
|
5760
|
-
|
5761
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5762
|
-
holding_guid = 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2' # String | The unique id for a `holding`.
|
5763
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5764
|
-
|
5765
|
-
begin
|
5766
|
-
# Read holding
|
5767
|
-
result = api_instance.read_holding(holding_guid, user_guid)
|
5768
|
-
p result
|
5769
|
-
rescue MxPlatformRuby::ApiError => e
|
5770
|
-
puts "Error when calling MxPlatformApi->read_holding: #{e}"
|
5771
|
-
end
|
5772
|
-
```
|
5773
|
-
|
5774
|
-
#### Using the read_holding_with_http_info variant
|
5775
|
-
|
5776
|
-
This returns an Array which contains the response data, status code and headers.
|
5777
|
-
|
5778
|
-
> <Array(<HoldingResponseBody>, Integer, Hash)> read_holding_with_http_info(holding_guid, user_guid)
|
5779
|
-
|
5780
|
-
```ruby
|
5781
|
-
begin
|
5782
|
-
# Read holding
|
5783
|
-
data, status_code, headers = api_instance.read_holding_with_http_info(holding_guid, user_guid)
|
5784
|
-
p status_code # => 2xx
|
5785
|
-
p headers # => { ... }
|
5786
|
-
p data # => <HoldingResponseBody>
|
5787
|
-
rescue MxPlatformRuby::ApiError => e
|
5788
|
-
puts "Error when calling MxPlatformApi->read_holding_with_http_info: #{e}"
|
5789
|
-
end
|
5790
|
-
```
|
5791
|
-
|
5792
|
-
### Parameters
|
5793
|
-
|
5794
|
-
| Name | Type | Description | Notes |
|
5795
|
-
| ---- | ---- | ----------- | ----- |
|
5796
|
-
| **holding_guid** | **String** | The unique id for a `holding`. | |
|
5797
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5798
|
-
|
5799
|
-
### Return type
|
5800
|
-
|
5801
|
-
[**HoldingResponseBody**](HoldingResponseBody.md)
|
5802
|
-
|
5803
|
-
### Authorization
|
5804
|
-
|
5805
|
-
[basicAuth](../README.md#basicAuth)
|
5806
|
-
|
5807
|
-
### HTTP request headers
|
5808
|
-
|
5809
|
-
- **Content-Type**: Not defined
|
5810
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5811
|
-
|
5812
|
-
|
5813
|
-
## read_institution
|
5814
|
-
|
5815
|
-
> <InstitutionResponseBody> read_institution(institution_code)
|
5816
|
-
|
5817
|
-
Read institution
|
5818
|
-
|
5819
|
-
This endpoint returns information about the institution specified by `institution_code`.
|
5820
|
-
|
5821
|
-
### Examples
|
5822
|
-
|
5823
|
-
```ruby
|
5824
|
-
require 'time'
|
5825
|
-
require 'mx-platform-ruby'
|
5826
|
-
# setup authorization
|
5827
|
-
MxPlatformRuby.configure do |config|
|
5828
|
-
# Configure HTTP basic authorization: basicAuth
|
5829
|
-
config.username = 'YOUR USERNAME'
|
5830
|
-
config.password = 'YOUR PASSWORD'
|
5831
|
-
end
|
5832
|
-
|
5833
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5834
|
-
institution_code = 'chase' # String | The institution_code of the institution.
|
5835
|
-
|
5836
|
-
begin
|
5837
|
-
# Read institution
|
5838
|
-
result = api_instance.read_institution(institution_code)
|
5839
|
-
p result
|
5840
|
-
rescue MxPlatformRuby::ApiError => e
|
5841
|
-
puts "Error when calling MxPlatformApi->read_institution: #{e}"
|
5842
|
-
end
|
5843
|
-
```
|
5844
|
-
|
5845
|
-
#### Using the read_institution_with_http_info variant
|
5846
|
-
|
5847
|
-
This returns an Array which contains the response data, status code and headers.
|
5848
|
-
|
5849
|
-
> <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
|
5850
|
-
|
5851
|
-
```ruby
|
5852
|
-
begin
|
5853
|
-
# Read institution
|
5854
|
-
data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
|
5855
|
-
p status_code # => 2xx
|
5856
|
-
p headers # => { ... }
|
5857
|
-
p data # => <InstitutionResponseBody>
|
5858
|
-
rescue MxPlatformRuby::ApiError => e
|
5859
|
-
puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
|
5860
|
-
end
|
5861
|
-
```
|
5862
|
-
|
5863
|
-
### Parameters
|
5864
|
-
|
5865
|
-
| Name | Type | Description | Notes |
|
5866
|
-
| ---- | ---- | ----------- | ----- |
|
5867
|
-
| **institution_code** | **String** | The institution_code of the institution. | |
|
5868
|
-
|
5869
|
-
### Return type
|
5870
|
-
|
5871
|
-
[**InstitutionResponseBody**](InstitutionResponseBody.md)
|
5872
|
-
|
5873
|
-
### Authorization
|
5874
|
-
|
5875
|
-
[basicAuth](../README.md#basicAuth)
|
5876
|
-
|
5877
|
-
### HTTP request headers
|
5878
|
-
|
5879
|
-
- **Content-Type**: Not defined
|
5880
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5881
|
-
|
5882
|
-
|
5883
|
-
## read_managed_account
|
5884
|
-
|
5885
|
-
> <AccountResponseBody> read_managed_account(account_guid, member_guid, user_guid)
|
5886
|
-
|
5887
|
-
Read managed account
|
5888
|
-
|
5889
|
-
Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
|
5890
|
-
|
5891
|
-
### Examples
|
5892
|
-
|
5893
|
-
```ruby
|
5894
|
-
require 'time'
|
5895
|
-
require 'mx-platform-ruby'
|
5896
|
-
# setup authorization
|
5897
|
-
MxPlatformRuby.configure do |config|
|
5898
|
-
# Configure HTTP basic authorization: basicAuth
|
5899
|
-
config.username = 'YOUR USERNAME'
|
5900
|
-
config.password = 'YOUR PASSWORD'
|
5901
|
-
end
|
5902
|
-
|
5903
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5904
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5905
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5906
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5907
|
-
|
5908
|
-
begin
|
5909
|
-
# Read managed account
|
5910
|
-
result = api_instance.read_managed_account(account_guid, member_guid, user_guid)
|
5911
|
-
p result
|
5912
|
-
rescue MxPlatformRuby::ApiError => e
|
5913
|
-
puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
|
5914
|
-
end
|
5915
|
-
```
|
5916
|
-
|
5917
|
-
#### Using the read_managed_account_with_http_info variant
|
5918
|
-
|
5919
|
-
This returns an Array which contains the response data, status code and headers.
|
5920
|
-
|
5921
|
-
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
5922
|
-
|
5923
|
-
```ruby
|
5924
|
-
begin
|
5925
|
-
# Read managed account
|
5926
|
-
data, status_code, headers = api_instance.read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
5927
|
-
p status_code # => 2xx
|
5928
|
-
p headers # => { ... }
|
5929
|
-
p data # => <AccountResponseBody>
|
5930
|
-
rescue MxPlatformRuby::ApiError => e
|
5931
|
-
puts "Error when calling MxPlatformApi->read_managed_account_with_http_info: #{e}"
|
5932
|
-
end
|
5933
|
-
```
|
5934
|
-
|
5935
|
-
### Parameters
|
5936
|
-
|
5937
|
-
| Name | Type | Description | Notes |
|
5938
|
-
| ---- | ---- | ----------- | ----- |
|
5939
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
5940
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5941
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5942
|
-
|
5943
|
-
### Return type
|
5944
|
-
|
5945
|
-
[**AccountResponseBody**](AccountResponseBody.md)
|
5946
|
-
|
5947
|
-
### Authorization
|
5948
|
-
|
5949
|
-
[basicAuth](../README.md#basicAuth)
|
5950
|
-
|
5951
|
-
### HTTP request headers
|
5952
|
-
|
5953
|
-
- **Content-Type**: Not defined
|
5954
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5955
|
-
|
5956
|
-
|
5957
|
-
## read_managed_member
|
5958
|
-
|
5959
|
-
> <MemberResponseBody> read_managed_member(member_guid, user_guid)
|
5960
|
-
|
5961
|
-
Read managed member
|
5962
|
-
|
5963
|
-
This endpoint returns the attributes of the specified partner-managed `member`.
|
5964
|
-
|
5965
|
-
### Examples
|
5966
|
-
|
5967
|
-
```ruby
|
5968
|
-
require 'time'
|
5969
|
-
require 'mx-platform-ruby'
|
5970
|
-
# setup authorization
|
5971
|
-
MxPlatformRuby.configure do |config|
|
5972
|
-
# Configure HTTP basic authorization: basicAuth
|
5973
|
-
config.username = 'YOUR USERNAME'
|
5974
|
-
config.password = 'YOUR PASSWORD'
|
5975
|
-
end
|
5976
|
-
|
5977
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5978
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5979
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5980
|
-
|
5981
|
-
begin
|
5982
|
-
# Read managed member
|
5983
|
-
result = api_instance.read_managed_member(member_guid, user_guid)
|
5984
|
-
p result
|
5985
|
-
rescue MxPlatformRuby::ApiError => e
|
5986
|
-
puts "Error when calling MxPlatformApi->read_managed_member: #{e}"
|
5987
|
-
end
|
5988
|
-
```
|
5989
|
-
|
5990
|
-
#### Using the read_managed_member_with_http_info variant
|
5991
|
-
|
5992
|
-
This returns an Array which contains the response data, status code and headers.
|
5993
|
-
|
5994
|
-
> <Array(<MemberResponseBody>, Integer, Hash)> read_managed_member_with_http_info(member_guid, user_guid)
|
5995
|
-
|
5996
|
-
```ruby
|
5997
|
-
begin
|
5998
|
-
# Read managed member
|
5999
|
-
data, status_code, headers = api_instance.read_managed_member_with_http_info(member_guid, user_guid)
|
6000
|
-
p status_code # => 2xx
|
6001
|
-
p headers # => { ... }
|
6002
|
-
p data # => <MemberResponseBody>
|
6003
|
-
rescue MxPlatformRuby::ApiError => e
|
6004
|
-
puts "Error when calling MxPlatformApi->read_managed_member_with_http_info: #{e}"
|
6005
|
-
end
|
6006
|
-
```
|
6007
|
-
|
6008
|
-
### Parameters
|
6009
|
-
|
6010
|
-
| Name | Type | Description | Notes |
|
6011
|
-
| ---- | ---- | ----------- | ----- |
|
6012
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
6013
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
6014
|
-
|
6015
|
-
### Return type
|
6016
|
-
|
6017
|
-
[**MemberResponseBody**](MemberResponseBody.md)
|
6018
|
-
|
6019
|
-
### Authorization
|
6020
|
-
|
6021
|
-
[basicAuth](../README.md#basicAuth)
|
6022
|
-
|
6023
|
-
### HTTP request headers
|
6024
|
-
|
6025
|
-
- **Content-Type**: Not defined
|
6026
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
6027
|
-
|
6028
|
-
|
6029
|
-
## read_managed_transaction
|
6030
|
-
|
6031
|
-
> <TransactionResponseBody> read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
6032
|
-
|
6033
|
-
Read managed transaction
|
6034
|
-
|
6035
|
-
Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
|
6036
|
-
|
6037
|
-
### Examples
|
6038
|
-
|
6039
|
-
```ruby
|
6040
|
-
require 'time'
|
6041
|
-
require 'mx-platform-ruby'
|
6042
|
-
# setup authorization
|
6043
|
-
MxPlatformRuby.configure do |config|
|
6044
|
-
# Configure HTTP basic authorization: basicAuth
|
6045
|
-
config.username = 'YOUR USERNAME'
|
6046
|
-
config.password = 'YOUR PASSWORD'
|
6047
|
-
end
|
6048
|
-
|
6049
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6050
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
6051
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6052
|
-
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
6053
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6054
|
-
|
6055
|
-
begin
|
6056
|
-
# Read managed transaction
|
6057
|
-
result = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
6058
|
-
p result
|
6059
|
-
rescue MxPlatformRuby::ApiError => e
|
6060
|
-
puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
|
6061
|
-
end
|
6062
|
-
```
|
6063
|
-
|
6064
|
-
#### Using the read_managed_transaction_with_http_info variant
|
6065
|
-
|
6066
|
-
This returns an Array which contains the response data, status code and headers.
|
6067
|
-
|
6068
|
-
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
6069
|
-
|
6070
|
-
```ruby
|
6071
|
-
begin
|
6072
|
-
# Read managed transaction
|
6073
|
-
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
6074
|
-
p status_code # => 2xx
|
6075
|
-
p headers # => { ... }
|
6076
|
-
p data # => <TransactionResponseBody>
|
6077
|
-
rescue MxPlatformRuby::ApiError => e
|
6078
|
-
puts "Error when calling MxPlatformApi->read_managed_transaction_with_http_info: #{e}"
|
6079
|
-
end
|
6080
|
-
```
|
6081
|
-
|
6082
|
-
### Parameters
|
6083
|
-
|
6084
|
-
| Name | Type | Description | Notes |
|
6085
|
-
| ---- | ---- | ----------- | ----- |
|
6086
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
6087
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
6088
|
-
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
6089
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
6090
|
-
|
6091
|
-
### Return type
|
6092
|
-
|
6093
|
-
[**TransactionResponseBody**](TransactionResponseBody.md)
|
6094
|
-
|
6095
|
-
### Authorization
|
6096
|
-
|
6097
|
-
[basicAuth](../README.md#basicAuth)
|
6098
|
-
|
6099
|
-
### HTTP request headers
|
6100
|
-
|
6101
|
-
- **Content-Type**: Not defined
|
6102
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
6103
|
-
|
6104
|
-
|
6105
|
-
## read_member
|
6106
|
-
|
6107
|
-
> <MemberResponseBody> read_member(member_guid, user_guid)
|
6108
|
-
|
6109
|
-
Read member
|
6110
|
-
|
6111
|
-
Use this endpoint to read the attributes of a specific member.
|
6112
|
-
|
6113
|
-
### Examples
|
6114
|
-
|
6115
|
-
```ruby
|
6116
|
-
require 'time'
|
6117
|
-
require 'mx-platform-ruby'
|
6118
|
-
# setup authorization
|
6119
|
-
MxPlatformRuby.configure do |config|
|
6120
|
-
# Configure HTTP basic authorization: basicAuth
|
6121
|
-
config.username = 'YOUR USERNAME'
|
6122
|
-
config.password = 'YOUR PASSWORD'
|
6123
|
-
end
|
6124
|
-
|
6125
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6126
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6127
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6128
|
-
|
6129
|
-
begin
|
6130
|
-
# Read member
|
6131
|
-
result = api_instance.read_member(member_guid, user_guid)
|
6132
|
-
p result
|
6133
|
-
rescue MxPlatformRuby::ApiError => e
|
6134
|
-
puts "Error when calling MxPlatformApi->read_member: #{e}"
|
6135
|
-
end
|
6136
|
-
```
|
6137
|
-
|
6138
|
-
#### Using the read_member_with_http_info variant
|
6139
|
-
|
6140
|
-
This returns an Array which contains the response data, status code and headers.
|
6141
|
-
|
6142
|
-
> <Array(<MemberResponseBody>, Integer, Hash)> read_member_with_http_info(member_guid, user_guid)
|
6143
|
-
|
6144
|
-
```ruby
|
6145
|
-
begin
|
6146
|
-
# Read member
|
6147
|
-
data, status_code, headers = api_instance.read_member_with_http_info(member_guid, user_guid)
|
6148
|
-
p status_code # => 2xx
|
6149
|
-
p headers # => { ... }
|
6150
|
-
p data # => <MemberResponseBody>
|
6151
|
-
rescue MxPlatformRuby::ApiError => e
|
6152
|
-
puts "Error when calling MxPlatformApi->read_member_with_http_info: #{e}"
|
5174
|
+
puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
|
6153
5175
|
end
|
6154
5176
|
```
|
6155
5177
|
|
@@ -6157,12 +5179,11 @@ end
|
|
6157
5179
|
|
6158
5180
|
| Name | Type | Description | Notes |
|
6159
5181
|
| ---- | ---- | ----------- | ----- |
|
6160
|
-
| **
|
6161
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
5182
|
+
| **institution_code** | **String** | The institution_code of the institution. | |
|
6162
5183
|
|
6163
5184
|
### Return type
|
6164
5185
|
|
6165
|
-
[**
|
5186
|
+
[**InstitutionResponseBody**](InstitutionResponseBody.md)
|
6166
5187
|
|
6167
5188
|
### Authorization
|
6168
5189
|
|
@@ -6174,13 +5195,13 @@ end
|
|
6174
5195
|
- **Accept**: application/vnd.mx.api.v1+json
|
6175
5196
|
|
6176
5197
|
|
6177
|
-
##
|
5198
|
+
## read_managed_account
|
6178
5199
|
|
6179
|
-
> <
|
5200
|
+
> <AccountResponseBody> read_managed_account(account_guid, member_guid, user_guid)
|
6180
5201
|
|
6181
|
-
Read
|
5202
|
+
Read managed account
|
6182
5203
|
|
6183
|
-
|
5204
|
+
Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
|
6184
5205
|
|
6185
5206
|
### Examples
|
6186
5207
|
|
@@ -6195,33 +5216,34 @@ MxPlatformRuby.configure do |config|
|
|
6195
5216
|
end
|
6196
5217
|
|
6197
5218
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5219
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
6198
5220
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6199
5221
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6200
5222
|
|
6201
5223
|
begin
|
6202
|
-
# Read
|
6203
|
-
result = api_instance.
|
5224
|
+
# Read managed account
|
5225
|
+
result = api_instance.read_managed_account(account_guid, member_guid, user_guid)
|
6204
5226
|
p result
|
6205
5227
|
rescue MxPlatformRuby::ApiError => e
|
6206
|
-
puts "Error when calling MxPlatformApi->
|
5228
|
+
puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
|
6207
5229
|
end
|
6208
5230
|
```
|
6209
5231
|
|
6210
|
-
#### Using the
|
5232
|
+
#### Using the read_managed_account_with_http_info variant
|
6211
5233
|
|
6212
5234
|
This returns an Array which contains the response data, status code and headers.
|
6213
5235
|
|
6214
|
-
> <Array(<
|
5236
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
6215
5237
|
|
6216
5238
|
```ruby
|
6217
5239
|
begin
|
6218
|
-
# Read
|
6219
|
-
data, status_code, headers = api_instance.
|
5240
|
+
# Read managed account
|
5241
|
+
data, status_code, headers = api_instance.read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
6220
5242
|
p status_code # => 2xx
|
6221
5243
|
p headers # => { ... }
|
6222
|
-
p data # => <
|
5244
|
+
p data # => <AccountResponseBody>
|
6223
5245
|
rescue MxPlatformRuby::ApiError => e
|
6224
|
-
puts "Error when calling MxPlatformApi->
|
5246
|
+
puts "Error when calling MxPlatformApi->read_managed_account_with_http_info: #{e}"
|
6225
5247
|
end
|
6226
5248
|
```
|
6227
5249
|
|
@@ -6229,12 +5251,13 @@ end
|
|
6229
5251
|
|
6230
5252
|
| Name | Type | Description | Notes |
|
6231
5253
|
| ---- | ---- | ----------- | ----- |
|
5254
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
6232
5255
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
6233
5256
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
6234
5257
|
|
6235
5258
|
### Return type
|
6236
5259
|
|
6237
|
-
[**
|
5260
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
6238
5261
|
|
6239
5262
|
### Authorization
|
6240
5263
|
|
@@ -6246,13 +5269,13 @@ end
|
|
6246
5269
|
- **Accept**: application/vnd.mx.api.v1+json
|
6247
5270
|
|
6248
5271
|
|
6249
|
-
##
|
5272
|
+
## read_managed_member
|
6250
5273
|
|
6251
|
-
> <
|
5274
|
+
> <MemberResponseBody> read_managed_member(member_guid, user_guid)
|
6252
5275
|
|
6253
|
-
Read
|
5276
|
+
Read managed member
|
6254
5277
|
|
6255
|
-
|
5278
|
+
This endpoint returns the attributes of the specified partner-managed `member`.
|
6256
5279
|
|
6257
5280
|
### Examples
|
6258
5281
|
|
@@ -6267,32 +5290,33 @@ MxPlatformRuby.configure do |config|
|
|
6267
5290
|
end
|
6268
5291
|
|
6269
5292
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6270
|
-
|
5293
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5294
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6271
5295
|
|
6272
5296
|
begin
|
6273
|
-
# Read
|
6274
|
-
result = api_instance.
|
5297
|
+
# Read managed member
|
5298
|
+
result = api_instance.read_managed_member(member_guid, user_guid)
|
6275
5299
|
p result
|
6276
5300
|
rescue MxPlatformRuby::ApiError => e
|
6277
|
-
puts "Error when calling MxPlatformApi->
|
5301
|
+
puts "Error when calling MxPlatformApi->read_managed_member: #{e}"
|
6278
5302
|
end
|
6279
5303
|
```
|
6280
5304
|
|
6281
|
-
#### Using the
|
5305
|
+
#### Using the read_managed_member_with_http_info variant
|
6282
5306
|
|
6283
5307
|
This returns an Array which contains the response data, status code and headers.
|
6284
5308
|
|
6285
|
-
> <Array(<
|
5309
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> read_managed_member_with_http_info(member_guid, user_guid)
|
6286
5310
|
|
6287
5311
|
```ruby
|
6288
5312
|
begin
|
6289
|
-
# Read
|
6290
|
-
data, status_code, headers = api_instance.
|
5313
|
+
# Read managed member
|
5314
|
+
data, status_code, headers = api_instance.read_managed_member_with_http_info(member_guid, user_guid)
|
6291
5315
|
p status_code # => 2xx
|
6292
5316
|
p headers # => { ... }
|
6293
|
-
p data # => <
|
5317
|
+
p data # => <MemberResponseBody>
|
6294
5318
|
rescue MxPlatformRuby::ApiError => e
|
6295
|
-
puts "Error when calling MxPlatformApi->
|
5319
|
+
puts "Error when calling MxPlatformApi->read_managed_member_with_http_info: #{e}"
|
6296
5320
|
end
|
6297
5321
|
```
|
6298
5322
|
|
@@ -6300,11 +5324,12 @@ end
|
|
6300
5324
|
|
6301
5325
|
| Name | Type | Description | Notes |
|
6302
5326
|
| ---- | ---- | ----------- | ----- |
|
6303
|
-
| **
|
5327
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
5328
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
6304
5329
|
|
6305
5330
|
### Return type
|
6306
5331
|
|
6307
|
-
[**
|
5332
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
6308
5333
|
|
6309
5334
|
### Authorization
|
6310
5335
|
|
@@ -6316,13 +5341,13 @@ end
|
|
6316
5341
|
- **Accept**: application/vnd.mx.api.v1+json
|
6317
5342
|
|
6318
5343
|
|
6319
|
-
##
|
5344
|
+
## read_managed_transaction
|
6320
5345
|
|
6321
|
-
> <
|
5346
|
+
> <TransactionResponseBody> read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
6322
5347
|
|
6323
|
-
Read
|
5348
|
+
Read managed transaction
|
6324
5349
|
|
6325
|
-
|
5350
|
+
Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
|
6326
5351
|
|
6327
5352
|
### Examples
|
6328
5353
|
|
@@ -6337,32 +5362,35 @@ MxPlatformRuby.configure do |config|
|
|
6337
5362
|
end
|
6338
5363
|
|
6339
5364
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6340
|
-
|
5365
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5366
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5367
|
+
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
5368
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6341
5369
|
|
6342
5370
|
begin
|
6343
|
-
# Read
|
6344
|
-
result = api_instance.
|
5371
|
+
# Read managed transaction
|
5372
|
+
result = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
6345
5373
|
p result
|
6346
5374
|
rescue MxPlatformRuby::ApiError => e
|
6347
|
-
puts "Error when calling MxPlatformApi->
|
5375
|
+
puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
|
6348
5376
|
end
|
6349
5377
|
```
|
6350
5378
|
|
6351
|
-
#### Using the
|
5379
|
+
#### Using the read_managed_transaction_with_http_info variant
|
6352
5380
|
|
6353
5381
|
This returns an Array which contains the response data, status code and headers.
|
6354
5382
|
|
6355
|
-
> <Array(<
|
5383
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
6356
5384
|
|
6357
5385
|
```ruby
|
6358
5386
|
begin
|
6359
|
-
# Read
|
6360
|
-
data, status_code, headers = api_instance.
|
5387
|
+
# Read managed transaction
|
5388
|
+
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
6361
5389
|
p status_code # => 2xx
|
6362
5390
|
p headers # => { ... }
|
6363
|
-
p data # => <
|
5391
|
+
p data # => <TransactionResponseBody>
|
6364
5392
|
rescue MxPlatformRuby::ApiError => e
|
6365
|
-
puts "Error when calling MxPlatformApi->
|
5393
|
+
puts "Error when calling MxPlatformApi->read_managed_transaction_with_http_info: #{e}"
|
6366
5394
|
end
|
6367
5395
|
```
|
6368
5396
|
|
@@ -6370,11 +5398,14 @@ end
|
|
6370
5398
|
|
6371
5399
|
| Name | Type | Description | Notes |
|
6372
5400
|
| ---- | ---- | ----------- | ----- |
|
6373
|
-
| **
|
5401
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
5402
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
5403
|
+
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
5404
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
6374
5405
|
|
6375
5406
|
### Return type
|
6376
5407
|
|
6377
|
-
[**
|
5408
|
+
[**TransactionResponseBody**](TransactionResponseBody.md)
|
6378
5409
|
|
6379
5410
|
### Authorization
|
6380
5411
|
|
@@ -6386,13 +5417,13 @@ end
|
|
6386
5417
|
- **Accept**: application/vnd.mx.api.v1+json
|
6387
5418
|
|
6388
5419
|
|
6389
|
-
##
|
5420
|
+
## read_member
|
6390
5421
|
|
6391
|
-
> <
|
5422
|
+
> <MemberResponseBody> read_member(member_guid, user_guid)
|
6392
5423
|
|
6393
|
-
Read
|
5424
|
+
Read member
|
6394
5425
|
|
6395
|
-
Use this endpoint to read the attributes of a specific
|
5426
|
+
Use this endpoint to read the attributes of a specific member.
|
6396
5427
|
|
6397
5428
|
### Examples
|
6398
5429
|
|
@@ -6407,38 +5438,33 @@ MxPlatformRuby.configure do |config|
|
|
6407
5438
|
end
|
6408
5439
|
|
6409
5440
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5441
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6410
5442
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6411
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
6412
|
-
spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # String | The unique ID for the specified account.
|
6413
|
-
opts = {
|
6414
|
-
page: 1, # Integer | Specify current page.
|
6415
|
-
records_per_page: 10 # Integer | Specify records per page.
|
6416
|
-
}
|
6417
5443
|
|
6418
5444
|
begin
|
6419
|
-
# Read
|
6420
|
-
result = api_instance.
|
5445
|
+
# Read member
|
5446
|
+
result = api_instance.read_member(member_guid, user_guid)
|
6421
5447
|
p result
|
6422
5448
|
rescue MxPlatformRuby::ApiError => e
|
6423
|
-
puts "Error when calling MxPlatformApi->
|
5449
|
+
puts "Error when calling MxPlatformApi->read_member: #{e}"
|
6424
5450
|
end
|
6425
5451
|
```
|
6426
5452
|
|
6427
|
-
#### Using the
|
5453
|
+
#### Using the read_member_with_http_info variant
|
6428
5454
|
|
6429
5455
|
This returns an Array which contains the response data, status code and headers.
|
6430
5456
|
|
6431
|
-
> <Array(<
|
5457
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> read_member_with_http_info(member_guid, user_guid)
|
6432
5458
|
|
6433
5459
|
```ruby
|
6434
5460
|
begin
|
6435
|
-
# Read
|
6436
|
-
data, status_code, headers = api_instance.
|
5461
|
+
# Read member
|
5462
|
+
data, status_code, headers = api_instance.read_member_with_http_info(member_guid, user_guid)
|
6437
5463
|
p status_code # => 2xx
|
6438
5464
|
p headers # => { ... }
|
6439
|
-
p data # => <
|
5465
|
+
p data # => <MemberResponseBody>
|
6440
5466
|
rescue MxPlatformRuby::ApiError => e
|
6441
|
-
puts "Error when calling MxPlatformApi->
|
5467
|
+
puts "Error when calling MxPlatformApi->read_member_with_http_info: #{e}"
|
6442
5468
|
end
|
6443
5469
|
```
|
6444
5470
|
|
@@ -6446,15 +5472,12 @@ end
|
|
6446
5472
|
|
6447
5473
|
| Name | Type | Description | Notes |
|
6448
5474
|
| ---- | ---- | ----------- | ----- |
|
5475
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
6449
5476
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
6450
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
6451
|
-
| **spending_plan_account_guid** | **String** | The unique ID for the specified account. | |
|
6452
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
6453
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
6454
5477
|
|
6455
5478
|
### Return type
|
6456
5479
|
|
6457
|
-
[**
|
5480
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
6458
5481
|
|
6459
5482
|
### Authorization
|
6460
5483
|
|
@@ -6466,13 +5489,13 @@ end
|
|
6466
5489
|
- **Accept**: application/vnd.mx.api.v1+json
|
6467
5490
|
|
6468
5491
|
|
6469
|
-
##
|
5492
|
+
## read_member_status
|
6470
5493
|
|
6471
|
-
> <
|
5494
|
+
> <MemberStatusResponseBody> read_member_status(member_guid, user_guid)
|
6472
5495
|
|
6473
|
-
Read
|
5496
|
+
Read member status
|
6474
5497
|
|
6475
|
-
|
5498
|
+
This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
|
6476
5499
|
|
6477
5500
|
### Examples
|
6478
5501
|
|
@@ -6487,38 +5510,33 @@ MxPlatformRuby.configure do |config|
|
|
6487
5510
|
end
|
6488
5511
|
|
6489
5512
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5513
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
6490
5514
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6491
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
6492
|
-
iteration_number = 1 # Integer | The current iteration number for the spending plan `iteration``.
|
6493
|
-
opts = {
|
6494
|
-
page: 1, # Integer | Specify current page.
|
6495
|
-
records_per_page: 10 # Integer | Specify records per page.
|
6496
|
-
}
|
6497
5515
|
|
6498
5516
|
begin
|
6499
|
-
# Read
|
6500
|
-
result = api_instance.
|
5517
|
+
# Read member status
|
5518
|
+
result = api_instance.read_member_status(member_guid, user_guid)
|
6501
5519
|
p result
|
6502
5520
|
rescue MxPlatformRuby::ApiError => e
|
6503
|
-
puts "Error when calling MxPlatformApi->
|
5521
|
+
puts "Error when calling MxPlatformApi->read_member_status: #{e}"
|
6504
5522
|
end
|
6505
5523
|
```
|
6506
5524
|
|
6507
|
-
#### Using the
|
5525
|
+
#### Using the read_member_status_with_http_info variant
|
6508
5526
|
|
6509
5527
|
This returns an Array which contains the response data, status code and headers.
|
6510
5528
|
|
6511
|
-
> <Array(<
|
5529
|
+
> <Array(<MemberStatusResponseBody>, Integer, Hash)> read_member_status_with_http_info(member_guid, user_guid)
|
6512
5530
|
|
6513
5531
|
```ruby
|
6514
5532
|
begin
|
6515
|
-
# Read
|
6516
|
-
data, status_code, headers = api_instance.
|
5533
|
+
# Read member status
|
5534
|
+
data, status_code, headers = api_instance.read_member_status_with_http_info(member_guid, user_guid)
|
6517
5535
|
p status_code # => 2xx
|
6518
5536
|
p headers # => { ... }
|
6519
|
-
p data # => <
|
5537
|
+
p data # => <MemberStatusResponseBody>
|
6520
5538
|
rescue MxPlatformRuby::ApiError => e
|
6521
|
-
puts "Error when calling MxPlatformApi->
|
5539
|
+
puts "Error when calling MxPlatformApi->read_member_status_with_http_info: #{e}"
|
6522
5540
|
end
|
6523
5541
|
```
|
6524
5542
|
|
@@ -6526,15 +5544,12 @@ end
|
|
6526
5544
|
|
6527
5545
|
| Name | Type | Description | Notes |
|
6528
5546
|
| ---- | ---- | ----------- | ----- |
|
5547
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
6529
5548
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
6530
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
6531
|
-
| **iteration_number** | **Integer** | The current iteration number for the spending plan `iteration``. | |
|
6532
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
6533
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
6534
5549
|
|
6535
5550
|
### Return type
|
6536
5551
|
|
6537
|
-
[**
|
5552
|
+
[**MemberStatusResponseBody**](MemberStatusResponseBody.md)
|
6538
5553
|
|
6539
5554
|
### Authorization
|
6540
5555
|
|
@@ -6546,13 +5561,13 @@ end
|
|
6546
5561
|
- **Accept**: application/vnd.mx.api.v1+json
|
6547
5562
|
|
6548
5563
|
|
6549
|
-
##
|
5564
|
+
## read_merchant
|
6550
5565
|
|
6551
|
-
> <
|
5566
|
+
> <MerchantResponseBody> read_merchant(merchant_guid)
|
6552
5567
|
|
6553
|
-
Read
|
5568
|
+
Read merchant
|
6554
5569
|
|
6555
|
-
|
5570
|
+
Returns information about a particular merchant, such as a logo, name, and website.
|
6556
5571
|
|
6557
5572
|
### Examples
|
6558
5573
|
|
@@ -6567,38 +5582,32 @@ MxPlatformRuby.configure do |config|
|
|
6567
5582
|
end
|
6568
5583
|
|
6569
5584
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6570
|
-
|
6571
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
6572
|
-
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
6573
|
-
opts = {
|
6574
|
-
page: 1, # Integer | Specify current page.
|
6575
|
-
records_per_page: 10 # Integer | Specify records per page.
|
6576
|
-
}
|
5585
|
+
merchant_guid = 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b' # String | The unique id for a `merchant`.
|
6577
5586
|
|
6578
5587
|
begin
|
6579
|
-
# Read
|
6580
|
-
result = api_instance.
|
5588
|
+
# Read merchant
|
5589
|
+
result = api_instance.read_merchant(merchant_guid)
|
6581
5590
|
p result
|
6582
5591
|
rescue MxPlatformRuby::ApiError => e
|
6583
|
-
puts "Error when calling MxPlatformApi->
|
5592
|
+
puts "Error when calling MxPlatformApi->read_merchant: #{e}"
|
6584
5593
|
end
|
6585
5594
|
```
|
6586
5595
|
|
6587
|
-
#### Using the
|
5596
|
+
#### Using the read_merchant_with_http_info variant
|
6588
5597
|
|
6589
5598
|
This returns an Array which contains the response data, status code and headers.
|
6590
5599
|
|
6591
|
-
> <Array(<
|
5600
|
+
> <Array(<MerchantResponseBody>, Integer, Hash)> read_merchant_with_http_info(merchant_guid)
|
6592
5601
|
|
6593
5602
|
```ruby
|
6594
5603
|
begin
|
6595
|
-
# Read
|
6596
|
-
data, status_code, headers = api_instance.
|
5604
|
+
# Read merchant
|
5605
|
+
data, status_code, headers = api_instance.read_merchant_with_http_info(merchant_guid)
|
6597
5606
|
p status_code # => 2xx
|
6598
5607
|
p headers # => { ... }
|
6599
|
-
p data # => <
|
5608
|
+
p data # => <MerchantResponseBody>
|
6600
5609
|
rescue MxPlatformRuby::ApiError => e
|
6601
|
-
puts "Error when calling MxPlatformApi->
|
5610
|
+
puts "Error when calling MxPlatformApi->read_merchant_with_http_info: #{e}"
|
6602
5611
|
end
|
6603
5612
|
```
|
6604
5613
|
|
@@ -6606,15 +5615,11 @@ end
|
|
6606
5615
|
|
6607
5616
|
| Name | Type | Description | Notes |
|
6608
5617
|
| ---- | ---- | ----------- | ----- |
|
6609
|
-
| **
|
6610
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
6611
|
-
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
6612
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
6613
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5618
|
+
| **merchant_guid** | **String** | The unique id for a `merchant`. | |
|
6614
5619
|
|
6615
5620
|
### Return type
|
6616
5621
|
|
6617
|
-
[**
|
5622
|
+
[**MerchantResponseBody**](MerchantResponseBody.md)
|
6618
5623
|
|
6619
5624
|
### Authorization
|
6620
5625
|
|
@@ -6626,13 +5631,13 @@ end
|
|
6626
5631
|
- **Accept**: application/vnd.mx.api.v1+json
|
6627
5632
|
|
6628
5633
|
|
6629
|
-
##
|
5634
|
+
## read_merchant_location
|
6630
5635
|
|
6631
|
-
> <
|
5636
|
+
> <MerchantLocationResponseBody> read_merchant_location(merchant_location_guid)
|
6632
5637
|
|
6633
|
-
Read
|
5638
|
+
Read merchant location
|
6634
5639
|
|
6635
|
-
|
5640
|
+
This endpoint returns the specified merchant_location resource.
|
6636
5641
|
|
6637
5642
|
### Examples
|
6638
5643
|
|
@@ -6647,37 +5652,32 @@ MxPlatformRuby.configure do |config|
|
|
6647
5652
|
end
|
6648
5653
|
|
6649
5654
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6650
|
-
|
6651
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
6652
|
-
opts = {
|
6653
|
-
page: 1, # Integer | Specify current page.
|
6654
|
-
records_per_page: 10 # Integer | Specify records per page.
|
6655
|
-
}
|
5655
|
+
merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # String | The unique id for a `merchant_location`.
|
6656
5656
|
|
6657
5657
|
begin
|
6658
|
-
# Read
|
6659
|
-
result = api_instance.
|
5658
|
+
# Read merchant location
|
5659
|
+
result = api_instance.read_merchant_location(merchant_location_guid)
|
6660
5660
|
p result
|
6661
5661
|
rescue MxPlatformRuby::ApiError => e
|
6662
|
-
puts "Error when calling MxPlatformApi->
|
5662
|
+
puts "Error when calling MxPlatformApi->read_merchant_location: #{e}"
|
6663
5663
|
end
|
6664
5664
|
```
|
6665
5665
|
|
6666
|
-
#### Using the
|
5666
|
+
#### Using the read_merchant_location_with_http_info variant
|
6667
5667
|
|
6668
5668
|
This returns an Array which contains the response data, status code and headers.
|
6669
5669
|
|
6670
|
-
> <Array(<
|
5670
|
+
> <Array(<MerchantLocationResponseBody>, Integer, Hash)> read_merchant_location_with_http_info(merchant_location_guid)
|
6671
5671
|
|
6672
5672
|
```ruby
|
6673
5673
|
begin
|
6674
|
-
# Read
|
6675
|
-
data, status_code, headers = api_instance.
|
5674
|
+
# Read merchant location
|
5675
|
+
data, status_code, headers = api_instance.read_merchant_location_with_http_info(merchant_location_guid)
|
6676
5676
|
p status_code # => 2xx
|
6677
5677
|
p headers # => { ... }
|
6678
|
-
p data # => <
|
5678
|
+
p data # => <MerchantLocationResponseBody>
|
6679
5679
|
rescue MxPlatformRuby::ApiError => e
|
6680
|
-
puts "Error when calling MxPlatformApi->
|
5680
|
+
puts "Error when calling MxPlatformApi->read_merchant_location_with_http_info: #{e}"
|
6681
5681
|
end
|
6682
5682
|
```
|
6683
5683
|
|
@@ -6685,14 +5685,11 @@ end
|
|
6685
5685
|
|
6686
5686
|
| Name | Type | Description | Notes |
|
6687
5687
|
| ---- | ---- | ----------- | ----- |
|
6688
|
-
| **
|
6689
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
6690
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
6691
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5688
|
+
| **merchant_location_guid** | **String** | The unique id for a `merchant_location`. | |
|
6692
5689
|
|
6693
5690
|
### Return type
|
6694
5691
|
|
6695
|
-
[**
|
5692
|
+
[**MerchantLocationResponseBody**](MerchantLocationResponseBody.md)
|
6696
5693
|
|
6697
5694
|
### Authorization
|
6698
5695
|
|
@@ -8038,82 +7035,6 @@ end
|
|
8038
7035
|
- **Accept**: application/vnd.mx.api.v1+json
|
8039
7036
|
|
8040
7037
|
|
8041
|
-
## update_spending_plan_iteration_item
|
8042
|
-
|
8043
|
-
> <SpendingPlanIterationItemResponse> update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
8044
|
-
|
8045
|
-
Update a spending plan iteration item
|
8046
|
-
|
8047
|
-
Use this endpoint to update an existing `spending_plan_iteration_item`.
|
8048
|
-
|
8049
|
-
### Examples
|
8050
|
-
|
8051
|
-
```ruby
|
8052
|
-
require 'time'
|
8053
|
-
require 'mx-platform-ruby'
|
8054
|
-
# setup authorization
|
8055
|
-
MxPlatformRuby.configure do |config|
|
8056
|
-
# Configure HTTP basic authorization: basicAuth
|
8057
|
-
config.username = 'YOUR USERNAME'
|
8058
|
-
config.password = 'YOUR PASSWORD'
|
8059
|
-
end
|
8060
|
-
|
8061
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
8062
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
8063
|
-
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
8064
|
-
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
8065
|
-
spending_plan_iteration_item_create_request_body = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new({planned_amount: 110}) # SpendingPlanIterationItemCreateRequestBody | Iteration item object to be updated with required parameter (iteration_item_guid)
|
8066
|
-
|
8067
|
-
begin
|
8068
|
-
# Update a spending plan iteration item
|
8069
|
-
result = api_instance.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
8070
|
-
p result
|
8071
|
-
rescue MxPlatformRuby::ApiError => e
|
8072
|
-
puts "Error when calling MxPlatformApi->update_spending_plan_iteration_item: #{e}"
|
8073
|
-
end
|
8074
|
-
```
|
8075
|
-
|
8076
|
-
#### Using the update_spending_plan_iteration_item_with_http_info variant
|
8077
|
-
|
8078
|
-
This returns an Array which contains the response data, status code and headers.
|
8079
|
-
|
8080
|
-
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
8081
|
-
|
8082
|
-
```ruby
|
8083
|
-
begin
|
8084
|
-
# Update a spending plan iteration item
|
8085
|
-
data, status_code, headers = api_instance.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
8086
|
-
p status_code # => 2xx
|
8087
|
-
p headers # => { ... }
|
8088
|
-
p data # => <SpendingPlanIterationItemResponse>
|
8089
|
-
rescue MxPlatformRuby::ApiError => e
|
8090
|
-
puts "Error when calling MxPlatformApi->update_spending_plan_iteration_item_with_http_info: #{e}"
|
8091
|
-
end
|
8092
|
-
```
|
8093
|
-
|
8094
|
-
### Parameters
|
8095
|
-
|
8096
|
-
| Name | Type | Description | Notes |
|
8097
|
-
| ---- | ---- | ----------- | ----- |
|
8098
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
8099
|
-
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
8100
|
-
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
8101
|
-
| **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md) | Iteration item object to be updated with required parameter (iteration_item_guid) | |
|
8102
|
-
|
8103
|
-
### Return type
|
8104
|
-
|
8105
|
-
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
8106
|
-
|
8107
|
-
### Authorization
|
8108
|
-
|
8109
|
-
[basicAuth](../README.md#basicAuth)
|
8110
|
-
|
8111
|
-
### HTTP request headers
|
8112
|
-
|
8113
|
-
- **Content-Type**: application/json
|
8114
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
8115
|
-
|
8116
|
-
|
8117
7038
|
## update_tag
|
8118
7039
|
|
8119
7040
|
> <TagResponseBody> update_tag(tag_guid, user_guid, tag_update_request_body)
|