mx-platform-ruby 0.6.3 → 0.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +17 -11
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/docs/EnhanceTransactionResponse.md +1 -1
- data/docs/EnhanceTransactionsRequest.md +1 -1
- data/docs/MxPlatformApi.md +168 -20
- 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 +1 -1
- data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/spec/models/enhance_transactions_request_body_spec.rb +1 -1
- data/spec/models/enhance_transactions_request_spec.rb +1 -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 +1 -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 +92 -92
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 5.3.
|
|
9
|
+
OpenAPI Generator version: 5.3.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -866,8 +866,6 @@ module MxPlatformRuby
|
|
|
866
866
|
|
|
867
867
|
# header parameters
|
|
868
868
|
header_params = opts[:header_params] || {}
|
|
869
|
-
# HTTP header 'Accept' (if needed)
|
|
870
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
871
869
|
|
|
872
870
|
# form parameters
|
|
873
871
|
form_params = opts[:form_params] || {}
|
|
@@ -941,8 +939,6 @@ module MxPlatformRuby
|
|
|
941
939
|
|
|
942
940
|
# header parameters
|
|
943
941
|
header_params = opts[:header_params] || {}
|
|
944
|
-
# HTTP header 'Accept' (if needed)
|
|
945
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
946
942
|
|
|
947
943
|
# form parameters
|
|
948
944
|
form_params = opts[:form_params] || {}
|
|
@@ -1010,8 +1006,6 @@ module MxPlatformRuby
|
|
|
1010
1006
|
|
|
1011
1007
|
# header parameters
|
|
1012
1008
|
header_params = opts[:header_params] || {}
|
|
1013
|
-
# HTTP header 'Accept' (if needed)
|
|
1014
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1015
1009
|
|
|
1016
1010
|
# form parameters
|
|
1017
1011
|
form_params = opts[:form_params] || {}
|
|
@@ -1085,8 +1079,6 @@ module MxPlatformRuby
|
|
|
1085
1079
|
|
|
1086
1080
|
# header parameters
|
|
1087
1081
|
header_params = opts[:header_params] || {}
|
|
1088
|
-
# HTTP header 'Accept' (if needed)
|
|
1089
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1090
1082
|
|
|
1091
1083
|
# form parameters
|
|
1092
1084
|
form_params = opts[:form_params] || {}
|
|
@@ -1154,8 +1146,6 @@ module MxPlatformRuby
|
|
|
1154
1146
|
|
|
1155
1147
|
# header parameters
|
|
1156
1148
|
header_params = opts[:header_params] || {}
|
|
1157
|
-
# HTTP header 'Accept' (if needed)
|
|
1158
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1159
1149
|
|
|
1160
1150
|
# form parameters
|
|
1161
1151
|
form_params = opts[:form_params] || {}
|
|
@@ -1223,8 +1213,6 @@ module MxPlatformRuby
|
|
|
1223
1213
|
|
|
1224
1214
|
# header parameters
|
|
1225
1215
|
header_params = opts[:header_params] || {}
|
|
1226
|
-
# HTTP header 'Accept' (if needed)
|
|
1227
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1228
1216
|
|
|
1229
1217
|
# form parameters
|
|
1230
1218
|
form_params = opts[:form_params] || {}
|
|
@@ -1292,8 +1280,6 @@ module MxPlatformRuby
|
|
|
1292
1280
|
|
|
1293
1281
|
# header parameters
|
|
1294
1282
|
header_params = opts[:header_params] || {}
|
|
1295
|
-
# HTTP header 'Accept' (if needed)
|
|
1296
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1297
1283
|
|
|
1298
1284
|
# form parameters
|
|
1299
1285
|
form_params = opts[:form_params] || {}
|
|
@@ -1361,8 +1347,6 @@ module MxPlatformRuby
|
|
|
1361
1347
|
|
|
1362
1348
|
# header parameters
|
|
1363
1349
|
header_params = opts[:header_params] || {}
|
|
1364
|
-
# HTTP header 'Accept' (if needed)
|
|
1365
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1366
1350
|
|
|
1367
1351
|
# form parameters
|
|
1368
1352
|
form_params = opts[:form_params] || {}
|
|
@@ -1424,8 +1408,6 @@ module MxPlatformRuby
|
|
|
1424
1408
|
|
|
1425
1409
|
# header parameters
|
|
1426
1410
|
header_params = opts[:header_params] || {}
|
|
1427
|
-
# HTTP header 'Accept' (if needed)
|
|
1428
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
1429
1411
|
|
|
1430
1412
|
# form parameters
|
|
1431
1413
|
form_params = opts[:form_params] || {}
|
|
@@ -2101,31 +2083,94 @@ module MxPlatformRuby
|
|
|
2101
2083
|
end
|
|
2102
2084
|
|
|
2103
2085
|
# List default categories
|
|
2104
|
-
# Use this endpoint to
|
|
2105
|
-
# @param user_guid [String] The unique id for a `user`.
|
|
2086
|
+
# 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.
|
|
2106
2087
|
# @param [Hash] opts the optional parameters
|
|
2107
2088
|
# @option opts [Integer] :page Specify current page.
|
|
2108
2089
|
# @option opts [Integer] :records_per_page Specify records per page.
|
|
2109
2090
|
# @return [CategoriesResponseBody]
|
|
2110
|
-
def list_default_categories(
|
|
2111
|
-
data, _status_code, _headers = list_default_categories_with_http_info(
|
|
2091
|
+
def list_default_categories(opts = {})
|
|
2092
|
+
data, _status_code, _headers = list_default_categories_with_http_info(opts)
|
|
2112
2093
|
data
|
|
2113
2094
|
end
|
|
2114
2095
|
|
|
2115
2096
|
# List default categories
|
|
2116
|
-
# Use this endpoint to
|
|
2117
|
-
# @param user_guid [String] The unique id for a `user`.
|
|
2097
|
+
# 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.
|
|
2118
2098
|
# @param [Hash] opts the optional parameters
|
|
2119
2099
|
# @option opts [Integer] :page Specify current page.
|
|
2120
2100
|
# @option opts [Integer] :records_per_page Specify records per page.
|
|
2121
2101
|
# @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
|
|
2122
|
-
def list_default_categories_with_http_info(
|
|
2102
|
+
def list_default_categories_with_http_info(opts = {})
|
|
2123
2103
|
if @api_client.config.debugging
|
|
2124
2104
|
@api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories ...'
|
|
2125
2105
|
end
|
|
2106
|
+
# resource path
|
|
2107
|
+
local_var_path = '/categories/default'
|
|
2108
|
+
|
|
2109
|
+
# query parameters
|
|
2110
|
+
query_params = opts[:query_params] || {}
|
|
2111
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
2112
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
|
2113
|
+
|
|
2114
|
+
# header parameters
|
|
2115
|
+
header_params = opts[:header_params] || {}
|
|
2116
|
+
# HTTP header 'Accept' (if needed)
|
|
2117
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
2118
|
+
|
|
2119
|
+
# form parameters
|
|
2120
|
+
form_params = opts[:form_params] || {}
|
|
2121
|
+
|
|
2122
|
+
# http body (model)
|
|
2123
|
+
post_body = opts[:debug_body]
|
|
2124
|
+
|
|
2125
|
+
# return_type
|
|
2126
|
+
return_type = opts[:debug_return_type] || 'CategoriesResponseBody'
|
|
2127
|
+
|
|
2128
|
+
# auth_names
|
|
2129
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
2130
|
+
|
|
2131
|
+
new_options = opts.merge(
|
|
2132
|
+
:operation => :"MxPlatformApi.list_default_categories",
|
|
2133
|
+
:header_params => header_params,
|
|
2134
|
+
:query_params => query_params,
|
|
2135
|
+
:form_params => form_params,
|
|
2136
|
+
:body => post_body,
|
|
2137
|
+
:auth_names => auth_names,
|
|
2138
|
+
:return_type => return_type
|
|
2139
|
+
)
|
|
2140
|
+
|
|
2141
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2142
|
+
if @api_client.config.debugging
|
|
2143
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2144
|
+
end
|
|
2145
|
+
return data, status_code, headers
|
|
2146
|
+
end
|
|
2147
|
+
|
|
2148
|
+
# List default categories by user
|
|
2149
|
+
# 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.
|
|
2150
|
+
# @param user_guid [String] The unique id for a `user`.
|
|
2151
|
+
# @param [Hash] opts the optional parameters
|
|
2152
|
+
# @option opts [Integer] :page Specify current page.
|
|
2153
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
|
2154
|
+
# @return [CategoriesResponseBody]
|
|
2155
|
+
def list_default_categories_by_user(user_guid, opts = {})
|
|
2156
|
+
data, _status_code, _headers = list_default_categories_by_user_with_http_info(user_guid, opts)
|
|
2157
|
+
data
|
|
2158
|
+
end
|
|
2159
|
+
|
|
2160
|
+
# List default categories by user
|
|
2161
|
+
# 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.
|
|
2162
|
+
# @param user_guid [String] The unique id for a `user`.
|
|
2163
|
+
# @param [Hash] opts the optional parameters
|
|
2164
|
+
# @option opts [Integer] :page Specify current page.
|
|
2165
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
|
2166
|
+
# @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
|
|
2167
|
+
def list_default_categories_by_user_with_http_info(user_guid, opts = {})
|
|
2168
|
+
if @api_client.config.debugging
|
|
2169
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories_by_user ...'
|
|
2170
|
+
end
|
|
2126
2171
|
# verify the required parameter 'user_guid' is set
|
|
2127
2172
|
if @api_client.config.client_side_validation && user_guid.nil?
|
|
2128
|
-
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.
|
|
2173
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories_by_user"
|
|
2129
2174
|
end
|
|
2130
2175
|
# resource path
|
|
2131
2176
|
local_var_path = '/users/{user_guid}/categories/default'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
@@ -2153,7 +2198,7 @@ module MxPlatformRuby
|
|
|
2153
2198
|
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
2154
2199
|
|
|
2155
2200
|
new_options = opts.merge(
|
|
2156
|
-
:operation => :"MxPlatformApi.
|
|
2201
|
+
:operation => :"MxPlatformApi.list_default_categories_by_user",
|
|
2157
2202
|
:header_params => header_params,
|
|
2158
2203
|
:query_params => query_params,
|
|
2159
2204
|
:form_params => form_params,
|
|
@@ -2164,7 +2209,7 @@ module MxPlatformRuby
|
|
|
2164
2209
|
|
|
2165
2210
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2166
2211
|
if @api_client.config.debugging
|
|
2167
|
-
@api_client.config.logger.debug "API called: MxPlatformApi#
|
|
2212
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories_by_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2168
2213
|
end
|
|
2169
2214
|
return data, status_code, headers
|
|
2170
2215
|
end
|
|
@@ -3900,7 +3945,7 @@ module MxPlatformRuby
|
|
|
3900
3945
|
return data, status_code, headers
|
|
3901
3946
|
end
|
|
3902
3947
|
|
|
3903
|
-
# Read category
|
|
3948
|
+
# Read a custom category
|
|
3904
3949
|
# Use this endpoint to read the attributes of either a default category or a custom category.
|
|
3905
3950
|
# @param category_guid [String] The unique id for a `category`.
|
|
3906
3951
|
# @param user_guid [String] The unique id for a `user`.
|
|
@@ -3911,7 +3956,7 @@ module MxPlatformRuby
|
|
|
3911
3956
|
data
|
|
3912
3957
|
end
|
|
3913
3958
|
|
|
3914
|
-
# Read category
|
|
3959
|
+
# Read a custom category
|
|
3915
3960
|
# Use this endpoint to read the attributes of either a default category or a custom category.
|
|
3916
3961
|
# @param category_guid [String] The unique id for a `category`.
|
|
3917
3962
|
# @param user_guid [String] The unique id for a `user`.
|
|
@@ -3969,6 +4014,75 @@ module MxPlatformRuby
|
|
|
3969
4014
|
return data, status_code, headers
|
|
3970
4015
|
end
|
|
3971
4016
|
|
|
4017
|
+
# Read a default category
|
|
4018
|
+
# Use this endpoint to read the attributes of a default category.
|
|
4019
|
+
# @param category_guid [String] The unique id for a `category`.
|
|
4020
|
+
# @param user_guid [String] The unique id for a `user`.
|
|
4021
|
+
# @param [Hash] opts the optional parameters
|
|
4022
|
+
# @return [CategoryResponseBody]
|
|
4023
|
+
def read_default_category(category_guid, user_guid, opts = {})
|
|
4024
|
+
data, _status_code, _headers = read_default_category_with_http_info(category_guid, user_guid, opts)
|
|
4025
|
+
data
|
|
4026
|
+
end
|
|
4027
|
+
|
|
4028
|
+
# Read a default category
|
|
4029
|
+
# Use this endpoint to read the attributes of a default category.
|
|
4030
|
+
# @param category_guid [String] The unique id for a `category`.
|
|
4031
|
+
# @param user_guid [String] The unique id for a `user`.
|
|
4032
|
+
# @param [Hash] opts the optional parameters
|
|
4033
|
+
# @return [Array<(CategoryResponseBody, Integer, Hash)>] CategoryResponseBody data, response status code and response headers
|
|
4034
|
+
def read_default_category_with_http_info(category_guid, user_guid, opts = {})
|
|
4035
|
+
if @api_client.config.debugging
|
|
4036
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.read_default_category ...'
|
|
4037
|
+
end
|
|
4038
|
+
# verify the required parameter 'category_guid' is set
|
|
4039
|
+
if @api_client.config.client_side_validation && category_guid.nil?
|
|
4040
|
+
fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_default_category"
|
|
4041
|
+
end
|
|
4042
|
+
# verify the required parameter 'user_guid' is set
|
|
4043
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
|
4044
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_default_category"
|
|
4045
|
+
end
|
|
4046
|
+
# resource path
|
|
4047
|
+
local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
|
4048
|
+
|
|
4049
|
+
# query parameters
|
|
4050
|
+
query_params = opts[:query_params] || {}
|
|
4051
|
+
|
|
4052
|
+
# header parameters
|
|
4053
|
+
header_params = opts[:header_params] || {}
|
|
4054
|
+
# HTTP header 'Accept' (if needed)
|
|
4055
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
|
4056
|
+
|
|
4057
|
+
# form parameters
|
|
4058
|
+
form_params = opts[:form_params] || {}
|
|
4059
|
+
|
|
4060
|
+
# http body (model)
|
|
4061
|
+
post_body = opts[:debug_body]
|
|
4062
|
+
|
|
4063
|
+
# return_type
|
|
4064
|
+
return_type = opts[:debug_return_type] || 'CategoryResponseBody'
|
|
4065
|
+
|
|
4066
|
+
# auth_names
|
|
4067
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
4068
|
+
|
|
4069
|
+
new_options = opts.merge(
|
|
4070
|
+
:operation => :"MxPlatformApi.read_default_category",
|
|
4071
|
+
:header_params => header_params,
|
|
4072
|
+
:query_params => query_params,
|
|
4073
|
+
:form_params => form_params,
|
|
4074
|
+
:body => post_body,
|
|
4075
|
+
:auth_names => auth_names,
|
|
4076
|
+
:return_type => return_type
|
|
4077
|
+
)
|
|
4078
|
+
|
|
4079
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4080
|
+
if @api_client.config.debugging
|
|
4081
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#read_default_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4082
|
+
end
|
|
4083
|
+
return data, status_code, headers
|
|
4084
|
+
end
|
|
4085
|
+
|
|
3972
4086
|
# Read holding
|
|
3973
4087
|
# Use this endpoint to read the attributes of a specific `holding`.
|
|
3974
4088
|
# @param holding_guid [String] The unique id for a `holding`.
|