mx-platform-ruby 0.21.0 → 0.22.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 +92 -0
- data/docs/MxPlatformApi.md +1586 -507
- data/docs/SpendingPlanAccountResponse.md +30 -0
- data/docs/SpendingPlanAccountsResponse.md +20 -0
- data/docs/SpendingPlanIterationItemCreateRequestBody.md +26 -0
- data/docs/SpendingPlanIterationItemResponse.md +40 -0
- data/docs/SpendingPlanIterationItemsResponseBody.md +20 -0
- data/docs/SpendingPlanIterationResponse.md +32 -0
- data/docs/SpendingPlanIterationsResponse.md +20 -0
- data/docs/SpendingPlanResponse.md +26 -0
- data/docs/SpendingPlansResponseBody.md +20 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +1062 -8
- data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +272 -0
- data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +229 -0
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +259 -0
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +330 -0
- data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +229 -0
- data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +289 -0
- data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +229 -0
- data/lib/mx-platform-ruby/models/spending_plan_response.rb +259 -0
- data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +229 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +9 -0
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +204 -0
- data/spec/models/spending_plan_account_response_spec.rb +70 -0
- data/spec/models/spending_plan_accounts_response_spec.rb +40 -0
- data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +58 -0
- data/spec/models/spending_plan_iteration_item_response_spec.rb +100 -0
- data/spec/models/spending_plan_iteration_items_response_body_spec.rb +40 -0
- data/spec/models/spending_plan_iteration_response_spec.rb +76 -0
- data/spec/models/spending_plan_iterations_response_spec.rb +40 -0
- data/spec/models/spending_plan_response_spec.rb +58 -0
- data/spec/models/spending_plans_response_body_spec.rb +40 -0
- metadata +152 -115
data/docs/MxPlatformApi.md
CHANGED
@@ -12,6 +12,8 @@ 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 |
|
15
17
|
| [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
|
16
18
|
| [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
|
17
19
|
| [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
|
@@ -22,6 +24,9 @@ All URIs are relative to *https://api.mx.com*
|
|
22
24
|
| [**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 |
|
23
25
|
| [**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account |
|
24
26
|
| [**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 |
|
25
30
|
| [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
|
26
31
|
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
|
27
32
|
| [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
|
@@ -55,6 +60,10 @@ All URIs are relative to *https://api.mx.com*
|
|
55
60
|
| [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
|
56
61
|
| [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
|
57
62
|
| [**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 |
|
58
67
|
| [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
|
59
68
|
| [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
|
60
69
|
| [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags |
|
@@ -79,6 +88,10 @@ All URIs are relative to *https://api.mx.com*
|
|
79
88
|
| [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
|
80
89
|
| [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
|
81
90
|
| [**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 |
|
82
95
|
| [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
|
83
96
|
| [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
|
84
97
|
| [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
|
@@ -97,6 +110,7 @@ All URIs are relative to *https://api.mx.com*
|
|
97
110
|
| [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
|
98
111
|
| [**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 |
|
99
112
|
| [**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 |
|
100
114
|
| [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
|
101
115
|
| [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
|
102
116
|
| [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction |
|
@@ -687,6 +701,150 @@ end
|
|
687
701
|
- **Accept**: application/vnd.mx.api.v1+json
|
688
702
|
|
689
703
|
|
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
|
+
|
690
848
|
## create_tag
|
691
849
|
|
692
850
|
> <TagResponseBody> create_tag(user_guid, tag_create_request_body)
|
@@ -1405,13 +1563,13 @@ nil (empty response body)
|
|
1405
1563
|
- **Accept**: Not defined
|
1406
1564
|
|
1407
1565
|
|
1408
|
-
##
|
1566
|
+
## delete_spending_plan
|
1409
1567
|
|
1410
|
-
>
|
1568
|
+
> delete_spending_plan(user_guid, spending_plan_guid)
|
1411
1569
|
|
1412
|
-
Delete
|
1570
|
+
Delete spending plan
|
1413
1571
|
|
1414
|
-
Use this endpoint to
|
1572
|
+
Use this endpoint to delete a user's `spending_plan`.
|
1415
1573
|
|
1416
1574
|
### Examples
|
1417
1575
|
|
@@ -1426,32 +1584,32 @@ MxPlatformRuby.configure do |config|
|
|
1426
1584
|
end
|
1427
1585
|
|
1428
1586
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1429
|
-
|
1430
|
-
|
1587
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
1588
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
1431
1589
|
|
1432
1590
|
begin
|
1433
|
-
# Delete
|
1434
|
-
api_instance.
|
1591
|
+
# Delete spending plan
|
1592
|
+
api_instance.delete_spending_plan(user_guid, spending_plan_guid)
|
1435
1593
|
rescue MxPlatformRuby::ApiError => e
|
1436
|
-
puts "Error when calling MxPlatformApi->
|
1594
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan: #{e}"
|
1437
1595
|
end
|
1438
1596
|
```
|
1439
1597
|
|
1440
|
-
#### Using the
|
1598
|
+
#### Using the delete_spending_plan_with_http_info variant
|
1441
1599
|
|
1442
1600
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1443
1601
|
|
1444
|
-
> <Array(nil, Integer, Hash)>
|
1602
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_with_http_info(user_guid, spending_plan_guid)
|
1445
1603
|
|
1446
1604
|
```ruby
|
1447
1605
|
begin
|
1448
|
-
# Delete
|
1449
|
-
data, status_code, headers = api_instance.
|
1606
|
+
# Delete spending plan
|
1607
|
+
data, status_code, headers = api_instance.delete_spending_plan_with_http_info(user_guid, spending_plan_guid)
|
1450
1608
|
p status_code # => 2xx
|
1451
1609
|
p headers # => { ... }
|
1452
1610
|
p data # => nil
|
1453
1611
|
rescue MxPlatformRuby::ApiError => e
|
1454
|
-
puts "Error when calling MxPlatformApi->
|
1612
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan_with_http_info: #{e}"
|
1455
1613
|
end
|
1456
1614
|
```
|
1457
1615
|
|
@@ -1459,8 +1617,8 @@ end
|
|
1459
1617
|
|
1460
1618
|
| Name | Type | Description | Notes |
|
1461
1619
|
| ---- | ---- | ----------- | ----- |
|
1462
|
-
| **
|
1463
|
-
| **
|
1620
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
1621
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
1464
1622
|
|
1465
1623
|
### Return type
|
1466
1624
|
|
@@ -1476,13 +1634,13 @@ nil (empty response body)
|
|
1476
1634
|
- **Accept**: Not defined
|
1477
1635
|
|
1478
1636
|
|
1479
|
-
##
|
1637
|
+
## delete_spending_plan_account
|
1480
1638
|
|
1481
|
-
>
|
1639
|
+
> delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid)
|
1482
1640
|
|
1483
|
-
Delete
|
1641
|
+
Delete spending plan account
|
1484
1642
|
|
1485
|
-
Use this endpoint to delete a
|
1643
|
+
Use this endpoint to delete a `spending_plan_account`.
|
1486
1644
|
|
1487
1645
|
### Examples
|
1488
1646
|
|
@@ -1497,32 +1655,33 @@ MxPlatformRuby.configure do |config|
|
|
1497
1655
|
end
|
1498
1656
|
|
1499
1657
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1500
|
-
|
1501
|
-
|
1658
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
1659
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
1660
|
+
spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # String | The unique ID for the specified account.
|
1502
1661
|
|
1503
1662
|
begin
|
1504
|
-
# Delete
|
1505
|
-
api_instance.
|
1663
|
+
# Delete spending plan account
|
1664
|
+
api_instance.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid)
|
1506
1665
|
rescue MxPlatformRuby::ApiError => e
|
1507
|
-
puts "Error when calling MxPlatformApi->
|
1666
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan_account: #{e}"
|
1508
1667
|
end
|
1509
1668
|
```
|
1510
1669
|
|
1511
|
-
#### Using the
|
1670
|
+
#### Using the delete_spending_plan_account_with_http_info variant
|
1512
1671
|
|
1513
1672
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1514
1673
|
|
1515
|
-
> <Array(nil, Integer, Hash)>
|
1674
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid)
|
1516
1675
|
|
1517
1676
|
```ruby
|
1518
1677
|
begin
|
1519
|
-
# Delete
|
1520
|
-
data, status_code, headers = api_instance.
|
1678
|
+
# Delete spending plan account
|
1679
|
+
data, status_code, headers = api_instance.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid)
|
1521
1680
|
p status_code # => 2xx
|
1522
1681
|
p headers # => { ... }
|
1523
1682
|
p data # => nil
|
1524
1683
|
rescue MxPlatformRuby::ApiError => e
|
1525
|
-
puts "Error when calling MxPlatformApi->
|
1684
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan_account_with_http_info: #{e}"
|
1526
1685
|
end
|
1527
1686
|
```
|
1528
1687
|
|
@@ -1530,8 +1689,9 @@ end
|
|
1530
1689
|
|
1531
1690
|
| Name | Type | Description | Notes |
|
1532
1691
|
| ---- | ---- | ----------- | ----- |
|
1533
|
-
| **
|
1534
|
-
| **
|
1692
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
1693
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
1694
|
+
| **spending_plan_account_guid** | **String** | The unique ID for the specified account. | |
|
1535
1695
|
|
1536
1696
|
### Return type
|
1537
1697
|
|
@@ -1547,13 +1707,13 @@ nil (empty response body)
|
|
1547
1707
|
- **Accept**: Not defined
|
1548
1708
|
|
1549
1709
|
|
1550
|
-
##
|
1710
|
+
## delete_spending_plan_iteration_item
|
1551
1711
|
|
1552
|
-
>
|
1712
|
+
> delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid)
|
1553
1713
|
|
1554
|
-
Delete
|
1714
|
+
Delete spending plan iteration item
|
1555
1715
|
|
1556
|
-
Use this endpoint to
|
1716
|
+
Use this endpoint to delete a spending plan `iteration_item`.
|
1557
1717
|
|
1558
1718
|
### Examples
|
1559
1719
|
|
@@ -1568,32 +1728,33 @@ MxPlatformRuby.configure do |config|
|
|
1568
1728
|
end
|
1569
1729
|
|
1570
1730
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1571
|
-
|
1572
|
-
|
1731
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
1732
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
1733
|
+
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
1573
1734
|
|
1574
1735
|
begin
|
1575
|
-
# Delete
|
1576
|
-
api_instance.
|
1736
|
+
# Delete spending plan iteration item
|
1737
|
+
api_instance.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid)
|
1577
1738
|
rescue MxPlatformRuby::ApiError => e
|
1578
|
-
puts "Error when calling MxPlatformApi->
|
1739
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan_iteration_item: #{e}"
|
1579
1740
|
end
|
1580
1741
|
```
|
1581
1742
|
|
1582
|
-
#### Using the
|
1743
|
+
#### Using the delete_spending_plan_iteration_item_with_http_info variant
|
1583
1744
|
|
1584
1745
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1585
1746
|
|
1586
|
-
> <Array(nil, Integer, Hash)>
|
1747
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid)
|
1587
1748
|
|
1588
1749
|
```ruby
|
1589
1750
|
begin
|
1590
|
-
# Delete
|
1591
|
-
data, status_code, headers = api_instance.
|
1751
|
+
# Delete spending plan iteration item
|
1752
|
+
data, status_code, headers = api_instance.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid)
|
1592
1753
|
p status_code # => 2xx
|
1593
1754
|
p headers # => { ... }
|
1594
1755
|
p data # => nil
|
1595
1756
|
rescue MxPlatformRuby::ApiError => e
|
1596
|
-
puts "Error when calling MxPlatformApi->
|
1757
|
+
puts "Error when calling MxPlatformApi->delete_spending_plan_iteration_item_with_http_info: #{e}"
|
1597
1758
|
end
|
1598
1759
|
```
|
1599
1760
|
|
@@ -1601,8 +1762,9 @@ end
|
|
1601
1762
|
|
1602
1763
|
| Name | Type | Description | Notes |
|
1603
1764
|
| ---- | ---- | ----------- | ----- |
|
1604
|
-
| **
|
1605
|
-
| **
|
1765
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
1766
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
1767
|
+
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
1606
1768
|
|
1607
1769
|
### Return type
|
1608
1770
|
|
@@ -1618,13 +1780,13 @@ nil (empty response body)
|
|
1618
1780
|
- **Accept**: Not defined
|
1619
1781
|
|
1620
1782
|
|
1621
|
-
##
|
1783
|
+
## delete_tag
|
1622
1784
|
|
1623
|
-
>
|
1785
|
+
> delete_tag(tag_guid, user_guid)
|
1624
1786
|
|
1625
|
-
Delete
|
1787
|
+
Delete tag
|
1626
1788
|
|
1627
|
-
Use this endpoint to delete
|
1789
|
+
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`.
|
1628
1790
|
|
1629
1791
|
### Examples
|
1630
1792
|
|
@@ -1639,31 +1801,32 @@ MxPlatformRuby.configure do |config|
|
|
1639
1801
|
end
|
1640
1802
|
|
1641
1803
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1804
|
+
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
1642
1805
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1643
1806
|
|
1644
1807
|
begin
|
1645
|
-
# Delete
|
1646
|
-
api_instance.
|
1808
|
+
# Delete tag
|
1809
|
+
api_instance.delete_tag(tag_guid, user_guid)
|
1647
1810
|
rescue MxPlatformRuby::ApiError => e
|
1648
|
-
puts "Error when calling MxPlatformApi->
|
1811
|
+
puts "Error when calling MxPlatformApi->delete_tag: #{e}"
|
1649
1812
|
end
|
1650
1813
|
```
|
1651
1814
|
|
1652
|
-
#### Using the
|
1815
|
+
#### Using the delete_tag_with_http_info variant
|
1653
1816
|
|
1654
1817
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1655
1818
|
|
1656
|
-
> <Array(nil, Integer, Hash)>
|
1819
|
+
> <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
|
1657
1820
|
|
1658
1821
|
```ruby
|
1659
1822
|
begin
|
1660
|
-
# Delete
|
1661
|
-
data, status_code, headers = api_instance.
|
1823
|
+
# Delete tag
|
1824
|
+
data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
|
1662
1825
|
p status_code # => 2xx
|
1663
1826
|
p headers # => { ... }
|
1664
1827
|
p data # => nil
|
1665
1828
|
rescue MxPlatformRuby::ApiError => e
|
1666
|
-
puts "Error when calling MxPlatformApi->
|
1829
|
+
puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
|
1667
1830
|
end
|
1668
1831
|
```
|
1669
1832
|
|
@@ -1671,6 +1834,7 @@ end
|
|
1671
1834
|
|
1672
1835
|
| Name | Type | Description | Notes |
|
1673
1836
|
| ---- | ---- | ----------- | ----- |
|
1837
|
+
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
1674
1838
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
1675
1839
|
|
1676
1840
|
### Return type
|
@@ -1687,13 +1851,13 @@ nil (empty response body)
|
|
1687
1851
|
- **Accept**: Not defined
|
1688
1852
|
|
1689
1853
|
|
1690
|
-
##
|
1854
|
+
## delete_tagging
|
1691
1855
|
|
1692
|
-
>
|
1856
|
+
> delete_tagging(tagging_guid, user_guid)
|
1693
1857
|
|
1694
|
-
|
1858
|
+
Delete tagging
|
1695
1859
|
|
1696
|
-
|
1860
|
+
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.
|
1697
1861
|
|
1698
1862
|
### Examples
|
1699
1863
|
|
@@ -1708,32 +1872,32 @@ MxPlatformRuby.configure do |config|
|
|
1708
1872
|
end
|
1709
1873
|
|
1710
1874
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1711
|
-
|
1875
|
+
tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
|
1876
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1712
1877
|
|
1713
1878
|
begin
|
1714
|
-
#
|
1715
|
-
|
1716
|
-
p result
|
1879
|
+
# Delete tagging
|
1880
|
+
api_instance.delete_tagging(tagging_guid, user_guid)
|
1717
1881
|
rescue MxPlatformRuby::ApiError => e
|
1718
|
-
puts "Error when calling MxPlatformApi->
|
1882
|
+
puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
|
1719
1883
|
end
|
1720
1884
|
```
|
1721
1885
|
|
1722
|
-
#### Using the
|
1886
|
+
#### Using the delete_tagging_with_http_info variant
|
1723
1887
|
|
1724
|
-
This returns an Array which contains the response data, status code and headers.
|
1888
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1725
1889
|
|
1726
|
-
> <Array(
|
1890
|
+
> <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
|
1727
1891
|
|
1728
1892
|
```ruby
|
1729
1893
|
begin
|
1730
|
-
#
|
1731
|
-
data, status_code, headers = api_instance.
|
1894
|
+
# Delete tagging
|
1895
|
+
data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
|
1732
1896
|
p status_code # => 2xx
|
1733
1897
|
p headers # => { ... }
|
1734
|
-
p data # =>
|
1898
|
+
p data # => nil
|
1735
1899
|
rescue MxPlatformRuby::ApiError => e
|
1736
|
-
puts "Error when calling MxPlatformApi->
|
1900
|
+
puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
|
1737
1901
|
end
|
1738
1902
|
```
|
1739
1903
|
|
@@ -1741,11 +1905,12 @@ end
|
|
1741
1905
|
|
1742
1906
|
| Name | Type | Description | Notes |
|
1743
1907
|
| ---- | ---- | ----------- | ----- |
|
1744
|
-
| **
|
1908
|
+
| **tagging_guid** | **String** | The unique id for a `tagging`. | |
|
1909
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1745
1910
|
|
1746
1911
|
### Return type
|
1747
1912
|
|
1748
|
-
|
1913
|
+
nil (empty response body)
|
1749
1914
|
|
1750
1915
|
### Authorization
|
1751
1916
|
|
@@ -1753,17 +1918,17 @@ end
|
|
1753
1918
|
|
1754
1919
|
### HTTP request headers
|
1755
1920
|
|
1756
|
-
- **Content-Type**:
|
1757
|
-
- **Accept**:
|
1921
|
+
- **Content-Type**: Not defined
|
1922
|
+
- **Accept**: Not defined
|
1758
1923
|
|
1759
1924
|
|
1760
|
-
##
|
1925
|
+
## delete_transaction_rule
|
1761
1926
|
|
1762
|
-
>
|
1927
|
+
> delete_transaction_rule(transaction_rule_guid, user_guid)
|
1763
1928
|
|
1764
|
-
|
1929
|
+
Delete transaction rule
|
1765
1930
|
|
1766
|
-
Use this endpoint to
|
1931
|
+
Use this endpoint to permanently delete a transaction rule based on its unique GUID.
|
1767
1932
|
|
1768
1933
|
### Examples
|
1769
1934
|
|
@@ -1778,32 +1943,242 @@ MxPlatformRuby.configure do |config|
|
|
1778
1943
|
end
|
1779
1944
|
|
1780
1945
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1781
|
-
|
1782
|
-
statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for a `statement`.
|
1946
|
+
transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
|
1783
1947
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1784
1948
|
|
1785
1949
|
begin
|
1786
|
-
#
|
1787
|
-
|
1788
|
-
p result
|
1950
|
+
# Delete transaction rule
|
1951
|
+
api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
|
1789
1952
|
rescue MxPlatformRuby::ApiError => e
|
1790
|
-
puts "Error when calling MxPlatformApi->
|
1953
|
+
puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
|
1791
1954
|
end
|
1792
1955
|
```
|
1793
1956
|
|
1794
|
-
#### Using the
|
1957
|
+
#### Using the delete_transaction_rule_with_http_info variant
|
1795
1958
|
|
1796
|
-
This returns an Array which contains the response data, status code and headers.
|
1959
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1797
1960
|
|
1798
|
-
> <Array(
|
1961
|
+
> <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
|
1799
1962
|
|
1800
1963
|
```ruby
|
1801
1964
|
begin
|
1802
|
-
#
|
1803
|
-
data, status_code, headers = api_instance.
|
1965
|
+
# Delete transaction rule
|
1966
|
+
data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
|
1804
1967
|
p status_code # => 2xx
|
1805
1968
|
p headers # => { ... }
|
1806
|
-
p data # =>
|
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)
|
2179
|
+
p status_code # => 2xx
|
2180
|
+
p headers # => { ... }
|
2181
|
+
p data # => File
|
1807
2182
|
rescue MxPlatformRuby::ApiError => e
|
1808
2183
|
puts "Error when calling MxPlatformApi->download_statement_pdf_with_http_info: #{e}"
|
1809
2184
|
end
|
@@ -3895,13 +4270,13 @@ end
|
|
3895
4270
|
- **Accept**: application/vnd.mx.api.v1+json
|
3896
4271
|
|
3897
4272
|
|
3898
|
-
##
|
4273
|
+
## list_spending_plan_accounts
|
3899
4274
|
|
3900
|
-
> <
|
4275
|
+
> <SpendingPlanAccountsResponse> list_spending_plan_accounts(user_guid, spending_plan_guid, opts)
|
3901
4276
|
|
3902
|
-
List
|
4277
|
+
List spending plan accounts
|
3903
4278
|
|
3904
|
-
Use this endpoint to
|
4279
|
+
Use this endpoint to list all the spending plan accounts associated with the spending plan.
|
3905
4280
|
|
3906
4281
|
### Examples
|
3907
4282
|
|
@@ -3916,37 +4291,37 @@ MxPlatformRuby.configure do |config|
|
|
3916
4291
|
end
|
3917
4292
|
|
3918
4293
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3919
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
3920
4294
|
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`.
|
3921
4296
|
opts = {
|
3922
4297
|
page: 1, # Integer | Specify current page.
|
3923
4298
|
records_per_page: 10 # Integer | Specify records per page.
|
3924
4299
|
}
|
3925
4300
|
|
3926
4301
|
begin
|
3927
|
-
# List
|
3928
|
-
result = api_instance.
|
4302
|
+
# List spending plan accounts
|
4303
|
+
result = api_instance.list_spending_plan_accounts(user_guid, spending_plan_guid, opts)
|
3929
4304
|
p result
|
3930
4305
|
rescue MxPlatformRuby::ApiError => e
|
3931
|
-
puts "Error when calling MxPlatformApi->
|
4306
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_accounts: #{e}"
|
3932
4307
|
end
|
3933
4308
|
```
|
3934
4309
|
|
3935
|
-
#### Using the
|
4310
|
+
#### Using the list_spending_plan_accounts_with_http_info variant
|
3936
4311
|
|
3937
4312
|
This returns an Array which contains the response data, status code and headers.
|
3938
4313
|
|
3939
|
-
> <Array(<
|
4314
|
+
> <Array(<SpendingPlanAccountsResponse>, Integer, Hash)> list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
|
3940
4315
|
|
3941
4316
|
```ruby
|
3942
4317
|
begin
|
3943
|
-
# List
|
3944
|
-
data, status_code, headers = api_instance.
|
4318
|
+
# List spending plan accounts
|
4319
|
+
data, status_code, headers = api_instance.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
|
3945
4320
|
p status_code # => 2xx
|
3946
4321
|
p headers # => { ... }
|
3947
|
-
p data # => <
|
4322
|
+
p data # => <SpendingPlanAccountsResponse>
|
3948
4323
|
rescue MxPlatformRuby::ApiError => e
|
3949
|
-
puts "Error when calling MxPlatformApi->
|
4324
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_accounts_with_http_info: #{e}"
|
3950
4325
|
end
|
3951
4326
|
```
|
3952
4327
|
|
@@ -3954,14 +4329,14 @@ end
|
|
3954
4329
|
|
3955
4330
|
| Name | Type | Description | Notes |
|
3956
4331
|
| ---- | ---- | ----------- | ----- |
|
3957
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
3958
4332
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4333
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
3959
4334
|
| **page** | **Integer** | Specify current page. | [optional] |
|
3960
4335
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
3961
4336
|
|
3962
4337
|
### Return type
|
3963
4338
|
|
3964
|
-
[**
|
4339
|
+
[**SpendingPlanAccountsResponse**](SpendingPlanAccountsResponse.md)
|
3965
4340
|
|
3966
4341
|
### Authorization
|
3967
4342
|
|
@@ -3973,13 +4348,13 @@ end
|
|
3973
4348
|
- **Accept**: application/vnd.mx.api.v1+json
|
3974
4349
|
|
3975
4350
|
|
3976
|
-
##
|
4351
|
+
## list_spending_plan_iteration_items
|
3977
4352
|
|
3978
|
-
> <
|
4353
|
+
> <SpendingPlanIterationItemsResponseBody> list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts)
|
3979
4354
|
|
3980
|
-
List
|
4355
|
+
List spending plan iteration items
|
3981
4356
|
|
3982
|
-
Use this endpoint to
|
4357
|
+
Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
|
3983
4358
|
|
3984
4359
|
### Examples
|
3985
4360
|
|
@@ -3995,35 +4370,36 @@ end
|
|
3995
4370
|
|
3996
4371
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
3997
4372
|
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`.
|
3998
4374
|
opts = {
|
3999
4375
|
page: 1, # Integer | Specify current page.
|
4000
4376
|
records_per_page: 10 # Integer | Specify records per page.
|
4001
4377
|
}
|
4002
4378
|
|
4003
4379
|
begin
|
4004
|
-
# List
|
4005
|
-
result = api_instance.
|
4380
|
+
# List spending plan iteration items
|
4381
|
+
result = api_instance.list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts)
|
4006
4382
|
p result
|
4007
4383
|
rescue MxPlatformRuby::ApiError => e
|
4008
|
-
puts "Error when calling MxPlatformApi->
|
4384
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_iteration_items: #{e}"
|
4009
4385
|
end
|
4010
4386
|
```
|
4011
4387
|
|
4012
|
-
#### Using the
|
4388
|
+
#### Using the list_spending_plan_iteration_items_with_http_info variant
|
4013
4389
|
|
4014
4390
|
This returns an Array which contains the response data, status code and headers.
|
4015
4391
|
|
4016
|
-
> <Array(<
|
4392
|
+
> <Array(<SpendingPlanIterationItemsResponseBody>, Integer, Hash)> list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
|
4017
4393
|
|
4018
4394
|
```ruby
|
4019
4395
|
begin
|
4020
|
-
# List
|
4021
|
-
data, status_code, headers = api_instance.
|
4396
|
+
# List spending plan iteration items
|
4397
|
+
data, status_code, headers = api_instance.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
|
4022
4398
|
p status_code # => 2xx
|
4023
4399
|
p headers # => { ... }
|
4024
|
-
p data # => <
|
4400
|
+
p data # => <SpendingPlanIterationItemsResponseBody>
|
4025
4401
|
rescue MxPlatformRuby::ApiError => e
|
4026
|
-
puts "Error when calling MxPlatformApi->
|
4402
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_iteration_items_with_http_info: #{e}"
|
4027
4403
|
end
|
4028
4404
|
```
|
4029
4405
|
|
@@ -4032,12 +4408,13 @@ end
|
|
4032
4408
|
| Name | Type | Description | Notes |
|
4033
4409
|
| ---- | ---- | ----------- | ----- |
|
4034
4410
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4411
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
4035
4412
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4036
4413
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4037
4414
|
|
4038
4415
|
### Return type
|
4039
4416
|
|
4040
|
-
[**
|
4417
|
+
[**SpendingPlanIterationItemsResponseBody**](SpendingPlanIterationItemsResponseBody.md)
|
4041
4418
|
|
4042
4419
|
### Authorization
|
4043
4420
|
|
@@ -4049,13 +4426,13 @@ end
|
|
4049
4426
|
- **Accept**: application/vnd.mx.api.v1+json
|
4050
4427
|
|
4051
4428
|
|
4052
|
-
##
|
4429
|
+
## list_spending_plan_iterations
|
4053
4430
|
|
4054
|
-
> <
|
4431
|
+
> <SpendingPlanIterationsResponse> list_spending_plan_iterations(user_guid, spending_plan_guid, opts)
|
4055
4432
|
|
4056
|
-
List
|
4433
|
+
List spending plan iterations
|
4057
4434
|
|
4058
|
-
Use this endpoint to list all
|
4435
|
+
Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
|
4059
4436
|
|
4060
4437
|
### Examples
|
4061
4438
|
|
@@ -4071,35 +4448,36 @@ end
|
|
4071
4448
|
|
4072
4449
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4073
4450
|
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`.
|
4074
4452
|
opts = {
|
4075
4453
|
page: 1, # Integer | Specify current page.
|
4076
4454
|
records_per_page: 10 # Integer | Specify records per page.
|
4077
4455
|
}
|
4078
4456
|
|
4079
4457
|
begin
|
4080
|
-
# List
|
4081
|
-
result = api_instance.
|
4458
|
+
# List spending plan iterations
|
4459
|
+
result = api_instance.list_spending_plan_iterations(user_guid, spending_plan_guid, opts)
|
4082
4460
|
p result
|
4083
4461
|
rescue MxPlatformRuby::ApiError => e
|
4084
|
-
puts "Error when calling MxPlatformApi->
|
4462
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_iterations: #{e}"
|
4085
4463
|
end
|
4086
4464
|
```
|
4087
4465
|
|
4088
|
-
#### Using the
|
4466
|
+
#### Using the list_spending_plan_iterations_with_http_info variant
|
4089
4467
|
|
4090
4468
|
This returns an Array which contains the response data, status code and headers.
|
4091
4469
|
|
4092
|
-
> <Array(<
|
4470
|
+
> <Array(<SpendingPlanIterationsResponse>, Integer, Hash)> list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
|
4093
4471
|
|
4094
4472
|
```ruby
|
4095
4473
|
begin
|
4096
|
-
# List
|
4097
|
-
data, status_code, headers = api_instance.
|
4474
|
+
# List spending plan iterations
|
4475
|
+
data, status_code, headers = api_instance.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
|
4098
4476
|
p status_code # => 2xx
|
4099
4477
|
p headers # => { ... }
|
4100
|
-
p data # => <
|
4478
|
+
p data # => <SpendingPlanIterationsResponse>
|
4101
4479
|
rescue MxPlatformRuby::ApiError => e
|
4102
|
-
puts "Error when calling MxPlatformApi->
|
4480
|
+
puts "Error when calling MxPlatformApi->list_spending_plan_iterations_with_http_info: #{e}"
|
4103
4481
|
end
|
4104
4482
|
```
|
4105
4483
|
|
@@ -4108,12 +4486,13 @@ end
|
|
4108
4486
|
| Name | Type | Description | Notes |
|
4109
4487
|
| ---- | ---- | ----------- | ----- |
|
4110
4488
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4489
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
4111
4490
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4112
4491
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4113
4492
|
|
4114
4493
|
### Return type
|
4115
4494
|
|
4116
|
-
[**
|
4495
|
+
[**SpendingPlanIterationsResponse**](SpendingPlanIterationsResponse.md)
|
4117
4496
|
|
4118
4497
|
### Authorization
|
4119
4498
|
|
@@ -4125,13 +4504,13 @@ end
|
|
4125
4504
|
- **Accept**: application/vnd.mx.api.v1+json
|
4126
4505
|
|
4127
4506
|
|
4128
|
-
##
|
4507
|
+
## list_spending_plans
|
4129
4508
|
|
4130
|
-
> <
|
4509
|
+
> <SpendingPlansResponseBody> list_spending_plans(user_guid, opts)
|
4131
4510
|
|
4132
|
-
List
|
4511
|
+
List spending plans
|
4133
4512
|
|
4134
|
-
Use this endpoint to
|
4513
|
+
Use this endpoint to list all the spending plans associated with the user.
|
4135
4514
|
|
4136
4515
|
### Examples
|
4137
4516
|
|
@@ -4146,7 +4525,6 @@ MxPlatformRuby.configure do |config|
|
|
4146
4525
|
end
|
4147
4526
|
|
4148
4527
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4149
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4150
4528
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4151
4529
|
opts = {
|
4152
4530
|
page: 1, # Integer | Specify current page.
|
@@ -4154,29 +4532,29 @@ opts = {
|
|
4154
4532
|
}
|
4155
4533
|
|
4156
4534
|
begin
|
4157
|
-
# List
|
4158
|
-
result = api_instance.
|
4535
|
+
# List spending plans
|
4536
|
+
result = api_instance.list_spending_plans(user_guid, opts)
|
4159
4537
|
p result
|
4160
4538
|
rescue MxPlatformRuby::ApiError => e
|
4161
|
-
puts "Error when calling MxPlatformApi->
|
4539
|
+
puts "Error when calling MxPlatformApi->list_spending_plans: #{e}"
|
4162
4540
|
end
|
4163
4541
|
```
|
4164
4542
|
|
4165
|
-
#### Using the
|
4543
|
+
#### Using the list_spending_plans_with_http_info variant
|
4166
4544
|
|
4167
4545
|
This returns an Array which contains the response data, status code and headers.
|
4168
4546
|
|
4169
|
-
> <Array(<
|
4547
|
+
> <Array(<SpendingPlansResponseBody>, Integer, Hash)> list_spending_plans_with_http_info(user_guid, opts)
|
4170
4548
|
|
4171
4549
|
```ruby
|
4172
4550
|
begin
|
4173
|
-
# List
|
4174
|
-
data, status_code, headers = api_instance.
|
4551
|
+
# List spending plans
|
4552
|
+
data, status_code, headers = api_instance.list_spending_plans_with_http_info(user_guid, opts)
|
4175
4553
|
p status_code # => 2xx
|
4176
4554
|
p headers # => { ... }
|
4177
|
-
p data # => <
|
4555
|
+
p data # => <SpendingPlansResponseBody>
|
4178
4556
|
rescue MxPlatformRuby::ApiError => e
|
4179
|
-
puts "Error when calling MxPlatformApi->
|
4557
|
+
puts "Error when calling MxPlatformApi->list_spending_plans_with_http_info: #{e}"
|
4180
4558
|
end
|
4181
4559
|
```
|
4182
4560
|
|
@@ -4184,14 +4562,13 @@ end
|
|
4184
4562
|
|
4185
4563
|
| Name | Type | Description | Notes |
|
4186
4564
|
| ---- | ---- | ----------- | ----- |
|
4187
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
4188
4565
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4189
4566
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4190
4567
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4191
4568
|
|
4192
4569
|
### Return type
|
4193
4570
|
|
4194
|
-
[**
|
4571
|
+
[**SpendingPlansResponseBody**](SpendingPlansResponseBody.md)
|
4195
4572
|
|
4196
4573
|
### Authorization
|
4197
4574
|
|
@@ -4203,13 +4580,13 @@ end
|
|
4203
4580
|
- **Accept**: application/vnd.mx.api.v1+json
|
4204
4581
|
|
4205
4582
|
|
4206
|
-
##
|
4583
|
+
## list_statements_by_member
|
4207
4584
|
|
4208
|
-
> <
|
4585
|
+
> <StatementsResponseBody> list_statements_by_member(member_guid, user_guid, opts)
|
4209
4586
|
|
4210
|
-
List
|
4587
|
+
List statements by member
|
4211
4588
|
|
4212
|
-
Use this endpoint to
|
4589
|
+
Use this endpoint to get an array of available statements.
|
4213
4590
|
|
4214
4591
|
### Examples
|
4215
4592
|
|
@@ -4224,6 +4601,7 @@ MxPlatformRuby.configure do |config|
|
|
4224
4601
|
end
|
4225
4602
|
|
4226
4603
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4604
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4227
4605
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4228
4606
|
opts = {
|
4229
4607
|
page: 1, # Integer | Specify current page.
|
@@ -4231,29 +4609,29 @@ opts = {
|
|
4231
4609
|
}
|
4232
4610
|
|
4233
4611
|
begin
|
4234
|
-
# List
|
4235
|
-
result = api_instance.
|
4612
|
+
# List statements by member
|
4613
|
+
result = api_instance.list_statements_by_member(member_guid, user_guid, opts)
|
4236
4614
|
p result
|
4237
4615
|
rescue MxPlatformRuby::ApiError => e
|
4238
|
-
puts "Error when calling MxPlatformApi->
|
4616
|
+
puts "Error when calling MxPlatformApi->list_statements_by_member: #{e}"
|
4239
4617
|
end
|
4240
4618
|
```
|
4241
4619
|
|
4242
|
-
#### Using the
|
4620
|
+
#### Using the list_statements_by_member_with_http_info variant
|
4243
4621
|
|
4244
4622
|
This returns an Array which contains the response data, status code and headers.
|
4245
4623
|
|
4246
|
-
> <Array(<
|
4624
|
+
> <Array(<StatementsResponseBody>, Integer, Hash)> list_statements_by_member_with_http_info(member_guid, user_guid, opts)
|
4247
4625
|
|
4248
4626
|
```ruby
|
4249
4627
|
begin
|
4250
|
-
# List
|
4251
|
-
data, status_code, headers = api_instance.
|
4628
|
+
# List statements by member
|
4629
|
+
data, status_code, headers = api_instance.list_statements_by_member_with_http_info(member_guid, user_guid, opts)
|
4252
4630
|
p status_code # => 2xx
|
4253
4631
|
p headers # => { ... }
|
4254
|
-
p data # => <
|
4632
|
+
p data # => <StatementsResponseBody>
|
4255
4633
|
rescue MxPlatformRuby::ApiError => e
|
4256
|
-
puts "Error when calling MxPlatformApi->
|
4634
|
+
puts "Error when calling MxPlatformApi->list_statements_by_member_with_http_info: #{e}"
|
4257
4635
|
end
|
4258
4636
|
```
|
4259
4637
|
|
@@ -4261,13 +4639,14 @@ end
|
|
4261
4639
|
|
4262
4640
|
| Name | Type | Description | Notes |
|
4263
4641
|
| ---- | ---- | ----------- | ----- |
|
4642
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
4264
4643
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4265
4644
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4266
4645
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4267
4646
|
|
4268
4647
|
### Return type
|
4269
4648
|
|
4270
|
-
[**
|
4649
|
+
[**StatementsResponseBody**](StatementsResponseBody.md)
|
4271
4650
|
|
4272
4651
|
### Authorization
|
4273
4652
|
|
@@ -4279,13 +4658,13 @@ end
|
|
4279
4658
|
- **Accept**: application/vnd.mx.api.v1+json
|
4280
4659
|
|
4281
4660
|
|
4282
|
-
##
|
4661
|
+
## list_taggings
|
4283
4662
|
|
4284
|
-
> <
|
4663
|
+
> <TaggingsResponseBody> list_taggings(user_guid, opts)
|
4285
4664
|
|
4286
|
-
List
|
4665
|
+
List taggings
|
4287
4666
|
|
4288
|
-
|
4667
|
+
Use this endpoint to retrieve a list of all the taggings associated with a specific user.
|
4289
4668
|
|
4290
4669
|
### Examples
|
4291
4670
|
|
@@ -4302,36 +4681,34 @@ end
|
|
4302
4681
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4303
4682
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4304
4683
|
opts = {
|
4305
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4306
4684
|
page: 1, # Integer | Specify current page.
|
4307
|
-
records_per_page: 10
|
4308
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4685
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4309
4686
|
}
|
4310
4687
|
|
4311
4688
|
begin
|
4312
|
-
# List
|
4313
|
-
result = api_instance.
|
4689
|
+
# List taggings
|
4690
|
+
result = api_instance.list_taggings(user_guid, opts)
|
4314
4691
|
p result
|
4315
4692
|
rescue MxPlatformRuby::ApiError => e
|
4316
|
-
puts "Error when calling MxPlatformApi->
|
4693
|
+
puts "Error when calling MxPlatformApi->list_taggings: #{e}"
|
4317
4694
|
end
|
4318
4695
|
```
|
4319
4696
|
|
4320
|
-
#### Using the
|
4697
|
+
#### Using the list_taggings_with_http_info variant
|
4321
4698
|
|
4322
4699
|
This returns an Array which contains the response data, status code and headers.
|
4323
4700
|
|
4324
|
-
> <Array(<
|
4701
|
+
> <Array(<TaggingsResponseBody>, Integer, Hash)> list_taggings_with_http_info(user_guid, opts)
|
4325
4702
|
|
4326
4703
|
```ruby
|
4327
4704
|
begin
|
4328
|
-
# List
|
4329
|
-
data, status_code, headers = api_instance.
|
4705
|
+
# List taggings
|
4706
|
+
data, status_code, headers = api_instance.list_taggings_with_http_info(user_guid, opts)
|
4330
4707
|
p status_code # => 2xx
|
4331
4708
|
p headers # => { ... }
|
4332
|
-
p data # => <
|
4709
|
+
p data # => <TaggingsResponseBody>
|
4333
4710
|
rescue MxPlatformRuby::ApiError => e
|
4334
|
-
puts "Error when calling MxPlatformApi->
|
4711
|
+
puts "Error when calling MxPlatformApi->list_taggings_with_http_info: #{e}"
|
4335
4712
|
end
|
4336
4713
|
```
|
4337
4714
|
|
@@ -4340,14 +4717,12 @@ end
|
|
4340
4717
|
| Name | Type | Description | Notes |
|
4341
4718
|
| ---- | ---- | ----------- | ----- |
|
4342
4719
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4343
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4344
4720
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4345
4721
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4346
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4347
4722
|
|
4348
4723
|
### Return type
|
4349
4724
|
|
4350
|
-
[**
|
4725
|
+
[**TaggingsResponseBody**](TaggingsResponseBody.md)
|
4351
4726
|
|
4352
4727
|
### Authorization
|
4353
4728
|
|
@@ -4359,13 +4734,13 @@ end
|
|
4359
4734
|
- **Accept**: application/vnd.mx.api.v1+json
|
4360
4735
|
|
4361
4736
|
|
4362
|
-
##
|
4737
|
+
## list_tags
|
4363
4738
|
|
4364
|
-
> <
|
4739
|
+
> <TagsResponseBody> list_tags(user_guid, opts)
|
4365
4740
|
|
4366
|
-
List
|
4741
|
+
List tags
|
4367
4742
|
|
4368
|
-
|
4743
|
+
Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.
|
4369
4744
|
|
4370
4745
|
### Examples
|
4371
4746
|
|
@@ -4380,39 +4755,36 @@ MxPlatformRuby.configure do |config|
|
|
4380
4755
|
end
|
4381
4756
|
|
4382
4757
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4383
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
4384
4758
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4385
4759
|
opts = {
|
4386
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4387
4760
|
page: 1, # Integer | Specify current page.
|
4388
|
-
records_per_page: 10
|
4389
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4761
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4390
4762
|
}
|
4391
4763
|
|
4392
4764
|
begin
|
4393
|
-
# List
|
4394
|
-
result = api_instance.
|
4765
|
+
# List tags
|
4766
|
+
result = api_instance.list_tags(user_guid, opts)
|
4395
4767
|
p result
|
4396
4768
|
rescue MxPlatformRuby::ApiError => e
|
4397
|
-
puts "Error when calling MxPlatformApi->
|
4769
|
+
puts "Error when calling MxPlatformApi->list_tags: #{e}"
|
4398
4770
|
end
|
4399
4771
|
```
|
4400
4772
|
|
4401
|
-
#### Using the
|
4773
|
+
#### Using the list_tags_with_http_info variant
|
4402
4774
|
|
4403
4775
|
This returns an Array which contains the response data, status code and headers.
|
4404
4776
|
|
4405
|
-
> <Array(<
|
4777
|
+
> <Array(<TagsResponseBody>, Integer, Hash)> list_tags_with_http_info(user_guid, opts)
|
4406
4778
|
|
4407
4779
|
```ruby
|
4408
4780
|
begin
|
4409
|
-
# List
|
4410
|
-
data, status_code, headers = api_instance.
|
4781
|
+
# List tags
|
4782
|
+
data, status_code, headers = api_instance.list_tags_with_http_info(user_guid, opts)
|
4411
4783
|
p status_code # => 2xx
|
4412
4784
|
p headers # => { ... }
|
4413
|
-
p data # => <
|
4785
|
+
p data # => <TagsResponseBody>
|
4414
4786
|
rescue MxPlatformRuby::ApiError => e
|
4415
|
-
puts "Error when calling MxPlatformApi->
|
4787
|
+
puts "Error when calling MxPlatformApi->list_tags_with_http_info: #{e}"
|
4416
4788
|
end
|
4417
4789
|
```
|
4418
4790
|
|
@@ -4420,16 +4792,13 @@ end
|
|
4420
4792
|
|
4421
4793
|
| Name | Type | Description | Notes |
|
4422
4794
|
| ---- | ---- | ----------- | ----- |
|
4423
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
4424
4795
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4425
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4426
4796
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4427
4797
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4428
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4429
4798
|
|
4430
4799
|
### Return type
|
4431
4800
|
|
4432
|
-
[**
|
4801
|
+
[**TagsResponseBody**](TagsResponseBody.md)
|
4433
4802
|
|
4434
4803
|
### Authorization
|
4435
4804
|
|
@@ -4441,13 +4810,13 @@ end
|
|
4441
4810
|
- **Accept**: application/vnd.mx.api.v1+json
|
4442
4811
|
|
4443
4812
|
|
4444
|
-
##
|
4813
|
+
## list_tax_documents
|
4445
4814
|
|
4446
|
-
> <
|
4815
|
+
> <TaxDocumentsResponseBody> list_tax_documents(member_guid, user_guid, opts)
|
4447
4816
|
|
4448
|
-
List
|
4817
|
+
List Tax Documents
|
4449
4818
|
|
4450
|
-
|
4819
|
+
Use this endpoint to get a paginated list of tax documents.
|
4451
4820
|
|
4452
4821
|
### Examples
|
4453
4822
|
|
@@ -4465,36 +4834,34 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
4465
4834
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4466
4835
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4467
4836
|
opts = {
|
4468
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4469
4837
|
page: 1, # Integer | Specify current page.
|
4470
|
-
records_per_page: 10
|
4471
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4838
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4472
4839
|
}
|
4473
4840
|
|
4474
4841
|
begin
|
4475
|
-
# List
|
4476
|
-
result = api_instance.
|
4842
|
+
# List Tax Documents
|
4843
|
+
result = api_instance.list_tax_documents(member_guid, user_guid, opts)
|
4477
4844
|
p result
|
4478
4845
|
rescue MxPlatformRuby::ApiError => e
|
4479
|
-
puts "Error when calling MxPlatformApi->
|
4846
|
+
puts "Error when calling MxPlatformApi->list_tax_documents: #{e}"
|
4480
4847
|
end
|
4481
4848
|
```
|
4482
4849
|
|
4483
|
-
#### Using the
|
4850
|
+
#### Using the list_tax_documents_with_http_info variant
|
4484
4851
|
|
4485
4852
|
This returns an Array which contains the response data, status code and headers.
|
4486
4853
|
|
4487
|
-
> <Array(<
|
4854
|
+
> <Array(<TaxDocumentsResponseBody>, Integer, Hash)> list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4488
4855
|
|
4489
4856
|
```ruby
|
4490
4857
|
begin
|
4491
|
-
# List
|
4492
|
-
data, status_code, headers = api_instance.
|
4858
|
+
# List Tax Documents
|
4859
|
+
data, status_code, headers = api_instance.list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4493
4860
|
p status_code # => 2xx
|
4494
4861
|
p headers # => { ... }
|
4495
|
-
p data # => <
|
4862
|
+
p data # => <TaxDocumentsResponseBody>
|
4496
4863
|
rescue MxPlatformRuby::ApiError => e
|
4497
|
-
puts "Error when calling MxPlatformApi->
|
4864
|
+
puts "Error when calling MxPlatformApi->list_tax_documents_with_http_info: #{e}"
|
4498
4865
|
end
|
4499
4866
|
```
|
4500
4867
|
|
@@ -4504,14 +4871,12 @@ end
|
|
4504
4871
|
| ---- | ---- | ----------- | ----- |
|
4505
4872
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
4506
4873
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4507
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4508
4874
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4509
4875
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4510
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4511
4876
|
|
4512
4877
|
### Return type
|
4513
4878
|
|
4514
|
-
[**
|
4879
|
+
[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md)
|
4515
4880
|
|
4516
4881
|
### Authorization
|
4517
4882
|
|
@@ -4523,13 +4888,13 @@ end
|
|
4523
4888
|
- **Accept**: application/vnd.mx.api.v1+json
|
4524
4889
|
|
4525
4890
|
|
4526
|
-
##
|
4891
|
+
## list_transaction_rules
|
4527
4892
|
|
4528
|
-
> <
|
4893
|
+
> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
|
4529
4894
|
|
4530
|
-
List
|
4895
|
+
List transaction rules
|
4531
4896
|
|
4532
|
-
Use this endpoint to
|
4897
|
+
Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
|
4533
4898
|
|
4534
4899
|
### Examples
|
4535
4900
|
|
@@ -4544,39 +4909,36 @@ MxPlatformRuby.configure do |config|
|
|
4544
4909
|
end
|
4545
4910
|
|
4546
4911
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4547
|
-
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
4548
4912
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4549
4913
|
opts = {
|
4550
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4551
4914
|
page: 1, # Integer | Specify current page.
|
4552
|
-
records_per_page: 10
|
4553
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4915
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4554
4916
|
}
|
4555
4917
|
|
4556
4918
|
begin
|
4557
|
-
# List
|
4558
|
-
result = api_instance.
|
4919
|
+
# List transaction rules
|
4920
|
+
result = api_instance.list_transaction_rules(user_guid, opts)
|
4559
4921
|
p result
|
4560
4922
|
rescue MxPlatformRuby::ApiError => e
|
4561
|
-
puts "Error when calling MxPlatformApi->
|
4923
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules: #{e}"
|
4562
4924
|
end
|
4563
4925
|
```
|
4564
4926
|
|
4565
|
-
#### Using the
|
4927
|
+
#### Using the list_transaction_rules_with_http_info variant
|
4566
4928
|
|
4567
4929
|
This returns an Array which contains the response data, status code and headers.
|
4568
4930
|
|
4569
|
-
> <Array(<
|
4931
|
+
> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_with_http_info(user_guid, opts)
|
4570
4932
|
|
4571
4933
|
```ruby
|
4572
4934
|
begin
|
4573
|
-
# List
|
4574
|
-
data, status_code, headers = api_instance.
|
4935
|
+
# List transaction rules
|
4936
|
+
data, status_code, headers = api_instance.list_transaction_rules_with_http_info(user_guid, opts)
|
4575
4937
|
p status_code # => 2xx
|
4576
4938
|
p headers # => { ... }
|
4577
|
-
p data # => <
|
4939
|
+
p data # => <TransactionRulesResponseBody>
|
4578
4940
|
rescue MxPlatformRuby::ApiError => e
|
4579
|
-
puts "Error when calling MxPlatformApi->
|
4941
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules_with_http_info: #{e}"
|
4580
4942
|
end
|
4581
4943
|
```
|
4582
4944
|
|
@@ -4584,16 +4946,13 @@ end
|
|
4584
4946
|
|
4585
4947
|
| Name | Type | Description | Notes |
|
4586
4948
|
| ---- | ---- | ----------- | ----- |
|
4587
|
-
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
4588
4949
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4589
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4590
4950
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4591
4951
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4592
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4593
4952
|
|
4594
4953
|
### Return type
|
4595
4954
|
|
4596
|
-
[**
|
4955
|
+
[**TransactionRulesResponseBody**](TransactionRulesResponseBody.md)
|
4597
4956
|
|
4598
4957
|
### Authorization
|
4599
4958
|
|
@@ -4605,13 +4964,13 @@ end
|
|
4605
4964
|
- **Accept**: application/vnd.mx.api.v1+json
|
4606
4965
|
|
4607
4966
|
|
4608
|
-
##
|
4967
|
+
## list_transactions
|
4609
4968
|
|
4610
|
-
> <
|
4969
|
+
> <TransactionsResponseBody> list_transactions(user_guid, opts)
|
4611
4970
|
|
4612
|
-
List
|
4971
|
+
List transactions
|
4613
4972
|
|
4614
|
-
|
4973
|
+
Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
|
4615
4974
|
|
4616
4975
|
### Examples
|
4617
4976
|
|
@@ -4628,36 +4987,36 @@ end
|
|
4628
4987
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4629
4988
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4630
4989
|
opts = {
|
4631
|
-
|
4990
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4632
4991
|
page: 1, # Integer | Specify current page.
|
4633
|
-
|
4634
|
-
|
4992
|
+
records_per_page: 10, # Integer | Specify records per page.
|
4993
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4635
4994
|
}
|
4636
4995
|
|
4637
4996
|
begin
|
4638
|
-
# List
|
4639
|
-
result = api_instance.
|
4997
|
+
# List transactions
|
4998
|
+
result = api_instance.list_transactions(user_guid, opts)
|
4640
4999
|
p result
|
4641
5000
|
rescue MxPlatformRuby::ApiError => e
|
4642
|
-
puts "Error when calling MxPlatformApi->
|
5001
|
+
puts "Error when calling MxPlatformApi->list_transactions: #{e}"
|
4643
5002
|
end
|
4644
5003
|
```
|
4645
5004
|
|
4646
|
-
#### Using the
|
5005
|
+
#### Using the list_transactions_with_http_info variant
|
4647
5006
|
|
4648
5007
|
This returns an Array which contains the response data, status code and headers.
|
4649
5008
|
|
4650
|
-
> <Array(<
|
5009
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_with_http_info(user_guid, opts)
|
4651
5010
|
|
4652
5011
|
```ruby
|
4653
5012
|
begin
|
4654
|
-
# List
|
4655
|
-
data, status_code, headers = api_instance.
|
5013
|
+
# List transactions
|
5014
|
+
data, status_code, headers = api_instance.list_transactions_with_http_info(user_guid, opts)
|
4656
5015
|
p status_code # => 2xx
|
4657
5016
|
p headers # => { ... }
|
4658
|
-
p data # => <
|
5017
|
+
p data # => <TransactionsResponseBody>
|
4659
5018
|
rescue MxPlatformRuby::ApiError => e
|
4660
|
-
puts "Error when calling MxPlatformApi->
|
5019
|
+
puts "Error when calling MxPlatformApi->list_transactions_with_http_info: #{e}"
|
4661
5020
|
end
|
4662
5021
|
```
|
4663
5022
|
|
@@ -4666,14 +5025,14 @@ end
|
|
4666
5025
|
| Name | Type | Description | Notes |
|
4667
5026
|
| ---- | ---- | ----------- | ----- |
|
4668
5027
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
4669
|
-
| **
|
5028
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
4670
5029
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4671
|
-
| **is_manual** | **Boolean** | List only accounts that were manually created. | [optional] |
|
4672
5030
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
5031
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4673
5032
|
|
4674
5033
|
### Return type
|
4675
5034
|
|
4676
|
-
[**
|
5035
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4677
5036
|
|
4678
5037
|
### Authorization
|
4679
5038
|
|
@@ -4685,13 +5044,13 @@ end
|
|
4685
5044
|
- **Accept**: application/vnd.mx.api.v1+json
|
4686
5045
|
|
4687
5046
|
|
4688
|
-
##
|
5047
|
+
## list_transactions_by_account
|
4689
5048
|
|
4690
|
-
> <
|
5049
|
+
> <TransactionsResponseBody> list_transactions_by_account(account_guid, user_guid, opts)
|
4691
5050
|
|
4692
|
-
List
|
5051
|
+
List transactions by account
|
4693
5052
|
|
4694
|
-
|
5053
|
+
This endpoint returns a list of the last 90 days of transactions associated with the specified account.
|
4695
5054
|
|
4696
5055
|
### Examples
|
4697
5056
|
|
@@ -4706,38 +5065,39 @@ MxPlatformRuby.configure do |config|
|
|
4706
5065
|
end
|
4707
5066
|
|
4708
5067
|
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`.
|
4709
5070
|
opts = {
|
5071
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
4710
5072
|
page: 1, # Integer | Specify current page.
|
4711
5073
|
records_per_page: 10, # Integer | Specify records per page.
|
4712
|
-
|
4713
|
-
email: 'example@example.com', # String | The user `email` to search for.
|
4714
|
-
is_disabled: true # Boolean | Search for users that are diabled.
|
5074
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
4715
5075
|
}
|
4716
5076
|
|
4717
5077
|
begin
|
4718
|
-
# List
|
4719
|
-
result = api_instance.
|
5078
|
+
# List transactions by account
|
5079
|
+
result = api_instance.list_transactions_by_account(account_guid, user_guid, opts)
|
4720
5080
|
p result
|
4721
5081
|
rescue MxPlatformRuby::ApiError => e
|
4722
|
-
puts "Error when calling MxPlatformApi->
|
5082
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account: #{e}"
|
4723
5083
|
end
|
4724
5084
|
```
|
4725
5085
|
|
4726
|
-
#### Using the
|
5086
|
+
#### Using the list_transactions_by_account_with_http_info variant
|
4727
5087
|
|
4728
5088
|
This returns an Array which contains the response data, status code and headers.
|
4729
5089
|
|
4730
|
-
> <Array(<
|
5090
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
4731
5091
|
|
4732
5092
|
```ruby
|
4733
5093
|
begin
|
4734
|
-
# List
|
4735
|
-
data, status_code, headers = api_instance.
|
5094
|
+
# List transactions by account
|
5095
|
+
data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
4736
5096
|
p status_code # => 2xx
|
4737
5097
|
p headers # => { ... }
|
4738
|
-
p data # => <
|
5098
|
+
p data # => <TransactionsResponseBody>
|
4739
5099
|
rescue MxPlatformRuby::ApiError => e
|
4740
|
-
puts "Error when calling MxPlatformApi->
|
5100
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account_with_http_info: #{e}"
|
4741
5101
|
end
|
4742
5102
|
```
|
4743
5103
|
|
@@ -4745,15 +5105,16 @@ end
|
|
4745
5105
|
|
4746
5106
|
| Name | Type | Description | Notes |
|
4747
5107
|
| ---- | ---- | ----------- | ----- |
|
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] |
|
4748
5111
|
| **page** | **Integer** | Specify current page. | [optional] |
|
4749
5112
|
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4750
|
-
| **
|
4751
|
-
| **email** | **String** | The user `email` to search for. | [optional] |
|
4752
|
-
| **is_disabled** | **Boolean** | Search for users that are diabled. | [optional] |
|
5113
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
4753
5114
|
|
4754
5115
|
### Return type
|
4755
5116
|
|
4756
|
-
[**
|
5117
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4757
5118
|
|
4758
5119
|
### Authorization
|
4759
5120
|
|
@@ -4765,13 +5126,13 @@ end
|
|
4765
5126
|
- **Accept**: application/vnd.mx.api.v1+json
|
4766
5127
|
|
4767
5128
|
|
4768
|
-
##
|
5129
|
+
## list_transactions_by_member
|
4769
5130
|
|
4770
|
-
> <
|
5131
|
+
> <TransactionsResponseBody> list_transactions_by_member(member_guid, user_guid, opts)
|
4771
5132
|
|
4772
|
-
|
5133
|
+
List transactions by member
|
4773
5134
|
|
4774
|
-
|
5135
|
+
Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
|
4775
5136
|
|
4776
5137
|
### Examples
|
4777
5138
|
|
@@ -4786,33 +5147,39 @@ MxPlatformRuby.configure do |config|
|
|
4786
5147
|
end
|
4787
5148
|
|
4788
5149
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4789
|
-
|
5150
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4790
5151
|
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
|
+
}
|
4791
5158
|
|
4792
5159
|
begin
|
4793
|
-
#
|
4794
|
-
result = api_instance.
|
5160
|
+
# List transactions by member
|
5161
|
+
result = api_instance.list_transactions_by_member(member_guid, user_guid, opts)
|
4795
5162
|
p result
|
4796
5163
|
rescue MxPlatformRuby::ApiError => e
|
4797
|
-
puts "Error when calling MxPlatformApi->
|
5164
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member: #{e}"
|
4798
5165
|
end
|
4799
5166
|
```
|
4800
5167
|
|
4801
|
-
#### Using the
|
5168
|
+
#### Using the list_transactions_by_member_with_http_info variant
|
4802
5169
|
|
4803
5170
|
This returns an Array which contains the response data, status code and headers.
|
4804
5171
|
|
4805
|
-
> <Array(<
|
5172
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
4806
5173
|
|
4807
5174
|
```ruby
|
4808
5175
|
begin
|
4809
|
-
#
|
4810
|
-
data, status_code, headers = api_instance.
|
5176
|
+
# List transactions by member
|
5177
|
+
data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
4811
5178
|
p status_code # => 2xx
|
4812
5179
|
p headers # => { ... }
|
4813
|
-
p data # => <
|
5180
|
+
p data # => <TransactionsResponseBody>
|
4814
5181
|
rescue MxPlatformRuby::ApiError => e
|
4815
|
-
puts "Error when calling MxPlatformApi->
|
5182
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member_with_http_info: #{e}"
|
4816
5183
|
end
|
4817
5184
|
```
|
4818
5185
|
|
@@ -4820,12 +5187,16 @@ end
|
|
4820
5187
|
|
4821
5188
|
| Name | Type | Description | Notes |
|
4822
5189
|
| ---- | ---- | ----------- | ----- |
|
4823
|
-
| **
|
5190
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
4824
5191
|
| **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] |
|
4825
5196
|
|
4826
5197
|
### Return type
|
4827
5198
|
|
4828
|
-
[**
|
5199
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4829
5200
|
|
4830
5201
|
### Authorization
|
4831
5202
|
|
@@ -4837,13 +5208,13 @@ end
|
|
4837
5208
|
- **Accept**: application/vnd.mx.api.v1+json
|
4838
5209
|
|
4839
5210
|
|
4840
|
-
##
|
5211
|
+
## list_transactions_by_tag
|
4841
5212
|
|
4842
|
-
> <
|
5213
|
+
> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts)
|
4843
5214
|
|
4844
|
-
|
5215
|
+
List transactions by tag
|
4845
5216
|
|
4846
|
-
|
5217
|
+
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.
|
4847
5218
|
|
4848
5219
|
### Examples
|
4849
5220
|
|
@@ -4858,34 +5229,39 @@ MxPlatformRuby.configure do |config|
|
|
4858
5229
|
end
|
4859
5230
|
|
4860
5231
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4861
|
-
|
4862
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5232
|
+
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
4863
5233
|
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
|
+
}
|
4864
5240
|
|
4865
5241
|
begin
|
4866
|
-
#
|
4867
|
-
result = api_instance.
|
5242
|
+
# List transactions by tag
|
5243
|
+
result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts)
|
4868
5244
|
p result
|
4869
5245
|
rescue MxPlatformRuby::ApiError => e
|
4870
|
-
puts "Error when calling MxPlatformApi->
|
5246
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
|
4871
5247
|
end
|
4872
5248
|
```
|
4873
5249
|
|
4874
|
-
#### Using the
|
5250
|
+
#### Using the list_transactions_by_tag_with_http_info variant
|
4875
5251
|
|
4876
5252
|
This returns an Array which contains the response data, status code and headers.
|
4877
5253
|
|
4878
|
-
> <Array(<
|
5254
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
4879
5255
|
|
4880
5256
|
```ruby
|
4881
5257
|
begin
|
4882
|
-
#
|
4883
|
-
data, status_code, headers = api_instance.
|
5258
|
+
# List transactions by tag
|
5259
|
+
data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
|
4884
5260
|
p status_code # => 2xx
|
4885
5261
|
p headers # => { ... }
|
4886
|
-
p data # => <
|
5262
|
+
p data # => <TransactionsResponseBody>
|
4887
5263
|
rescue MxPlatformRuby::ApiError => e
|
4888
|
-
puts "Error when calling MxPlatformApi->
|
5264
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}"
|
4889
5265
|
end
|
4890
5266
|
```
|
4891
5267
|
|
@@ -4893,13 +5269,16 @@ end
|
|
4893
5269
|
|
4894
5270
|
| Name | Type | Description | Notes |
|
4895
5271
|
| ---- | ---- | ----------- | ----- |
|
4896
|
-
| **
|
4897
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5272
|
+
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
4898
5273
|
| **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] |
|
4899
5278
|
|
4900
5279
|
### Return type
|
4901
5280
|
|
4902
|
-
[**
|
5281
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
4903
5282
|
|
4904
5283
|
### Authorization
|
4905
5284
|
|
@@ -4911,13 +5290,13 @@ end
|
|
4911
5290
|
- **Accept**: application/vnd.mx.api.v1+json
|
4912
5291
|
|
4913
5292
|
|
4914
|
-
##
|
5293
|
+
## list_user_accounts
|
4915
5294
|
|
4916
|
-
> <
|
5295
|
+
> <AccountsResponseBody> list_user_accounts(user_guid, opts)
|
4917
5296
|
|
4918
|
-
|
5297
|
+
List accounts
|
4919
5298
|
|
4920
|
-
|
5299
|
+
This endpoint returns a list of all the accounts associated with the specified `user`.
|
4921
5300
|
|
4922
5301
|
### Examples
|
4923
5302
|
|
@@ -4932,33 +5311,38 @@ MxPlatformRuby.configure do |config|
|
|
4932
5311
|
end
|
4933
5312
|
|
4934
5313
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4935
|
-
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
4936
5314
|
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
|
+
}
|
4937
5321
|
|
4938
5322
|
begin
|
4939
|
-
#
|
4940
|
-
result = api_instance.
|
5323
|
+
# List accounts
|
5324
|
+
result = api_instance.list_user_accounts(user_guid, opts)
|
4941
5325
|
p result
|
4942
5326
|
rescue MxPlatformRuby::ApiError => e
|
4943
|
-
puts "Error when calling MxPlatformApi->
|
5327
|
+
puts "Error when calling MxPlatformApi->list_user_accounts: #{e}"
|
4944
5328
|
end
|
4945
5329
|
```
|
4946
5330
|
|
4947
|
-
#### Using the
|
5331
|
+
#### Using the list_user_accounts_with_http_info variant
|
4948
5332
|
|
4949
5333
|
This returns an Array which contains the response data, status code and headers.
|
4950
5334
|
|
4951
|
-
> <Array(<
|
5335
|
+
> <Array(<AccountsResponseBody>, Integer, Hash)> list_user_accounts_with_http_info(user_guid, opts)
|
4952
5336
|
|
4953
5337
|
```ruby
|
4954
5338
|
begin
|
4955
|
-
#
|
4956
|
-
data, status_code, headers = api_instance.
|
5339
|
+
# List accounts
|
5340
|
+
data, status_code, headers = api_instance.list_user_accounts_with_http_info(user_guid, opts)
|
4957
5341
|
p status_code # => 2xx
|
4958
5342
|
p headers # => { ... }
|
4959
|
-
p data # => <
|
5343
|
+
p data # => <AccountsResponseBody>
|
4960
5344
|
rescue MxPlatformRuby::ApiError => e
|
4961
|
-
puts "Error when calling MxPlatformApi->
|
5345
|
+
puts "Error when calling MxPlatformApi->list_user_accounts_with_http_info: #{e}"
|
4962
5346
|
end
|
4963
5347
|
```
|
4964
5348
|
|
@@ -4966,12 +5350,15 @@ end
|
|
4966
5350
|
|
4967
5351
|
| Name | Type | Description | Notes |
|
4968
5352
|
| ---- | ---- | ----------- | ----- |
|
4969
|
-
| **category_guid** | **String** | The unique id for a `category`. | |
|
4970
5353
|
| **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] |
|
4971
5358
|
|
4972
5359
|
### Return type
|
4973
5360
|
|
4974
|
-
[**
|
5361
|
+
[**AccountsResponseBody**](AccountsResponseBody.md)
|
4975
5362
|
|
4976
5363
|
### Authorization
|
4977
5364
|
|
@@ -4983,13 +5370,13 @@ end
|
|
4983
5370
|
- **Accept**: application/vnd.mx.api.v1+json
|
4984
5371
|
|
4985
5372
|
|
4986
|
-
##
|
5373
|
+
## list_users
|
4987
5374
|
|
4988
|
-
> <
|
5375
|
+
> <UsersResponseBody> list_users(opts)
|
4989
5376
|
|
4990
|
-
|
5377
|
+
List users
|
4991
5378
|
|
4992
|
-
Use this endpoint to
|
5379
|
+
Use this endpoint to list every user you've created in the MX Platform API.
|
4993
5380
|
|
4994
5381
|
### Examples
|
4995
5382
|
|
@@ -5004,32 +5391,38 @@ MxPlatformRuby.configure do |config|
|
|
5004
5391
|
end
|
5005
5392
|
|
5006
5393
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5007
|
-
|
5394
|
+
opts = {
|
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
|
+
}
|
5008
5401
|
|
5009
5402
|
begin
|
5010
|
-
#
|
5011
|
-
result = api_instance.
|
5403
|
+
# List users
|
5404
|
+
result = api_instance.list_users(opts)
|
5012
5405
|
p result
|
5013
5406
|
rescue MxPlatformRuby::ApiError => e
|
5014
|
-
puts "Error when calling MxPlatformApi->
|
5407
|
+
puts "Error when calling MxPlatformApi->list_users: #{e}"
|
5015
5408
|
end
|
5016
5409
|
```
|
5017
5410
|
|
5018
|
-
#### Using the
|
5411
|
+
#### Using the list_users_with_http_info variant
|
5019
5412
|
|
5020
5413
|
This returns an Array which contains the response data, status code and headers.
|
5021
5414
|
|
5022
|
-
> <Array(<
|
5415
|
+
> <Array(<UsersResponseBody>, Integer, Hash)> list_users_with_http_info(opts)
|
5023
5416
|
|
5024
5417
|
```ruby
|
5025
5418
|
begin
|
5026
|
-
#
|
5027
|
-
data, status_code, headers = api_instance.
|
5419
|
+
# List users
|
5420
|
+
data, status_code, headers = api_instance.list_users_with_http_info(opts)
|
5028
5421
|
p status_code # => 2xx
|
5029
5422
|
p headers # => { ... }
|
5030
|
-
p data # => <
|
5423
|
+
p data # => <UsersResponseBody>
|
5031
5424
|
rescue MxPlatformRuby::ApiError => e
|
5032
|
-
puts "Error when calling MxPlatformApi->
|
5425
|
+
puts "Error when calling MxPlatformApi->list_users_with_http_info: #{e}"
|
5033
5426
|
end
|
5034
5427
|
```
|
5035
5428
|
|
@@ -5037,11 +5430,15 @@ end
|
|
5037
5430
|
|
5038
5431
|
| Name | Type | Description | Notes |
|
5039
5432
|
| ---- | ---- | ----------- | ----- |
|
5040
|
-
| **
|
5433
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
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] |
|
5041
5438
|
|
5042
5439
|
### Return type
|
5043
5440
|
|
5044
|
-
[**
|
5441
|
+
[**UsersResponseBody**](UsersResponseBody.md)
|
5045
5442
|
|
5046
5443
|
### Authorization
|
5047
5444
|
|
@@ -5053,13 +5450,13 @@ end
|
|
5053
5450
|
- **Accept**: application/vnd.mx.api.v1+json
|
5054
5451
|
|
5055
5452
|
|
5056
|
-
##
|
5453
|
+
## read_account
|
5057
5454
|
|
5058
|
-
> <
|
5455
|
+
> <AccountResponseBody> read_account(account_guid, user_guid)
|
5059
5456
|
|
5060
|
-
Read
|
5457
|
+
Read account
|
5061
5458
|
|
5062
|
-
|
5459
|
+
This endpoint returns the specified `account` resource.
|
5063
5460
|
|
5064
5461
|
### Examples
|
5065
5462
|
|
@@ -5074,33 +5471,33 @@ MxPlatformRuby.configure do |config|
|
|
5074
5471
|
end
|
5075
5472
|
|
5076
5473
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5077
|
-
|
5474
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5078
5475
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5079
5476
|
|
5080
5477
|
begin
|
5081
|
-
# Read
|
5082
|
-
result = api_instance.
|
5478
|
+
# Read account
|
5479
|
+
result = api_instance.read_account(account_guid, user_guid)
|
5083
5480
|
p result
|
5084
5481
|
rescue MxPlatformRuby::ApiError => e
|
5085
|
-
puts "Error when calling MxPlatformApi->
|
5482
|
+
puts "Error when calling MxPlatformApi->read_account: #{e}"
|
5086
5483
|
end
|
5087
5484
|
```
|
5088
5485
|
|
5089
|
-
#### Using the
|
5486
|
+
#### Using the read_account_with_http_info variant
|
5090
5487
|
|
5091
5488
|
This returns an Array which contains the response data, status code and headers.
|
5092
5489
|
|
5093
|
-
> <Array(<
|
5490
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_account_with_http_info(account_guid, user_guid)
|
5094
5491
|
|
5095
5492
|
```ruby
|
5096
5493
|
begin
|
5097
|
-
# Read
|
5098
|
-
data, status_code, headers = api_instance.
|
5494
|
+
# Read account
|
5495
|
+
data, status_code, headers = api_instance.read_account_with_http_info(account_guid, user_guid)
|
5099
5496
|
p status_code # => 2xx
|
5100
5497
|
p headers # => { ... }
|
5101
|
-
p data # => <
|
5498
|
+
p data # => <AccountResponseBody>
|
5102
5499
|
rescue MxPlatformRuby::ApiError => e
|
5103
|
-
puts "Error when calling MxPlatformApi->
|
5500
|
+
puts "Error when calling MxPlatformApi->read_account_with_http_info: #{e}"
|
5104
5501
|
end
|
5105
5502
|
```
|
5106
5503
|
|
@@ -5108,12 +5505,12 @@ end
|
|
5108
5505
|
|
5109
5506
|
| Name | Type | Description | Notes |
|
5110
5507
|
| ---- | ---- | ----------- | ----- |
|
5111
|
-
| **
|
5508
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
5112
5509
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5113
5510
|
|
5114
5511
|
### Return type
|
5115
5512
|
|
5116
|
-
[**
|
5513
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
5117
5514
|
|
5118
5515
|
### Authorization
|
5119
5516
|
|
@@ -5125,13 +5522,13 @@ end
|
|
5125
5522
|
- **Accept**: application/vnd.mx.api.v1+json
|
5126
5523
|
|
5127
5524
|
|
5128
|
-
##
|
5525
|
+
## read_account_by_member
|
5129
5526
|
|
5130
|
-
> <
|
5527
|
+
> <AccountResponseBody> read_account_by_member(account_guid, member_guid, user_guid)
|
5131
5528
|
|
5132
|
-
Read
|
5529
|
+
Read account by member
|
5133
5530
|
|
5134
|
-
This endpoint
|
5531
|
+
This endpoint allows you to read the attributes of an `account` resource.
|
5135
5532
|
|
5136
5533
|
### Examples
|
5137
5534
|
|
@@ -5146,32 +5543,613 @@ MxPlatformRuby.configure do |config|
|
|
5146
5543
|
end
|
5147
5544
|
|
5148
5545
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5149
|
-
|
5546
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
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`.
|
5150
5549
|
|
5151
5550
|
begin
|
5152
|
-
# Read
|
5153
|
-
result = api_instance.
|
5551
|
+
# Read account by member
|
5552
|
+
result = api_instance.read_account_by_member(account_guid, member_guid, user_guid)
|
5154
5553
|
p result
|
5155
5554
|
rescue MxPlatformRuby::ApiError => e
|
5156
|
-
puts "Error when calling MxPlatformApi->
|
5555
|
+
puts "Error when calling MxPlatformApi->read_account_by_member: #{e}"
|
5157
5556
|
end
|
5158
5557
|
```
|
5159
5558
|
|
5160
|
-
#### Using the
|
5559
|
+
#### Using the read_account_by_member_with_http_info variant
|
5161
5560
|
|
5162
5561
|
This returns an Array which contains the response data, status code and headers.
|
5163
5562
|
|
5164
|
-
> <Array(<
|
5563
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
|
5165
5564
|
|
5166
5565
|
```ruby
|
5167
5566
|
begin
|
5168
|
-
# Read
|
5169
|
-
data, status_code, headers = api_instance.
|
5567
|
+
# Read account by member
|
5568
|
+
data, status_code, headers = api_instance.read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
|
5170
5569
|
p status_code # => 2xx
|
5171
5570
|
p headers # => { ... }
|
5172
|
-
p data # => <
|
5571
|
+
p data # => <AccountResponseBody>
|
5173
5572
|
rescue MxPlatformRuby::ApiError => e
|
5174
|
-
puts "Error when calling MxPlatformApi->
|
5573
|
+
puts "Error when calling MxPlatformApi->read_account_by_member_with_http_info: #{e}"
|
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}"
|
5175
6153
|
end
|
5176
6154
|
```
|
5177
6155
|
|
@@ -5179,11 +6157,12 @@ end
|
|
5179
6157
|
|
5180
6158
|
| Name | Type | Description | Notes |
|
5181
6159
|
| ---- | ---- | ----------- | ----- |
|
5182
|
-
| **
|
6160
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
6161
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
5183
6162
|
|
5184
6163
|
### Return type
|
5185
6164
|
|
5186
|
-
[**
|
6165
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
5187
6166
|
|
5188
6167
|
### Authorization
|
5189
6168
|
|
@@ -5195,13 +6174,13 @@ end
|
|
5195
6174
|
- **Accept**: application/vnd.mx.api.v1+json
|
5196
6175
|
|
5197
6176
|
|
5198
|
-
##
|
6177
|
+
## read_member_status
|
5199
6178
|
|
5200
|
-
> <
|
6179
|
+
> <MemberStatusResponseBody> read_member_status(member_guid, user_guid)
|
5201
6180
|
|
5202
|
-
Read
|
6181
|
+
Read member status
|
5203
6182
|
|
5204
|
-
|
6183
|
+
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.
|
5205
6184
|
|
5206
6185
|
### Examples
|
5207
6186
|
|
@@ -5216,34 +6195,33 @@ MxPlatformRuby.configure do |config|
|
|
5216
6195
|
end
|
5217
6196
|
|
5218
6197
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5219
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
5220
6198
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5221
6199
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5222
6200
|
|
5223
6201
|
begin
|
5224
|
-
# Read
|
5225
|
-
result = api_instance.
|
6202
|
+
# Read member status
|
6203
|
+
result = api_instance.read_member_status(member_guid, user_guid)
|
5226
6204
|
p result
|
5227
6205
|
rescue MxPlatformRuby::ApiError => e
|
5228
|
-
puts "Error when calling MxPlatformApi->
|
6206
|
+
puts "Error when calling MxPlatformApi->read_member_status: #{e}"
|
5229
6207
|
end
|
5230
6208
|
```
|
5231
6209
|
|
5232
|
-
#### Using the
|
6210
|
+
#### Using the read_member_status_with_http_info variant
|
5233
6211
|
|
5234
6212
|
This returns an Array which contains the response data, status code and headers.
|
5235
6213
|
|
5236
|
-
> <Array(<
|
6214
|
+
> <Array(<MemberStatusResponseBody>, Integer, Hash)> read_member_status_with_http_info(member_guid, user_guid)
|
5237
6215
|
|
5238
6216
|
```ruby
|
5239
6217
|
begin
|
5240
|
-
# Read
|
5241
|
-
data, status_code, headers = api_instance.
|
6218
|
+
# Read member status
|
6219
|
+
data, status_code, headers = api_instance.read_member_status_with_http_info(member_guid, user_guid)
|
5242
6220
|
p status_code # => 2xx
|
5243
6221
|
p headers # => { ... }
|
5244
|
-
p data # => <
|
6222
|
+
p data # => <MemberStatusResponseBody>
|
5245
6223
|
rescue MxPlatformRuby::ApiError => e
|
5246
|
-
puts "Error when calling MxPlatformApi->
|
6224
|
+
puts "Error when calling MxPlatformApi->read_member_status_with_http_info: #{e}"
|
5247
6225
|
end
|
5248
6226
|
```
|
5249
6227
|
|
@@ -5251,13 +6229,12 @@ end
|
|
5251
6229
|
|
5252
6230
|
| Name | Type | Description | Notes |
|
5253
6231
|
| ---- | ---- | ----------- | ----- |
|
5254
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
5255
6232
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
5256
6233
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5257
6234
|
|
5258
6235
|
### Return type
|
5259
6236
|
|
5260
|
-
[**
|
6237
|
+
[**MemberStatusResponseBody**](MemberStatusResponseBody.md)
|
5261
6238
|
|
5262
6239
|
### Authorization
|
5263
6240
|
|
@@ -5269,13 +6246,13 @@ end
|
|
5269
6246
|
- **Accept**: application/vnd.mx.api.v1+json
|
5270
6247
|
|
5271
6248
|
|
5272
|
-
##
|
6249
|
+
## read_merchant
|
5273
6250
|
|
5274
|
-
> <
|
6251
|
+
> <MerchantResponseBody> read_merchant(merchant_guid)
|
5275
6252
|
|
5276
|
-
Read
|
6253
|
+
Read merchant
|
5277
6254
|
|
5278
|
-
|
6255
|
+
Returns information about a particular merchant, such as a logo, name, and website.
|
5279
6256
|
|
5280
6257
|
### Examples
|
5281
6258
|
|
@@ -5290,33 +6267,32 @@ MxPlatformRuby.configure do |config|
|
|
5290
6267
|
end
|
5291
6268
|
|
5292
6269
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5293
|
-
|
5294
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
6270
|
+
merchant_guid = 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b' # String | The unique id for a `merchant`.
|
5295
6271
|
|
5296
6272
|
begin
|
5297
|
-
# Read
|
5298
|
-
result = api_instance.
|
6273
|
+
# Read merchant
|
6274
|
+
result = api_instance.read_merchant(merchant_guid)
|
5299
6275
|
p result
|
5300
6276
|
rescue MxPlatformRuby::ApiError => e
|
5301
|
-
puts "Error when calling MxPlatformApi->
|
6277
|
+
puts "Error when calling MxPlatformApi->read_merchant: #{e}"
|
5302
6278
|
end
|
5303
6279
|
```
|
5304
6280
|
|
5305
|
-
#### Using the
|
6281
|
+
#### Using the read_merchant_with_http_info variant
|
5306
6282
|
|
5307
6283
|
This returns an Array which contains the response data, status code and headers.
|
5308
6284
|
|
5309
|
-
> <Array(<
|
6285
|
+
> <Array(<MerchantResponseBody>, Integer, Hash)> read_merchant_with_http_info(merchant_guid)
|
5310
6286
|
|
5311
6287
|
```ruby
|
5312
6288
|
begin
|
5313
|
-
# Read
|
5314
|
-
data, status_code, headers = api_instance.
|
6289
|
+
# Read merchant
|
6290
|
+
data, status_code, headers = api_instance.read_merchant_with_http_info(merchant_guid)
|
5315
6291
|
p status_code # => 2xx
|
5316
6292
|
p headers # => { ... }
|
5317
|
-
p data # => <
|
6293
|
+
p data # => <MerchantResponseBody>
|
5318
6294
|
rescue MxPlatformRuby::ApiError => e
|
5319
|
-
puts "Error when calling MxPlatformApi->
|
6295
|
+
puts "Error when calling MxPlatformApi->read_merchant_with_http_info: #{e}"
|
5320
6296
|
end
|
5321
6297
|
```
|
5322
6298
|
|
@@ -5324,12 +6300,11 @@ end
|
|
5324
6300
|
|
5325
6301
|
| Name | Type | Description | Notes |
|
5326
6302
|
| ---- | ---- | ----------- | ----- |
|
5327
|
-
| **
|
5328
|
-
| **user_guid** | **String** | The unique id for a `user`. | |
|
6303
|
+
| **merchant_guid** | **String** | The unique id for a `merchant`. | |
|
5329
6304
|
|
5330
6305
|
### Return type
|
5331
6306
|
|
5332
|
-
[**
|
6307
|
+
[**MerchantResponseBody**](MerchantResponseBody.md)
|
5333
6308
|
|
5334
6309
|
### Authorization
|
5335
6310
|
|
@@ -5341,13 +6316,13 @@ end
|
|
5341
6316
|
- **Accept**: application/vnd.mx.api.v1+json
|
5342
6317
|
|
5343
6318
|
|
5344
|
-
##
|
6319
|
+
## read_merchant_location
|
5345
6320
|
|
5346
|
-
> <
|
6321
|
+
> <MerchantLocationResponseBody> read_merchant_location(merchant_location_guid)
|
5347
6322
|
|
5348
|
-
Read
|
6323
|
+
Read merchant location
|
5349
6324
|
|
5350
|
-
|
6325
|
+
This endpoint returns the specified merchant_location resource.
|
5351
6326
|
|
5352
6327
|
### Examples
|
5353
6328
|
|
@@ -5362,35 +6337,32 @@ MxPlatformRuby.configure do |config|
|
|
5362
6337
|
end
|
5363
6338
|
|
5364
6339
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5365
|
-
|
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`.
|
6340
|
+
merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # String | The unique id for a `merchant_location`.
|
5369
6341
|
|
5370
6342
|
begin
|
5371
|
-
# Read
|
5372
|
-
result = api_instance.
|
6343
|
+
# Read merchant location
|
6344
|
+
result = api_instance.read_merchant_location(merchant_location_guid)
|
5373
6345
|
p result
|
5374
6346
|
rescue MxPlatformRuby::ApiError => e
|
5375
|
-
puts "Error when calling MxPlatformApi->
|
6347
|
+
puts "Error when calling MxPlatformApi->read_merchant_location: #{e}"
|
5376
6348
|
end
|
5377
6349
|
```
|
5378
6350
|
|
5379
|
-
#### Using the
|
6351
|
+
#### Using the read_merchant_location_with_http_info variant
|
5380
6352
|
|
5381
6353
|
This returns an Array which contains the response data, status code and headers.
|
5382
6354
|
|
5383
|
-
> <Array(<
|
6355
|
+
> <Array(<MerchantLocationResponseBody>, Integer, Hash)> read_merchant_location_with_http_info(merchant_location_guid)
|
5384
6356
|
|
5385
6357
|
```ruby
|
5386
6358
|
begin
|
5387
|
-
# Read
|
5388
|
-
data, status_code, headers = api_instance.
|
6359
|
+
# Read merchant location
|
6360
|
+
data, status_code, headers = api_instance.read_merchant_location_with_http_info(merchant_location_guid)
|
5389
6361
|
p status_code # => 2xx
|
5390
6362
|
p headers # => { ... }
|
5391
|
-
p data # => <
|
6363
|
+
p data # => <MerchantLocationResponseBody>
|
5392
6364
|
rescue MxPlatformRuby::ApiError => e
|
5393
|
-
puts "Error when calling MxPlatformApi->
|
6365
|
+
puts "Error when calling MxPlatformApi->read_merchant_location_with_http_info: #{e}"
|
5394
6366
|
end
|
5395
6367
|
```
|
5396
6368
|
|
@@ -5398,14 +6370,11 @@ end
|
|
5398
6370
|
|
5399
6371
|
| Name | Type | Description | Notes |
|
5400
6372
|
| ---- | ---- | ----------- | ----- |
|
5401
|
-
| **
|
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`. | |
|
6373
|
+
| **merchant_location_guid** | **String** | The unique id for a `merchant_location`. | |
|
5405
6374
|
|
5406
6375
|
### Return type
|
5407
6376
|
|
5408
|
-
[**
|
6377
|
+
[**MerchantLocationResponseBody**](MerchantLocationResponseBody.md)
|
5409
6378
|
|
5410
6379
|
### Authorization
|
5411
6380
|
|
@@ -5417,13 +6386,13 @@ end
|
|
5417
6386
|
- **Accept**: application/vnd.mx.api.v1+json
|
5418
6387
|
|
5419
6388
|
|
5420
|
-
##
|
6389
|
+
## read_spending_plan_account
|
5421
6390
|
|
5422
|
-
> <
|
6391
|
+
> <SpendingPlanAccountResponse> read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
5423
6392
|
|
5424
|
-
Read
|
6393
|
+
Read spending plan account
|
5425
6394
|
|
5426
|
-
Use this endpoint to read the attributes of a specific
|
6395
|
+
Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
|
5427
6396
|
|
5428
6397
|
### Examples
|
5429
6398
|
|
@@ -5438,33 +6407,38 @@ MxPlatformRuby.configure do |config|
|
|
5438
6407
|
end
|
5439
6408
|
|
5440
6409
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5441
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5442
6410
|
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
|
+
}
|
5443
6417
|
|
5444
6418
|
begin
|
5445
|
-
# Read
|
5446
|
-
result = api_instance.
|
6419
|
+
# Read spending plan account
|
6420
|
+
result = api_instance.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
5447
6421
|
p result
|
5448
6422
|
rescue MxPlatformRuby::ApiError => e
|
5449
|
-
puts "Error when calling MxPlatformApi->
|
6423
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_account: #{e}"
|
5450
6424
|
end
|
5451
6425
|
```
|
5452
6426
|
|
5453
|
-
#### Using the
|
6427
|
+
#### Using the read_spending_plan_account_with_http_info variant
|
5454
6428
|
|
5455
6429
|
This returns an Array which contains the response data, status code and headers.
|
5456
6430
|
|
5457
|
-
> <Array(<
|
6431
|
+
> <Array(<SpendingPlanAccountResponse>, Integer, Hash)> read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
5458
6432
|
|
5459
6433
|
```ruby
|
5460
6434
|
begin
|
5461
|
-
# Read
|
5462
|
-
data, status_code, headers = api_instance.
|
6435
|
+
# Read spending plan account
|
6436
|
+
data, status_code, headers = api_instance.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
5463
6437
|
p status_code # => 2xx
|
5464
6438
|
p headers # => { ... }
|
5465
|
-
p data # => <
|
6439
|
+
p data # => <SpendingPlanAccountResponse>
|
5466
6440
|
rescue MxPlatformRuby::ApiError => e
|
5467
|
-
puts "Error when calling MxPlatformApi->
|
6441
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_account_with_http_info: #{e}"
|
5468
6442
|
end
|
5469
6443
|
```
|
5470
6444
|
|
@@ -5472,12 +6446,15 @@ end
|
|
5472
6446
|
|
5473
6447
|
| Name | Type | Description | Notes |
|
5474
6448
|
| ---- | ---- | ----------- | ----- |
|
5475
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5476
6449
|
| **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] |
|
5477
6454
|
|
5478
6455
|
### Return type
|
5479
6456
|
|
5480
|
-
[**
|
6457
|
+
[**SpendingPlanAccountResponse**](SpendingPlanAccountResponse.md)
|
5481
6458
|
|
5482
6459
|
### Authorization
|
5483
6460
|
|
@@ -5489,13 +6466,13 @@ end
|
|
5489
6466
|
- **Accept**: application/vnd.mx.api.v1+json
|
5490
6467
|
|
5491
6468
|
|
5492
|
-
##
|
6469
|
+
## read_spending_plan_iteration
|
5493
6470
|
|
5494
|
-
> <
|
6471
|
+
> <SpendingPlanIterationResponse> read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts)
|
5495
6472
|
|
5496
|
-
Read
|
6473
|
+
Read a spending plan iteration
|
5497
6474
|
|
5498
|
-
|
6475
|
+
Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
|
5499
6476
|
|
5500
6477
|
### Examples
|
5501
6478
|
|
@@ -5510,33 +6487,38 @@ MxPlatformRuby.configure do |config|
|
|
5510
6487
|
end
|
5511
6488
|
|
5512
6489
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5513
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5514
6490
|
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
|
+
}
|
5515
6497
|
|
5516
6498
|
begin
|
5517
|
-
# Read
|
5518
|
-
result = api_instance.
|
6499
|
+
# Read a spending plan iteration
|
6500
|
+
result = api_instance.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts)
|
5519
6501
|
p result
|
5520
6502
|
rescue MxPlatformRuby::ApiError => e
|
5521
|
-
puts "Error when calling MxPlatformApi->
|
6503
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_iteration: #{e}"
|
5522
6504
|
end
|
5523
6505
|
```
|
5524
6506
|
|
5525
|
-
#### Using the
|
6507
|
+
#### Using the read_spending_plan_iteration_with_http_info variant
|
5526
6508
|
|
5527
6509
|
This returns an Array which contains the response data, status code and headers.
|
5528
6510
|
|
5529
|
-
> <Array(<
|
6511
|
+
> <Array(<SpendingPlanIterationResponse>, Integer, Hash)> read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
|
5530
6512
|
|
5531
6513
|
```ruby
|
5532
6514
|
begin
|
5533
|
-
# Read
|
5534
|
-
data, status_code, headers = api_instance.
|
6515
|
+
# Read a spending plan iteration
|
6516
|
+
data, status_code, headers = api_instance.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
|
5535
6517
|
p status_code # => 2xx
|
5536
6518
|
p headers # => { ... }
|
5537
|
-
p data # => <
|
6519
|
+
p data # => <SpendingPlanIterationResponse>
|
5538
6520
|
rescue MxPlatformRuby::ApiError => e
|
5539
|
-
puts "Error when calling MxPlatformApi->
|
6521
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_iteration_with_http_info: #{e}"
|
5540
6522
|
end
|
5541
6523
|
```
|
5542
6524
|
|
@@ -5544,12 +6526,15 @@ end
|
|
5544
6526
|
|
5545
6527
|
| Name | Type | Description | Notes |
|
5546
6528
|
| ---- | ---- | ----------- | ----- |
|
5547
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
5548
6529
|
| **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] |
|
5549
6534
|
|
5550
6535
|
### Return type
|
5551
6536
|
|
5552
|
-
[**
|
6537
|
+
[**SpendingPlanIterationResponse**](SpendingPlanIterationResponse.md)
|
5553
6538
|
|
5554
6539
|
### Authorization
|
5555
6540
|
|
@@ -5561,13 +6546,13 @@ end
|
|
5561
6546
|
- **Accept**: application/vnd.mx.api.v1+json
|
5562
6547
|
|
5563
6548
|
|
5564
|
-
##
|
6549
|
+
## read_spending_plan_iteration_item
|
5565
6550
|
|
5566
|
-
> <
|
6551
|
+
> <SpendingPlanIterationItemResponse> read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
5567
6552
|
|
5568
|
-
Read
|
6553
|
+
Read a spending plan iteration item
|
5569
6554
|
|
5570
|
-
|
6555
|
+
Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
|
5571
6556
|
|
5572
6557
|
### Examples
|
5573
6558
|
|
@@ -5582,32 +6567,38 @@ MxPlatformRuby.configure do |config|
|
|
5582
6567
|
end
|
5583
6568
|
|
5584
6569
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5585
|
-
|
6570
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
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
|
+
}
|
5586
6577
|
|
5587
6578
|
begin
|
5588
|
-
# Read
|
5589
|
-
result = api_instance.
|
6579
|
+
# Read a spending plan iteration item
|
6580
|
+
result = api_instance.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
5590
6581
|
p result
|
5591
6582
|
rescue MxPlatformRuby::ApiError => e
|
5592
|
-
puts "Error when calling MxPlatformApi->
|
6583
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_iteration_item: #{e}"
|
5593
6584
|
end
|
5594
6585
|
```
|
5595
6586
|
|
5596
|
-
#### Using the
|
6587
|
+
#### Using the read_spending_plan_iteration_item_with_http_info variant
|
5597
6588
|
|
5598
6589
|
This returns an Array which contains the response data, status code and headers.
|
5599
6590
|
|
5600
|
-
> <Array(<
|
6591
|
+
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
5601
6592
|
|
5602
6593
|
```ruby
|
5603
6594
|
begin
|
5604
|
-
# Read
|
5605
|
-
data, status_code, headers = api_instance.
|
6595
|
+
# Read a spending plan iteration item
|
6596
|
+
data, status_code, headers = api_instance.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
5606
6597
|
p status_code # => 2xx
|
5607
6598
|
p headers # => { ... }
|
5608
|
-
p data # => <
|
6599
|
+
p data # => <SpendingPlanIterationItemResponse>
|
5609
6600
|
rescue MxPlatformRuby::ApiError => e
|
5610
|
-
puts "Error when calling MxPlatformApi->
|
6601
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_iteration_item_with_http_info: #{e}"
|
5611
6602
|
end
|
5612
6603
|
```
|
5613
6604
|
|
@@ -5615,11 +6606,15 @@ end
|
|
5615
6606
|
|
5616
6607
|
| Name | Type | Description | Notes |
|
5617
6608
|
| ---- | ---- | ----------- | ----- |
|
5618
|
-
| **
|
6609
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
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] |
|
5619
6614
|
|
5620
6615
|
### Return type
|
5621
6616
|
|
5622
|
-
[**
|
6617
|
+
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
5623
6618
|
|
5624
6619
|
### Authorization
|
5625
6620
|
|
@@ -5631,13 +6626,13 @@ end
|
|
5631
6626
|
- **Accept**: application/vnd.mx.api.v1+json
|
5632
6627
|
|
5633
6628
|
|
5634
|
-
##
|
6629
|
+
## read_spending_plan_user
|
5635
6630
|
|
5636
|
-
> <
|
6631
|
+
> <SpendingPlanResponse> read_spending_plan_user(user_guid, spending_plan_guid, opts)
|
5637
6632
|
|
5638
|
-
Read
|
6633
|
+
Read a spending plan for a user
|
5639
6634
|
|
5640
|
-
|
6635
|
+
Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
|
5641
6636
|
|
5642
6637
|
### Examples
|
5643
6638
|
|
@@ -5652,32 +6647,37 @@ MxPlatformRuby.configure do |config|
|
|
5652
6647
|
end
|
5653
6648
|
|
5654
6649
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5655
|
-
|
6650
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
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
|
+
}
|
5656
6656
|
|
5657
6657
|
begin
|
5658
|
-
# Read
|
5659
|
-
result = api_instance.
|
6658
|
+
# Read a spending plan for a user
|
6659
|
+
result = api_instance.read_spending_plan_user(user_guid, spending_plan_guid, opts)
|
5660
6660
|
p result
|
5661
6661
|
rescue MxPlatformRuby::ApiError => e
|
5662
|
-
puts "Error when calling MxPlatformApi->
|
6662
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_user: #{e}"
|
5663
6663
|
end
|
5664
6664
|
```
|
5665
6665
|
|
5666
|
-
#### Using the
|
6666
|
+
#### Using the read_spending_plan_user_with_http_info variant
|
5667
6667
|
|
5668
6668
|
This returns an Array which contains the response data, status code and headers.
|
5669
6669
|
|
5670
|
-
> <Array(<
|
6670
|
+
> <Array(<SpendingPlanResponse>, Integer, Hash)> read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
|
5671
6671
|
|
5672
6672
|
```ruby
|
5673
6673
|
begin
|
5674
|
-
# Read
|
5675
|
-
data, status_code, headers = api_instance.
|
6674
|
+
# Read a spending plan for a user
|
6675
|
+
data, status_code, headers = api_instance.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
|
5676
6676
|
p status_code # => 2xx
|
5677
6677
|
p headers # => { ... }
|
5678
|
-
p data # => <
|
6678
|
+
p data # => <SpendingPlanResponse>
|
5679
6679
|
rescue MxPlatformRuby::ApiError => e
|
5680
|
-
puts "Error when calling MxPlatformApi->
|
6680
|
+
puts "Error when calling MxPlatformApi->read_spending_plan_user_with_http_info: #{e}"
|
5681
6681
|
end
|
5682
6682
|
```
|
5683
6683
|
|
@@ -5685,11 +6685,14 @@ end
|
|
5685
6685
|
|
5686
6686
|
| Name | Type | Description | Notes |
|
5687
6687
|
| ---- | ---- | ----------- | ----- |
|
5688
|
-
| **
|
6688
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
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] |
|
5689
6692
|
|
5690
6693
|
### Return type
|
5691
6694
|
|
5692
|
-
[**
|
6695
|
+
[**SpendingPlanResponse**](SpendingPlanResponse.md)
|
5693
6696
|
|
5694
6697
|
### Authorization
|
5695
6698
|
|
@@ -7035,6 +8038,82 @@ end
|
|
7035
8038
|
- **Accept**: application/vnd.mx.api.v1+json
|
7036
8039
|
|
7037
8040
|
|
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
|
+
|
7038
8117
|
## update_tag
|
7039
8118
|
|
7040
8119
|
> <TagResponseBody> update_tag(tag_guid, user_guid, tag_update_request_body)
|