mx-platform-ruby 0.6.2 → 0.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +17 -11
- data/LICENSE +1 -1
- data/README.md +31 -18
- data/docs/EnhanceTransactionResponse.md +19 -5
- data/docs/EnhanceTransactionsRequest.md +6 -2
- data/docs/MxPlatformApi.md +168 -20
- data/docs/TransactionResponse.md +4 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +145 -31
- data/lib/mx-platform-ruby/api_client.rb +1 -1
- data/lib/mx-platform-ruby/api_error.rb +1 -1
- data/lib/mx-platform-ruby/configuration.rb +1 -1
- data/lib/mx-platform-ruby/models/account_number_response.rb +1 -1
- data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/account_owner_response.rb +1 -1
- data/lib/mx-platform-ruby/models/account_owners_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/account_response.rb +1 -1
- data/lib/mx-platform-ruby/models/account_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/account_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/account_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/accounts_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/categories_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/category_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/category_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/category_response.rb +1 -1
- data/lib/mx-platform-ruby/models/category_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/category_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/category_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/challenge_response.rb +1 -1
- data/lib/mx-platform-ruby/models/challenges_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/connect_widget_request.rb +1 -1
- data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/connect_widget_response.rb +1 -1
- data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/credential_request.rb +1 -1
- data/lib/mx-platform-ruby/models/credential_response.rb +1 -1
- data/lib/mx-platform-ruby/models/credentials_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +72 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +20 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/holding_response.rb +1 -1
- data/lib/mx-platform-ruby/models/holding_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/holdings_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/image_option_response.rb +1 -1
- data/lib/mx-platform-ruby/models/institution_response.rb +1 -1
- data/lib/mx-platform-ruby/models/institution_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/institutions_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_account_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_account_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_member_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_member_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/member_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_response.rb +1 -1
- data/lib/mx-platform-ruby/models/member_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_resume_request.rb +1 -1
- data/lib/mx-platform-ruby/models/member_resume_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_status_response.rb +1 -1
- data/lib/mx-platform-ruby/models/member_status_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/member_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/members_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/merchant_location_response.rb +1 -1
- data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/merchant_response.rb +1 -1
- data/lib/mx-platform-ruby/models/merchant_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/merchants_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/o_auth_window_response.rb +1 -1
- data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/option_response.rb +1 -1
- data/lib/mx-platform-ruby/models/pagination_response.rb +1 -1
- data/lib/mx-platform-ruby/models/statement_response.rb +1 -1
- data/lib/mx-platform-ruby/models/statement_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/statements_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_response.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/tag_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_response.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/taggings_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tags_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_response.rb +22 -2
- data/lib/mx-platform-ruby/models/transaction_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_response.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transactions_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/user_create_request.rb +1 -1
- data/lib/mx-platform-ruby/models/user_create_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/user_response.rb +1 -1
- data/lib/mx-platform-ruby/models/user_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/user_update_request.rb +1 -1
- data/lib/mx-platform-ruby/models/user_update_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/users_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/widget_request.rb +1 -1
- data/lib/mx-platform-ruby/models/widget_request_body.rb +1 -1
- data/lib/mx-platform-ruby/models/widget_response.rb +1 -1
- data/lib/mx-platform-ruby/models/widget_response_body.rb +1 -1
- data/lib/mx-platform-ruby/version.rb +2 -2
- data/lib/mx-platform-ruby.rb +1 -1
- data/mx-platform-ruby.gemspec +1 -1
- data/openapi/config.yml +1 -1
- data/openapi/templates/README.mustache +31 -20
- data/spec/api/mx_platform_api_spec.rb +30 -4
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_number_response_spec.rb +1 -1
- data/spec/models/account_numbers_response_body_spec.rb +1 -1
- data/spec/models/account_owner_response_spec.rb +1 -1
- data/spec/models/account_owners_response_body_spec.rb +1 -1
- data/spec/models/account_response_body_spec.rb +1 -1
- data/spec/models/account_response_spec.rb +1 -1
- data/spec/models/account_update_request_body_spec.rb +1 -1
- data/spec/models/account_update_request_spec.rb +1 -1
- data/spec/models/accounts_response_body_spec.rb +1 -1
- data/spec/models/categories_response_body_spec.rb +1 -1
- data/spec/models/category_create_request_body_spec.rb +1 -1
- data/spec/models/category_create_request_spec.rb +1 -1
- data/spec/models/category_response_body_spec.rb +1 -1
- data/spec/models/category_response_spec.rb +1 -1
- data/spec/models/category_update_request_body_spec.rb +1 -1
- data/spec/models/category_update_request_spec.rb +1 -1
- data/spec/models/challenge_response_spec.rb +1 -1
- data/spec/models/challenges_response_body_spec.rb +1 -1
- data/spec/models/connect_widget_request_body_spec.rb +1 -1
- data/spec/models/connect_widget_request_spec.rb +1 -1
- data/spec/models/connect_widget_response_body_spec.rb +1 -1
- data/spec/models/connect_widget_response_spec.rb +1 -1
- data/spec/models/credential_request_spec.rb +1 -1
- data/spec/models/credential_response_spec.rb +1 -1
- data/spec/models/credentials_response_body_spec.rb +1 -1
- data/spec/models/enhance_transaction_response_spec.rb +43 -1
- data/spec/models/enhance_transactions_request_body_spec.rb +1 -1
- data/spec/models/enhance_transactions_request_spec.rb +13 -1
- data/spec/models/enhance_transactions_response_body_spec.rb +1 -1
- data/spec/models/holding_response_body_spec.rb +1 -1
- data/spec/models/holding_response_spec.rb +1 -1
- data/spec/models/holdings_response_body_spec.rb +1 -1
- data/spec/models/image_option_response_spec.rb +1 -1
- data/spec/models/institution_response_body_spec.rb +1 -1
- data/spec/models/institution_response_spec.rb +1 -1
- data/spec/models/institutions_response_body_spec.rb +1 -1
- data/spec/models/managed_account_create_request_body_spec.rb +1 -1
- data/spec/models/managed_account_create_request_spec.rb +1 -1
- data/spec/models/managed_account_update_request_body_spec.rb +1 -1
- data/spec/models/managed_account_update_request_spec.rb +1 -1
- data/spec/models/managed_member_create_request_body_spec.rb +1 -1
- data/spec/models/managed_member_create_request_spec.rb +1 -1
- data/spec/models/managed_member_update_request_body_spec.rb +1 -1
- data/spec/models/managed_member_update_request_spec.rb +1 -1
- data/spec/models/managed_transaction_create_request_body_spec.rb +1 -1
- data/spec/models/managed_transaction_create_request_spec.rb +1 -1
- data/spec/models/managed_transaction_update_request_body_spec.rb +1 -1
- data/spec/models/managed_transaction_update_request_spec.rb +1 -1
- data/spec/models/member_create_request_body_spec.rb +1 -1
- data/spec/models/member_create_request_spec.rb +1 -1
- data/spec/models/member_response_body_spec.rb +1 -1
- data/spec/models/member_response_spec.rb +1 -1
- data/spec/models/member_resume_request_body_spec.rb +1 -1
- data/spec/models/member_resume_request_spec.rb +1 -1
- data/spec/models/member_status_response_body_spec.rb +1 -1
- data/spec/models/member_status_response_spec.rb +1 -1
- data/spec/models/member_update_request_body_spec.rb +1 -1
- data/spec/models/member_update_request_spec.rb +1 -1
- data/spec/models/members_response_body_spec.rb +1 -1
- data/spec/models/merchant_location_response_body_spec.rb +1 -1
- data/spec/models/merchant_location_response_spec.rb +1 -1
- data/spec/models/merchant_response_body_spec.rb +1 -1
- data/spec/models/merchant_response_spec.rb +1 -1
- data/spec/models/merchants_response_body_spec.rb +1 -1
- data/spec/models/o_auth_window_response_body_spec.rb +1 -1
- data/spec/models/o_auth_window_response_spec.rb +1 -1
- data/spec/models/option_response_spec.rb +1 -1
- data/spec/models/pagination_response_spec.rb +1 -1
- data/spec/models/statement_response_body_spec.rb +1 -1
- data/spec/models/statement_response_spec.rb +1 -1
- data/spec/models/statements_response_body_spec.rb +1 -1
- data/spec/models/tag_create_request_body_spec.rb +1 -1
- data/spec/models/tag_create_request_spec.rb +1 -1
- data/spec/models/tag_response_body_spec.rb +1 -1
- data/spec/models/tag_response_spec.rb +1 -1
- data/spec/models/tag_update_request_body_spec.rb +1 -1
- data/spec/models/tag_update_request_spec.rb +1 -1
- data/spec/models/tagging_create_request_body_spec.rb +1 -1
- data/spec/models/tagging_create_request_spec.rb +1 -1
- data/spec/models/tagging_response_body_spec.rb +1 -1
- data/spec/models/tagging_response_spec.rb +1 -1
- data/spec/models/tagging_update_request_body_spec.rb +1 -1
- data/spec/models/tagging_update_request_spec.rb +1 -1
- data/spec/models/taggings_response_body_spec.rb +1 -1
- data/spec/models/tags_response_body_spec.rb +1 -1
- data/spec/models/transaction_response_body_spec.rb +1 -1
- data/spec/models/transaction_response_spec.rb +13 -1
- data/spec/models/transaction_rule_create_request_body_spec.rb +1 -1
- data/spec/models/transaction_rule_create_request_spec.rb +1 -1
- data/spec/models/transaction_rule_response_body_spec.rb +1 -1
- data/spec/models/transaction_rule_response_spec.rb +1 -1
- data/spec/models/transaction_rule_update_request_body_spec.rb +1 -1
- data/spec/models/transaction_rule_update_request_spec.rb +1 -1
- data/spec/models/transaction_rules_response_body_spec.rb +1 -1
- data/spec/models/transaction_update_request_body_spec.rb +1 -1
- data/spec/models/transaction_update_request_spec.rb +1 -1
- data/spec/models/transactions_response_body_spec.rb +1 -1
- data/spec/models/user_create_request_body_spec.rb +1 -1
- data/spec/models/user_create_request_spec.rb +1 -1
- data/spec/models/user_response_body_spec.rb +1 -1
- data/spec/models/user_response_spec.rb +1 -1
- data/spec/models/user_update_request_body_spec.rb +1 -1
- data/spec/models/user_update_request_spec.rb +1 -1
- data/spec/models/users_response_body_spec.rb +1 -1
- data/spec/models/widget_request_body_spec.rb +1 -1
- data/spec/models/widget_request_spec.rb +1 -1
- data/spec/models/widget_response_body_spec.rb +1 -1
- data/spec/models/widget_response_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +91 -91
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f94472a4f074aa3a1903cf951ba6a21912f6a2dd581af12b02b37d6e9a778032
|
4
|
+
data.tar.gz: cecf249be5b5a0b7e23c7fa04cf1269bcf462ea25dd99f50fce92836dc9a8c79
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9c42900368ed67a2eca0d5ba990925029e1e71cff77e2a2dd777606d6317aecb6f2aee56eba5097e9e7b91c6ab117e13db628391789f2b3a7a68cf104dbc9542
|
7
|
+
data.tar.gz: 166386c95d3fcebdc4f790692abc2e45980d3f2a1bde7d830b4c9107ec2ac8fba9863b4468d58d58493a560c866ae8f1c580a1e912e0a73b2d00325f9f1f8e3f
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
mx-platform-ruby (0.
|
4
|
+
mx-platform-ruby (0.8.1)
|
5
5
|
faraday (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -10,31 +10,35 @@ GEM
|
|
10
10
|
ast (2.4.2)
|
11
11
|
byebug (11.1.3)
|
12
12
|
coderay (1.1.3)
|
13
|
-
diff-lcs (1.
|
14
|
-
faraday (1.
|
13
|
+
diff-lcs (1.5.0)
|
14
|
+
faraday (1.9.3)
|
15
15
|
faraday-em_http (~> 1.0)
|
16
16
|
faraday-em_synchrony (~> 1.0)
|
17
17
|
faraday-excon (~> 1.1)
|
18
|
-
faraday-httpclient (~> 1.0
|
18
|
+
faraday-httpclient (~> 1.0)
|
19
|
+
faraday-multipart (~> 1.0)
|
19
20
|
faraday-net_http (~> 1.0)
|
20
|
-
faraday-net_http_persistent (~> 1.
|
21
|
+
faraday-net_http_persistent (~> 1.0)
|
21
22
|
faraday-patron (~> 1.0)
|
22
23
|
faraday-rack (~> 1.0)
|
23
|
-
|
24
|
+
faraday-retry (~> 1.0)
|
24
25
|
ruby2_keywords (>= 0.0.4)
|
25
26
|
faraday-em_http (1.0.0)
|
26
27
|
faraday-em_synchrony (1.0.0)
|
27
28
|
faraday-excon (1.1.0)
|
28
29
|
faraday-httpclient (1.0.1)
|
30
|
+
faraday-multipart (1.0.3)
|
31
|
+
multipart-post (>= 1.2, < 3)
|
29
32
|
faraday-net_http (1.0.1)
|
30
33
|
faraday-net_http_persistent (1.2.0)
|
31
34
|
faraday-patron (1.0.0)
|
32
35
|
faraday-rack (1.0.0)
|
36
|
+
faraday-retry (1.0.3)
|
33
37
|
jaro_winkler (1.5.4)
|
34
38
|
method_source (1.0.0)
|
35
39
|
multipart-post (2.1.1)
|
36
40
|
parallel (1.21.0)
|
37
|
-
parser (3.0.
|
41
|
+
parser (3.1.0.0)
|
38
42
|
ast (~> 2.4.1)
|
39
43
|
pry (0.13.1)
|
40
44
|
coderay (~> 1.1)
|
@@ -42,8 +46,9 @@ GEM
|
|
42
46
|
pry-byebug (3.9.0)
|
43
47
|
byebug (~> 11.0)
|
44
48
|
pry (~> 0.13.0)
|
45
|
-
psych (4.0.
|
46
|
-
|
49
|
+
psych (4.0.3)
|
50
|
+
stringio
|
51
|
+
rainbow (3.1.1)
|
47
52
|
rake (13.0.6)
|
48
53
|
rspec (3.10.0)
|
49
54
|
rspec-core (~> 3.10.0)
|
@@ -51,7 +56,7 @@ GEM
|
|
51
56
|
rspec-mocks (~> 3.10.0)
|
52
57
|
rspec-core (3.10.1)
|
53
58
|
rspec-support (~> 3.10.0)
|
54
|
-
rspec-expectations (3.10.
|
59
|
+
rspec-expectations (3.10.2)
|
55
60
|
diff-lcs (>= 1.2.0, < 2.0)
|
56
61
|
rspec-support (~> 3.10.0)
|
57
62
|
rspec-mocks (3.10.2)
|
@@ -68,6 +73,7 @@ GEM
|
|
68
73
|
unicode-display_width (>= 1.4.0, < 1.6)
|
69
74
|
ruby-progressbar (1.11.0)
|
70
75
|
ruby2_keywords (0.0.5)
|
76
|
+
stringio (3.0.1)
|
71
77
|
unicode-display_width (1.5.0)
|
72
78
|
|
73
79
|
PLATFORMS
|
@@ -81,4 +87,4 @@ DEPENDENCIES
|
|
81
87
|
rubocop (~> 0.66.0)
|
82
88
|
|
83
89
|
BUNDLED WITH
|
84
|
-
2.
|
90
|
+
2.3.5
|
data/LICENSE
CHANGED
data/README.md
CHANGED
@@ -1,12 +1,16 @@
|
|
1
|
-
*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform
|
1
|
+
*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform Ruby library.*
|
2
2
|
|
3
|
-
|
3
|
+
# MX Platform Ruby
|
4
4
|
|
5
|
-
|
5
|
+
The [MX Platform API](https://www.mx.com/products/platform-api) is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
|
6
6
|
|
7
|
-
|
7
|
+
## Documentation
|
8
|
+
|
9
|
+
Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
|
10
|
+
|
11
|
+
## Requirements
|
8
12
|
|
9
|
-
|
13
|
+
- Ruby >= 2.6
|
10
14
|
|
11
15
|
## Installation
|
12
16
|
|
@@ -18,31 +22,28 @@ gem 'mx-platform-ruby'
|
|
18
22
|
|
19
23
|
And then execute:
|
20
24
|
```shell
|
21
|
-
|
25
|
+
bundle
|
22
26
|
```
|
23
27
|
|
24
28
|
Or install it yourself with:
|
25
29
|
```shell
|
26
|
-
|
30
|
+
gem install mx-platform-ruby
|
27
31
|
```
|
28
32
|
|
29
33
|
## Getting Started
|
30
34
|
|
31
35
|
In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
|
32
36
|
|
33
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
34
|
-
|
37
|
+
Please follow the [installation](#installation) procedure and then run the following code to create your first User:
|
35
38
|
```ruby
|
36
|
-
# Load the gem
|
37
39
|
require 'mx-platform-ruby'
|
38
40
|
|
39
|
-
# setup authorization
|
40
41
|
MxPlatformRuby.configure do |config|
|
41
|
-
# Configure
|
42
|
-
config.username = 'Your Client ID
|
43
|
-
config.password = 'Your API Key
|
42
|
+
# Configure with your Client ID/API Key from https://dashboard.mx.com
|
43
|
+
config.username = 'Your Client ID'
|
44
|
+
config.password = 'Your API Key'
|
44
45
|
|
45
|
-
# Configure
|
46
|
+
# Configure environment. 0 for production, 1 for development
|
46
47
|
config.server_index = 1
|
47
48
|
end
|
48
49
|
|
@@ -54,7 +55,6 @@ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
|
|
54
55
|
)
|
55
56
|
|
56
57
|
begin
|
57
|
-
# Create user
|
58
58
|
result = api_instance.create_user(user_create_request_body)
|
59
59
|
p result
|
60
60
|
rescue MxPlatformRuby::ApiError => e
|
@@ -62,6 +62,19 @@ rescue MxPlatformRuby::ApiError => e
|
|
62
62
|
end
|
63
63
|
```
|
64
64
|
|
65
|
-
##
|
65
|
+
## Development
|
66
|
+
|
67
|
+
This project was generated by the [OpenAPI Generator](https://openapi-generator.tech). To generate this library, verify you have the latest version of the `openapi-generator-cli` found [here.](https://github.com/OpenAPITools/openapi-generator#17---npm)
|
68
|
+
|
69
|
+
Running the following command in this repo's directory will generate this library using the [MX Platform API OpenAPI spec](https://github.com/mxenabled/openapi/blob/master/openapi/mx_platform_api_beta.yml) with our [configuration and templates.](https://github.com/mxenabled/mx-platform-ruby/tree/master/openapi)
|
70
|
+
```shell
|
71
|
+
openapi-generator-cli generate \
|
72
|
+
-i https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api_beta.yml \
|
73
|
+
-g ruby \
|
74
|
+
-c ./openapi/config.yml \
|
75
|
+
-t ./openapi/templates
|
76
|
+
```
|
77
|
+
|
78
|
+
## Contributing
|
66
79
|
|
67
|
-
|
80
|
+
Please [open an issue](https://github.com/mxenabled/mx-platform-ruby/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-ruby/pulls)
|
@@ -5,8 +5,12 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | | [optional] |
|
8
|
+
| **categorized_by** | **Integer** | | [optional] |
|
8
9
|
| **category** | **String** | | [optional] |
|
10
|
+
| **category_guid** | **String** | | [optional] |
|
11
|
+
| **described_by** | **Integer** | | [optional] |
|
9
12
|
| **description** | **String** | | [optional] |
|
13
|
+
| **extended_transaction_type** | **String** | | [optional] |
|
10
14
|
| **id** | **String** | | [optional] |
|
11
15
|
| **is_bill_pay** | **Boolean** | | [optional] |
|
12
16
|
| **is_direct_deposit** | **Boolean** | | [optional] |
|
@@ -16,8 +20,11 @@
|
|
16
20
|
| **is_international** | **Boolean** | | [optional] |
|
17
21
|
| **is_overdraft_fee** | **Boolean** | | [optional] |
|
18
22
|
| **is_payroll_advance** | **Boolean** | | [optional] |
|
23
|
+
| **is_subscription** | **Boolean** | | [optional] |
|
24
|
+
| **memo** | **String** | | [optional] |
|
19
25
|
| **merchant_category_code** | **Integer** | | [optional] |
|
20
26
|
| **merchant_guid** | **String** | | [optional] |
|
27
|
+
| **merchant_location_guid** | **String** | | [optional] |
|
21
28
|
| **original_description** | **String** | | [optional] |
|
22
29
|
| **type** | **String** | | [optional] |
|
23
30
|
|
@@ -28,8 +35,12 @@ require 'mx-platform-ruby'
|
|
28
35
|
|
29
36
|
instance = MxPlatformRuby::EnhanceTransactionResponse.new(
|
30
37
|
amount: 21.33,
|
31
|
-
|
32
|
-
|
38
|
+
categorized_by: 13,
|
39
|
+
category: Rental Car & Taxi,
|
40
|
+
category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8,
|
41
|
+
described_by: 6,
|
42
|
+
description: Uber,
|
43
|
+
extended_transaction_type: partner_transaction_type,
|
33
44
|
id: ID-123,
|
34
45
|
is_bill_pay: false,
|
35
46
|
is_direct_deposit: false,
|
@@ -39,9 +50,12 @@ instance = MxPlatformRuby::EnhanceTransactionResponse.new(
|
|
39
50
|
is_international: false,
|
40
51
|
is_overdraft_fee: false,
|
41
52
|
is_payroll_advance: false,
|
42
|
-
|
43
|
-
|
44
|
-
|
53
|
+
is_subscription: false,
|
54
|
+
memo: Additional-information*on_transaction,
|
55
|
+
merchant_category_code: 4121,
|
56
|
+
merchant_guid: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e,
|
57
|
+
merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
|
58
|
+
original_description: ubr* pending.uber.com,
|
45
59
|
type: DEBIT
|
46
60
|
)
|
47
61
|
```
|
@@ -6,7 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | | [optional] |
|
8
8
|
| **description** | **String** | | |
|
9
|
+
| **extended_transaction_type** | **String** | | [optional] |
|
9
10
|
| **id** | **String** | | |
|
11
|
+
| **memo** | **String** | | [optional] |
|
10
12
|
| **merchant_category_code** | **Integer** | | [optional] |
|
11
13
|
| **type** | **String** | | [optional] |
|
12
14
|
|
@@ -17,9 +19,11 @@ require 'mx-platform-ruby'
|
|
17
19
|
|
18
20
|
instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
|
19
21
|
amount: 21.33,
|
20
|
-
description:
|
22
|
+
description: ubr* pending.uber.com,
|
23
|
+
extended_transaction_type: partner_transaction_type,
|
21
24
|
id: ID-123,
|
22
|
-
|
25
|
+
memo: Additional-information*on_transaction,
|
26
|
+
merchant_category_code: 4121,
|
23
27
|
type: DEBIT
|
24
28
|
)
|
25
29
|
```
|
data/docs/MxPlatformApi.md
CHANGED
@@ -33,7 +33,8 @@ All URIs are relative to *https://api.mx.com*
|
|
33
33
|
| [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
|
34
34
|
| [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member |
|
35
35
|
| [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
|
36
|
-
| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /
|
36
|
+
| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories |
|
37
|
+
| [**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
|
37
38
|
| [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
|
38
39
|
| [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
|
39
40
|
| [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
|
@@ -58,7 +59,8 @@ All URIs are relative to *https://api.mx.com*
|
|
58
59
|
| [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
|
59
60
|
| [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
|
60
61
|
| [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
|
61
|
-
| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
|
62
|
+
| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
|
63
|
+
| [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
|
62
64
|
| [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
|
63
65
|
| [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
|
64
66
|
| [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
|
@@ -954,7 +956,7 @@ nil (empty response body)
|
|
954
956
|
### HTTP request headers
|
955
957
|
|
956
958
|
- **Content-Type**: Not defined
|
957
|
-
- **Accept**:
|
959
|
+
- **Accept**: Not defined
|
958
960
|
|
959
961
|
|
960
962
|
## delete_managed_account
|
@@ -1027,7 +1029,7 @@ nil (empty response body)
|
|
1027
1029
|
### HTTP request headers
|
1028
1030
|
|
1029
1031
|
- **Content-Type**: Not defined
|
1030
|
-
- **Accept**:
|
1032
|
+
- **Accept**: Not defined
|
1031
1033
|
|
1032
1034
|
|
1033
1035
|
## delete_managed_member
|
@@ -1098,7 +1100,7 @@ nil (empty response body)
|
|
1098
1100
|
### HTTP request headers
|
1099
1101
|
|
1100
1102
|
- **Content-Type**: Not defined
|
1101
|
-
- **Accept**:
|
1103
|
+
- **Accept**: Not defined
|
1102
1104
|
|
1103
1105
|
|
1104
1106
|
## delete_managed_transaction
|
@@ -1171,7 +1173,7 @@ nil (empty response body)
|
|
1171
1173
|
### HTTP request headers
|
1172
1174
|
|
1173
1175
|
- **Content-Type**: Not defined
|
1174
|
-
- **Accept**:
|
1176
|
+
- **Accept**: Not defined
|
1175
1177
|
|
1176
1178
|
|
1177
1179
|
## delete_member
|
@@ -1242,7 +1244,7 @@ nil (empty response body)
|
|
1242
1244
|
### HTTP request headers
|
1243
1245
|
|
1244
1246
|
- **Content-Type**: Not defined
|
1245
|
-
- **Accept**:
|
1247
|
+
- **Accept**: Not defined
|
1246
1248
|
|
1247
1249
|
|
1248
1250
|
## delete_tag
|
@@ -1313,7 +1315,7 @@ nil (empty response body)
|
|
1313
1315
|
### HTTP request headers
|
1314
1316
|
|
1315
1317
|
- **Content-Type**: Not defined
|
1316
|
-
- **Accept**:
|
1318
|
+
- **Accept**: Not defined
|
1317
1319
|
|
1318
1320
|
|
1319
1321
|
## delete_tagging
|
@@ -1384,7 +1386,7 @@ nil (empty response body)
|
|
1384
1386
|
### HTTP request headers
|
1385
1387
|
|
1386
1388
|
- **Content-Type**: Not defined
|
1387
|
-
- **Accept**:
|
1389
|
+
- **Accept**: Not defined
|
1388
1390
|
|
1389
1391
|
|
1390
1392
|
## delete_transaction_rule
|
@@ -1455,7 +1457,7 @@ nil (empty response body)
|
|
1455
1457
|
### HTTP request headers
|
1456
1458
|
|
1457
1459
|
- **Content-Type**: Not defined
|
1458
|
-
- **Accept**:
|
1460
|
+
- **Accept**: Not defined
|
1459
1461
|
|
1460
1462
|
|
1461
1463
|
## delete_user
|
@@ -1524,7 +1526,7 @@ nil (empty response body)
|
|
1524
1526
|
### HTTP request headers
|
1525
1527
|
|
1526
1528
|
- **Content-Type**: Not defined
|
1527
|
-
- **Accept**:
|
1529
|
+
- **Accept**: Not defined
|
1528
1530
|
|
1529
1531
|
|
1530
1532
|
## download_statement_pdf
|
@@ -2199,11 +2201,11 @@ end
|
|
2199
2201
|
|
2200
2202
|
## list_default_categories
|
2201
2203
|
|
2202
|
-
> <CategoriesResponseBody> list_default_categories(
|
2204
|
+
> <CategoriesResponseBody> list_default_categories(opts)
|
2203
2205
|
|
2204
2206
|
List default categories
|
2205
2207
|
|
2206
|
-
Use this endpoint to
|
2208
|
+
Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
|
2207
2209
|
|
2208
2210
|
### Examples
|
2209
2211
|
|
@@ -2218,7 +2220,6 @@ MxPlatformRuby.configure do |config|
|
|
2218
2220
|
end
|
2219
2221
|
|
2220
2222
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2221
|
-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2222
2223
|
opts = {
|
2223
2224
|
page: 1, # Integer | Specify current page.
|
2224
2225
|
records_per_page: 10 # Integer | Specify records per page.
|
@@ -2226,7 +2227,7 @@ opts = {
|
|
2226
2227
|
|
2227
2228
|
begin
|
2228
2229
|
# List default categories
|
2229
|
-
result = api_instance.list_default_categories(
|
2230
|
+
result = api_instance.list_default_categories(opts)
|
2230
2231
|
p result
|
2231
2232
|
rescue MxPlatformRuby::ApiError => e
|
2232
2233
|
puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
|
@@ -2237,12 +2238,12 @@ end
|
|
2237
2238
|
|
2238
2239
|
This returns an Array which contains the response data, status code and headers.
|
2239
2240
|
|
2240
|
-
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(
|
2241
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
|
2241
2242
|
|
2242
2243
|
```ruby
|
2243
2244
|
begin
|
2244
2245
|
# List default categories
|
2245
|
-
data, status_code, headers = api_instance.list_default_categories_with_http_info(
|
2246
|
+
data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
|
2246
2247
|
p status_code # => 2xx
|
2247
2248
|
p headers # => { ... }
|
2248
2249
|
p data # => <CategoriesResponseBody>
|
@@ -2253,6 +2254,81 @@ end
|
|
2253
2254
|
|
2254
2255
|
### Parameters
|
2255
2256
|
|
2257
|
+
| Name | Type | Description | Notes |
|
2258
|
+
| ---- | ---- | ----------- | ----- |
|
2259
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
2260
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
2261
|
+
|
2262
|
+
### Return type
|
2263
|
+
|
2264
|
+
[**CategoriesResponseBody**](CategoriesResponseBody.md)
|
2265
|
+
|
2266
|
+
### Authorization
|
2267
|
+
|
2268
|
+
[basicAuth](../README.md#basicAuth)
|
2269
|
+
|
2270
|
+
### HTTP request headers
|
2271
|
+
|
2272
|
+
- **Content-Type**: Not defined
|
2273
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
2274
|
+
|
2275
|
+
|
2276
|
+
## list_default_categories_by_user
|
2277
|
+
|
2278
|
+
> <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
|
2279
|
+
|
2280
|
+
List default categories by user
|
2281
|
+
|
2282
|
+
Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
|
2283
|
+
|
2284
|
+
### Examples
|
2285
|
+
|
2286
|
+
```ruby
|
2287
|
+
require 'time'
|
2288
|
+
require 'mx-platform-ruby'
|
2289
|
+
# setup authorization
|
2290
|
+
MxPlatformRuby.configure do |config|
|
2291
|
+
# Configure HTTP basic authorization: basicAuth
|
2292
|
+
config.username = 'YOUR USERNAME'
|
2293
|
+
config.password = 'YOUR PASSWORD'
|
2294
|
+
end
|
2295
|
+
|
2296
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
2297
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2298
|
+
opts = {
|
2299
|
+
page: 1, # Integer | Specify current page.
|
2300
|
+
records_per_page: 10 # Integer | Specify records per page.
|
2301
|
+
}
|
2302
|
+
|
2303
|
+
begin
|
2304
|
+
# List default categories by user
|
2305
|
+
result = api_instance.list_default_categories_by_user(user_guid, opts)
|
2306
|
+
p result
|
2307
|
+
rescue MxPlatformRuby::ApiError => e
|
2308
|
+
puts "Error when calling MxPlatformApi->list_default_categories_by_user: #{e}"
|
2309
|
+
end
|
2310
|
+
```
|
2311
|
+
|
2312
|
+
#### Using the list_default_categories_by_user_with_http_info variant
|
2313
|
+
|
2314
|
+
This returns an Array which contains the response data, status code and headers.
|
2315
|
+
|
2316
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
|
2317
|
+
|
2318
|
+
```ruby
|
2319
|
+
begin
|
2320
|
+
# List default categories by user
|
2321
|
+
data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
|
2322
|
+
p status_code # => 2xx
|
2323
|
+
p headers # => { ... }
|
2324
|
+
p data # => <CategoriesResponseBody>
|
2325
|
+
rescue MxPlatformRuby::ApiError => e
|
2326
|
+
puts "Error when calling MxPlatformApi->list_default_categories_by_user_with_http_info: #{e}"
|
2327
|
+
end
|
2328
|
+
```
|
2329
|
+
|
2330
|
+
### Parameters
|
2331
|
+
|
2256
2332
|
| Name | Type | Description | Notes |
|
2257
2333
|
| ---- | ---- | ----------- | ----- |
|
2258
2334
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
@@ -4139,7 +4215,7 @@ end
|
|
4139
4215
|
|
4140
4216
|
> <CategoryResponseBody> read_category(category_guid, user_guid)
|
4141
4217
|
|
4142
|
-
Read category
|
4218
|
+
Read a custom category
|
4143
4219
|
|
4144
4220
|
Use this endpoint to read the attributes of either a default category or a custom category.
|
4145
4221
|
|
@@ -4160,7 +4236,7 @@ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique
|
|
4160
4236
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4161
4237
|
|
4162
4238
|
begin
|
4163
|
-
# Read category
|
4239
|
+
# Read a custom category
|
4164
4240
|
result = api_instance.read_category(category_guid, user_guid)
|
4165
4241
|
p result
|
4166
4242
|
rescue MxPlatformRuby::ApiError => e
|
@@ -4176,7 +4252,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
4176
4252
|
|
4177
4253
|
```ruby
|
4178
4254
|
begin
|
4179
|
-
# Read category
|
4255
|
+
# Read a custom category
|
4180
4256
|
data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
|
4181
4257
|
p status_code # => 2xx
|
4182
4258
|
p headers # => { ... }
|
@@ -4207,6 +4283,78 @@ end
|
|
4207
4283
|
- **Accept**: application/vnd.mx.api.v1+json
|
4208
4284
|
|
4209
4285
|
|
4286
|
+
## read_default_category
|
4287
|
+
|
4288
|
+
> <CategoryResponseBody> read_default_category(category_guid, user_guid)
|
4289
|
+
|
4290
|
+
Read a default category
|
4291
|
+
|
4292
|
+
Use this endpoint to read the attributes of a default category.
|
4293
|
+
|
4294
|
+
### Examples
|
4295
|
+
|
4296
|
+
```ruby
|
4297
|
+
require 'time'
|
4298
|
+
require 'mx-platform-ruby'
|
4299
|
+
# setup authorization
|
4300
|
+
MxPlatformRuby.configure do |config|
|
4301
|
+
# Configure HTTP basic authorization: basicAuth
|
4302
|
+
config.username = 'YOUR USERNAME'
|
4303
|
+
config.password = 'YOUR PASSWORD'
|
4304
|
+
end
|
4305
|
+
|
4306
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4307
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
4308
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4309
|
+
|
4310
|
+
begin
|
4311
|
+
# Read a default category
|
4312
|
+
result = api_instance.read_default_category(category_guid, user_guid)
|
4313
|
+
p result
|
4314
|
+
rescue MxPlatformRuby::ApiError => e
|
4315
|
+
puts "Error when calling MxPlatformApi->read_default_category: #{e}"
|
4316
|
+
end
|
4317
|
+
```
|
4318
|
+
|
4319
|
+
#### Using the read_default_category_with_http_info variant
|
4320
|
+
|
4321
|
+
This returns an Array which contains the response data, status code and headers.
|
4322
|
+
|
4323
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
|
4324
|
+
|
4325
|
+
```ruby
|
4326
|
+
begin
|
4327
|
+
# Read a default category
|
4328
|
+
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
|
4329
|
+
p status_code # => 2xx
|
4330
|
+
p headers # => { ... }
|
4331
|
+
p data # => <CategoryResponseBody>
|
4332
|
+
rescue MxPlatformRuby::ApiError => e
|
4333
|
+
puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
|
4334
|
+
end
|
4335
|
+
```
|
4336
|
+
|
4337
|
+
### Parameters
|
4338
|
+
|
4339
|
+
| Name | Type | Description | Notes |
|
4340
|
+
| ---- | ---- | ----------- | ----- |
|
4341
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
4342
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
4343
|
+
|
4344
|
+
### Return type
|
4345
|
+
|
4346
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
4347
|
+
|
4348
|
+
### Authorization
|
4349
|
+
|
4350
|
+
[basicAuth](../README.md#basicAuth)
|
4351
|
+
|
4352
|
+
### HTTP request headers
|
4353
|
+
|
4354
|
+
- **Content-Type**: Not defined
|
4355
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
4356
|
+
|
4357
|
+
|
4210
4358
|
## read_holding
|
4211
4359
|
|
4212
4360
|
> <HoldingResponseBody> read_holding(holding_guid, user_guid)
|
data/docs/TransactionResponse.md
CHANGED
@@ -8,11 +8,13 @@
|
|
8
8
|
| **account_id** | **String** | | [optional] |
|
9
9
|
| **amount** | **Float** | | [optional] |
|
10
10
|
| **category** | **String** | | [optional] |
|
11
|
+
| **category_guid** | **String** | | [optional] |
|
11
12
|
| **check_number_string** | **String** | | [optional] |
|
12
13
|
| **created_at** | **String** | | [optional] |
|
13
14
|
| **currency_code** | **String** | | [optional] |
|
14
15
|
| **date** | **String** | | [optional] |
|
15
16
|
| **description** | **String** | | [optional] |
|
17
|
+
| **extended_transaction_type** | **String** | | [optional] |
|
16
18
|
| **guid** | **String** | | [optional] |
|
17
19
|
| **id** | **String** | | [optional] |
|
18
20
|
| **is_bill_pay** | **Boolean** | | [optional] |
|
@@ -56,11 +58,13 @@ instance = MxPlatformRuby::TransactionResponse.new(
|
|
56
58
|
account_id: account123,
|
57
59
|
amount: 61.11,
|
58
60
|
category: Groceries,
|
61
|
+
category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8,
|
59
62
|
check_number_string: 6812,
|
60
63
|
created_at: 2016-10-06T09:43:42.000Z,
|
61
64
|
currency_code: USD,
|
62
65
|
date: 2013-09-23T00:00:00.000Z,
|
63
66
|
description: Whole foods,
|
67
|
+
extended_transaction_type: partner_transaction_type,
|
64
68
|
guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9,
|
65
69
|
id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9,
|
66
70
|
is_bill_pay: false,
|