apimatic-mx-apis-sdk 0.0.1
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 +7 -0
- data/LICENSE +28 -0
- data/README.md +207 -0
- data/bin/console +15 -0
- data/lib/mx_platform_api/api_helper.rb +10 -0
- data/lib/mx_platform_api/apis/accounts_api.rb +619 -0
- data/lib/mx_platform_api/apis/ach_return_api.rb +115 -0
- data/lib/mx_platform_api/apis/base_api.rb +67 -0
- data/lib/mx_platform_api/apis/budgets_api.rb +212 -0
- data/lib/mx_platform_api/apis/categories_api.rb +377 -0
- data/lib/mx_platform_api/apis/goals_api.rb +223 -0
- data/lib/mx_platform_api/apis/insights_api.rb +415 -0
- data/lib/mx_platform_api/apis/institutions_api.rb +159 -0
- data/lib/mx_platform_api/apis/investment_holdings_api.rb +191 -0
- data/lib/mx_platform_api/apis/jobs_api.rb +48 -0
- data/lib/mx_platform_api/apis/managed_data_deprecated_api.rb +773 -0
- data/lib/mx_platform_api/apis/members_api.rb +639 -0
- data/lib/mx_platform_api/apis/merchants_api.rb +98 -0
- data/lib/mx_platform_api/apis/microdeposits_api.rb +219 -0
- data/lib/mx_platform_api/apis/monthly_cash_flow_profile_api.rb +75 -0
- data/lib/mx_platform_api/apis/notifications_api.rb +115 -0
- data/lib/mx_platform_api/apis/processor_token_api.rb +141 -0
- data/lib/mx_platform_api/apis/rewards_api.rb +149 -0
- data/lib/mx_platform_api/apis/spending_plan_api.rb +621 -0
- data/lib/mx_platform_api/apis/statements_api.rb +165 -0
- data/lib/mx_platform_api/apis/taggings_api.rb +184 -0
- data/lib/mx_platform_api/apis/tags_api.rb +185 -0
- data/lib/mx_platform_api/apis/transaction_rules_api.rb +163 -0
- data/lib/mx_platform_api/apis/transactions_api.rb +1223 -0
- data/lib/mx_platform_api/apis/users_api.rb +188 -0
- data/lib/mx_platform_api/apis/verifiable_credentials_api.rb +114 -0
- data/lib/mx_platform_api/apis/widgets_api.rb +135 -0
- data/lib/mx_platform_api/client.rb +225 -0
- data/lib/mx_platform_api/configuration.rb +182 -0
- data/lib/mx_platform_api/exceptions/api_exception.rb +21 -0
- data/lib/mx_platform_api/http/api_response.rb +19 -0
- data/lib/mx_platform_api/http/auth/basic_auth.rb +62 -0
- data/lib/mx_platform_api/http/auth/bearer_auth.rb +53 -0
- data/lib/mx_platform_api/http/http_call_back.rb +10 -0
- data/lib/mx_platform_api/http/http_method_enum.rb +10 -0
- data/lib/mx_platform_api/http/http_request.rb +10 -0
- data/lib/mx_platform_api/http/http_response.rb +10 -0
- data/lib/mx_platform_api/http/proxy_settings.rb +22 -0
- data/lib/mx_platform_api/logging/configuration/api_logging_configuration.rb +186 -0
- data/lib/mx_platform_api/logging/sdk_logger.rb +17 -0
- data/lib/mx_platform_api/models/account_create_request.rb +309 -0
- data/lib/mx_platform_api/models/account_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/account_number.rb +199 -0
- data/lib/mx_platform_api/models/account_number_response.rb +215 -0
- data/lib/mx_platform_api/models/account_numbers_response_body.rb +95 -0
- data/lib/mx_platform_api/models/account_owner.rb +186 -0
- data/lib/mx_platform_api/models/account_owner_response.rb +219 -0
- data/lib/mx_platform_api/models/account_owners_response_body.rb +95 -0
- data/lib/mx_platform_api/models/account_ownership.rb +45 -0
- data/lib/mx_platform_api/models/account_response.rb +814 -0
- data/lib/mx_platform_api/models/account_response_body.rb +75 -0
- data/lib/mx_platform_api/models/account_type.rb +80 -0
- data/lib/mx_platform_api/models/account_type1.rb +80 -0
- data/lib/mx_platform_api/models/account_update_request.rb +301 -0
- data/lib/mx_platform_api/models/account_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/accounts_merge_request.rb +75 -0
- data/lib/mx_platform_api/models/accounts_merge_request_body.rb +75 -0
- data/lib/mx_platform_api/models/accounts_response_body.rb +94 -0
- data/lib/mx_platform_api/models/ach_response.rb +424 -0
- data/lib/mx_platform_api/models/ach_return_create_request.rb +256 -0
- data/lib/mx_platform_api/models/ach_return_create_request_body.rb +76 -0
- data/lib/mx_platform_api/models/ach_return_response_body.rb +76 -0
- data/lib/mx_platform_api/models/ach_returns_response_body.rb +95 -0
- data/lib/mx_platform_api/models/authorization_code_request.rb +77 -0
- data/lib/mx_platform_api/models/authorization_code_request_body.rb +77 -0
- data/lib/mx_platform_api/models/authorization_code_response.rb +76 -0
- data/lib/mx_platform_api/models/authorization_code_response_body.rb +77 -0
- data/lib/mx_platform_api/models/base_model.rb +110 -0
- data/lib/mx_platform_api/models/budget_create_request.rb +115 -0
- data/lib/mx_platform_api/models/budget_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/budget_response.rb +246 -0
- data/lib/mx_platform_api/models/budget_response_body.rb +75 -0
- data/lib/mx_platform_api/models/budget_update_request.rb +96 -0
- data/lib/mx_platform_api/models/budget_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/categories_response_body.rb +95 -0
- data/lib/mx_platform_api/models/category_create_request.rb +93 -0
- data/lib/mx_platform_api/models/category_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/category_response.rb +160 -0
- data/lib/mx_platform_api/models/category_response_body.rb +75 -0
- data/lib/mx_platform_api/models/category_update_request.rb +85 -0
- data/lib/mx_platform_api/models/category_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/challenge_response.rb +159 -0
- data/lib/mx_platform_api/models/challenges_response_body.rb +95 -0
- data/lib/mx_platform_api/models/channel.rb +47 -0
- data/lib/mx_platform_api/models/classification.rb +85 -0
- data/lib/mx_platform_api/models/color_scheme.rb +43 -0
- data/lib/mx_platform_api/models/connection_status.rb +118 -0
- data/lib/mx_platform_api/models/credential_request.rb +85 -0
- data/lib/mx_platform_api/models/credential_response.rb +133 -0
- data/lib/mx_platform_api/models/credentials_response_body.rb +95 -0
- data/lib/mx_platform_api/models/credit_card_product.rb +276 -0
- data/lib/mx_platform_api/models/credit_card_product_response.rb +77 -0
- data/lib/mx_platform_api/models/data_request.rb +76 -0
- data/lib/mx_platform_api/models/date_range.rb +87 -0
- data/lib/mx_platform_api/models/date_range_category_totals_response.rb +115 -0
- data/lib/mx_platform_api/models/date_range_category_totals_response_body.rb +88 -0
- data/lib/mx_platform_api/models/deep_link_params.rb +131 -0
- data/lib/mx_platform_api/models/enhance_transaction_response.rb +371 -0
- data/lib/mx_platform_api/models/enhance_transactions_request.rb +143 -0
- data/lib/mx_platform_api/models/enhance_transactions_request_body.rb +85 -0
- data/lib/mx_platform_api/models/enhance_transactions_response_body.rb +85 -0
- data/lib/mx_platform_api/models/error.rb +106 -0
- data/lib/mx_platform_api/models/federal_insurance_status.rb +42 -0
- data/lib/mx_platform_api/models/geolocation.rb +108 -0
- data/lib/mx_platform_api/models/goal_request.rb +179 -0
- data/lib/mx_platform_api/models/goal_request_body.rb +74 -0
- data/lib/mx_platform_api/models/goal_response.rb +241 -0
- data/lib/mx_platform_api/models/goal_response_body.rb +74 -0
- data/lib/mx_platform_api/models/goal_type_name.rb +36 -0
- data/lib/mx_platform_api/models/goals_response.rb +241 -0
- data/lib/mx_platform_api/models/goals_response_body.rb +94 -0
- data/lib/mx_platform_api/models/image_option_response.rb +110 -0
- data/lib/mx_platform_api/models/insight_response.rb +338 -0
- data/lib/mx_platform_api/models/insight_response_body.rb +75 -0
- data/lib/mx_platform_api/models/insight_update_request.rb +87 -0
- data/lib/mx_platform_api/models/insight_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/insights_response_body.rb +94 -0
- data/lib/mx_platform_api/models/institution_response.rb +290 -0
- data/lib/mx_platform_api/models/institution_response_body.rb +76 -0
- data/lib/mx_platform_api/models/institutions_response_body.rb +95 -0
- data/lib/mx_platform_api/models/investment_holding_response.rb +513 -0
- data/lib/mx_platform_api/models/investment_holding_response_body.rb +77 -0
- data/lib/mx_platform_api/models/investment_holdings_deactivation.rb +85 -0
- data/lib/mx_platform_api/models/investment_holdings_response_body.rb +95 -0
- data/lib/mx_platform_api/models/iso_country_code.rb +36 -0
- data/lib/mx_platform_api/models/item_type.rb +52 -0
- data/lib/mx_platform_api/models/job_response.rb +203 -0
- data/lib/mx_platform_api/models/job_response_body.rb +74 -0
- data/lib/mx_platform_api/models/managed_account_create_request.rb +422 -0
- data/lib/mx_platform_api/models/managed_account_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/managed_account_update_request.rb +428 -0
- data/lib/mx_platform_api/models/managed_account_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/managed_member_create_request.rb +105 -0
- data/lib/mx_platform_api/models/managed_member_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/managed_member_update_request.rb +95 -0
- data/lib/mx_platform_api/models/managed_member_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/managed_transaction_create_request.rb +282 -0
- data/lib/mx_platform_api/models/managed_transaction_create_request_body.rb +77 -0
- data/lib/mx_platform_api/models/managed_transaction_update_request.rb +289 -0
- data/lib/mx_platform_api/models/managed_transaction_update_request_body.rb +77 -0
- data/lib/mx_platform_api/models/member_create_request.rb +154 -0
- data/lib/mx_platform_api/models/member_create_request_body.rb +152 -0
- data/lib/mx_platform_api/models/member_elements.rb +96 -0
- data/lib/mx_platform_api/models/member_response.rb +406 -0
- data/lib/mx_platform_api/models/member_response_body.rb +75 -0
- data/lib/mx_platform_api/models/member_response_with_job_error.rb +406 -0
- data/lib/mx_platform_api/models/member_response_with_job_error_body.rb +75 -0
- data/lib/mx_platform_api/models/member_resume_request.rb +85 -0
- data/lib/mx_platform_api/models/member_resume_request_body.rb +75 -0
- data/lib/mx_platform_api/models/member_status_response.rb +236 -0
- data/lib/mx_platform_api/models/member_status_response_body.rb +75 -0
- data/lib/mx_platform_api/models/member_update_request.rb +133 -0
- data/lib/mx_platform_api/models/member_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/members_response_body.rb +94 -0
- data/lib/mx_platform_api/models/merchant.rb +105 -0
- data/lib/mx_platform_api/models/merchant_location_response.rb +208 -0
- data/lib/mx_platform_api/models/merchant_location_response_body.rb +77 -0
- data/lib/mx_platform_api/models/merchant_response.rb +136 -0
- data/lib/mx_platform_api/models/merchant_response_body.rb +75 -0
- data/lib/mx_platform_api/models/merchants_response_body.rb +95 -0
- data/lib/mx_platform_api/models/micro_deposit.rb +223 -0
- data/lib/mx_platform_api/models/microdeposit_elements.rb +141 -0
- data/lib/mx_platform_api/models/microdeposit_request_body.rb +77 -0
- data/lib/mx_platform_api/models/microdeposit_response.rb +149 -0
- data/lib/mx_platform_api/models/microdeposit_response_body.rb +85 -0
- data/lib/mx_platform_api/models/microdeposit_verify_request.rb +88 -0
- data/lib/mx_platform_api/models/microdeposit_verify_request_body.rb +77 -0
- data/lib/mx_platform_api/models/microdeposits_response_body.rb +95 -0
- data/lib/mx_platform_api/models/monthly_account_balance.rb +123 -0
- data/lib/mx_platform_api/models/monthly_account_balances_response_body.rb +85 -0
- data/lib/mx_platform_api/models/monthly_cash_flow_profile_request.rb +95 -0
- data/lib/mx_platform_api/models/monthly_cash_flow_profile_request_body.rb +81 -0
- data/lib/mx_platform_api/models/monthly_cash_flow_response.rb +157 -0
- data/lib/mx_platform_api/models/monthly_cash_flow_response_body.rb +81 -0
- data/lib/mx_platform_api/models/notification_request.rb +83 -0
- data/lib/mx_platform_api/models/notification_request_body.rb +76 -0
- data/lib/mx_platform_api/models/notification_response.rb +204 -0
- data/lib/mx_platform_api/models/notification_response_body.rb +76 -0
- data/lib/mx_platform_api/models/notifications_response_body.rb +85 -0
- data/lib/mx_platform_api/models/oauth_window_response.rb +91 -0
- data/lib/mx_platform_api/models/oauth_window_response_body.rb +75 -0
- data/lib/mx_platform_api/models/option_response.rb +99 -0
- data/lib/mx_platform_api/models/pagination_response.rb +106 -0
- data/lib/mx_platform_api/models/parent_class.rb +84 -0
- data/lib/mx_platform_api/models/payment_account.rb +183 -0
- data/lib/mx_platform_api/models/payment_account1.rb +213 -0
- data/lib/mx_platform_api/models/payment_account_body.rb +77 -0
- data/lib/mx_platform_api/models/processor_account_number.rb +168 -0
- data/lib/mx_platform_api/models/processor_account_number_body.rb +85 -0
- data/lib/mx_platform_api/models/processor_owner.rb +155 -0
- data/lib/mx_platform_api/models/processor_owner_body.rb +95 -0
- data/lib/mx_platform_api/models/property_type.rb +69 -0
- data/lib/mx_platform_api/models/recurrence_type.rb +26 -0
- data/lib/mx_platform_api/models/repeating_transaction.rb +102 -0
- data/lib/mx_platform_api/models/repeating_transaction_response.rb +203 -0
- data/lib/mx_platform_api/models/repeating_transaction_type.rb +44 -0
- data/lib/mx_platform_api/models/repeating_transactions_response_body.rb +85 -0
- data/lib/mx_platform_api/models/reposition_request.rb +82 -0
- data/lib/mx_platform_api/models/reposition_request_body.rb +84 -0
- data/lib/mx_platform_api/models/reposition_response_body.rb +84 -0
- data/lib/mx_platform_api/models/reward.rb +187 -0
- data/lib/mx_platform_api/models/reward_elements.rb +156 -0
- data/lib/mx_platform_api/models/reward_response_body.rb +75 -0
- data/lib/mx_platform_api/models/rewards_response_body.rb +94 -0
- data/lib/mx_platform_api/models/scheduled_payment_response.rb +208 -0
- data/lib/mx_platform_api/models/scheduled_payments_response_body.rb +95 -0
- data/lib/mx_platform_api/models/spending_plan_account_response.rb +142 -0
- data/lib/mx_platform_api/models/spending_plan_accounts_response.rb +95 -0
- data/lib/mx_platform_api/models/spending_plan_iteration_item_create_request_body.rb +124 -0
- data/lib/mx_platform_api/models/spending_plan_iteration_item_response.rb +224 -0
- data/lib/mx_platform_api/models/spending_plan_iteration_items_response_body.rb +95 -0
- data/lib/mx_platform_api/models/spending_plan_iteration_response.rb +162 -0
- data/lib/mx_platform_api/models/spending_plan_iterations_response.rb +95 -0
- data/lib/mx_platform_api/models/spending_plan_response.rb +129 -0
- data/lib/mx_platform_api/models/spending_plans_response_body.rb +95 -0
- data/lib/mx_platform_api/models/split_transaction_request.rb +106 -0
- data/lib/mx_platform_api/models/split_transaction_request_body.rb +75 -0
- data/lib/mx_platform_api/models/split_transactions_response_body.rb +85 -0
- data/lib/mx_platform_api/models/statement_response.rb +157 -0
- data/lib/mx_platform_api/models/statement_response_body.rb +76 -0
- data/lib/mx_platform_api/models/statements_response_body.rb +95 -0
- data/lib/mx_platform_api/models/status.rb +36 -0
- data/lib/mx_platform_api/models/style.rb +74 -0
- data/lib/mx_platform_api/models/supported_product.rb +56 -0
- data/lib/mx_platform_api/models/supported_product1.rb +52 -0
- data/lib/mx_platform_api/models/tag_create_request.rb +72 -0
- data/lib/mx_platform_api/models/tag_create_request_body.rb +74 -0
- data/lib/mx_platform_api/models/tag_response.rb +99 -0
- data/lib/mx_platform_api/models/tag_response_body.rb +74 -0
- data/lib/mx_platform_api/models/tag_update_request.rb +72 -0
- data/lib/mx_platform_api/models/tag_update_request_body.rb +74 -0
- data/lib/mx_platform_api/models/tagging_create_request.rb +83 -0
- data/lib/mx_platform_api/models/tagging_create_request_body.rb +75 -0
- data/lib/mx_platform_api/models/tagging_response.rb +130 -0
- data/lib/mx_platform_api/models/tagging_response_body.rb +75 -0
- data/lib/mx_platform_api/models/tagging_update_request.rb +73 -0
- data/lib/mx_platform_api/models/tagging_update_request_body.rb +75 -0
- data/lib/mx_platform_api/models/taggings_response_body.rb +94 -0
- data/lib/mx_platform_api/models/tags_response_body.rb +94 -0
- data/lib/mx_platform_api/models/token_request_body.rb +75 -0
- data/lib/mx_platform_api/models/token_response.rb +114 -0
- data/lib/mx_platform_api/models/token_response_body.rb +84 -0
- data/lib/mx_platform_api/models/track_type_name.rb +44 -0
- data/lib/mx_platform_api/models/transaction_create_request.rb +192 -0
- data/lib/mx_platform_api/models/transaction_create_request_body.rb +76 -0
- data/lib/mx_platform_api/models/transaction_create_response_body.rb +595 -0
- data/lib/mx_platform_api/models/transaction_includes_response.rb +643 -0
- data/lib/mx_platform_api/models/transaction_response.rb +597 -0
- data/lib/mx_platform_api/models/transaction_response_body.rb +76 -0
- data/lib/mx_platform_api/models/transaction_rule_create_request.rb +98 -0
- data/lib/mx_platform_api/models/transaction_rule_create_request_body.rb +77 -0
- data/lib/mx_platform_api/models/transaction_rule_response.rb +152 -0
- data/lib/mx_platform_api/models/transaction_rule_response_body.rb +77 -0
- data/lib/mx_platform_api/models/transaction_rule_update_request.rb +103 -0
- data/lib/mx_platform_api/models/transaction_rule_update_request_body.rb +77 -0
- data/lib/mx_platform_api/models/transaction_rules_response_body.rb +95 -0
- data/lib/mx_platform_api/models/transaction_type.rb +36 -0
- data/lib/mx_platform_api/models/transaction_update_request.rb +74 -0
- data/lib/mx_platform_api/models/transaction_update_request_body.rb +76 -0
- data/lib/mx_platform_api/models/transactions_response_body.rb +95 -0
- data/lib/mx_platform_api/models/transactions_response_body_includes.rb +95 -0
- data/lib/mx_platform_api/models/type.rb +36 -0
- data/lib/mx_platform_api/models/update_goal_request.rb +185 -0
- data/lib/mx_platform_api/models/update_goal_request_body.rb +74 -0
- data/lib/mx_platform_api/models/use_case.rb +36 -0
- data/lib/mx_platform_api/models/user_create_request.rb +105 -0
- data/lib/mx_platform_api/models/user_create_request_body.rb +74 -0
- data/lib/mx_platform_api/models/user_response.rb +119 -0
- data/lib/mx_platform_api/models/user_response_body.rb +74 -0
- data/lib/mx_platform_api/models/user_update_request.rb +105 -0
- data/lib/mx_platform_api/models/user_update_request_body.rb +74 -0
- data/lib/mx_platform_api/models/users_response_body.rb +94 -0
- data/lib/mx_platform_api/models/users_widget_urls_request.rb +76 -0
- data/lib/mx_platform_api/models/vc_response.rb +77 -0
- data/lib/mx_platform_api/models/widget_request.rb +466 -0
- data/lib/mx_platform_api/models/widget_response.rb +100 -0
- data/lib/mx_platform_api/models/widget_response_body.rb +76 -0
- data/lib/mx_platform_api/models/widget_type.rb +149 -0
- data/lib/mx_platform_api/utilities/date_time_helper.rb +11 -0
- data/lib/mx_platform_api/utilities/file_wrapper.rb +28 -0
- data/lib/mx_platform_api.rb +313 -0
- metadata +370 -0
|
@@ -0,0 +1,773 @@
|
|
|
1
|
+
# mx_platform_api
|
|
2
|
+
#
|
|
3
|
+
# This file was automatically generated by APIMATIC v3.0 (
|
|
4
|
+
# https://www.apimatic.io ).
|
|
5
|
+
|
|
6
|
+
module MxPlatformApi
|
|
7
|
+
# ManagedDataDeprecatedApi
|
|
8
|
+
class ManagedDataDeprecatedApi < BaseApi
|
|
9
|
+
# This endpoint returns a list of institutions which can be used to create
|
|
10
|
+
# partner-managed members.
|
|
11
|
+
# :::warning Deprecated
|
|
12
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
13
|
+
# [Migration guide](/api-reference/platform-api/overview/migration)
|
|
14
|
+
# :::
|
|
15
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
16
|
+
# version.
|
|
17
|
+
# @param [Integer] page Optional parameter: Results are paginated. Specify
|
|
18
|
+
# current page.
|
|
19
|
+
# @param [Integer] records_per_page Optional parameter: This specifies the
|
|
20
|
+
# number of records to be returned on each page. Defaults to `25`. The valid
|
|
21
|
+
# range is from `10` to `1000`. If the value exceeds `1000`, the default
|
|
22
|
+
# value of `25` will be used instead.
|
|
23
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
24
|
+
def list_managed_institutions(accept_version,
|
|
25
|
+
page: nil,
|
|
26
|
+
records_per_page: nil)
|
|
27
|
+
warn 'Endpoint list_managed_institutions in ManagedDataDeprecatedApi is '\
|
|
28
|
+
'deprecated'
|
|
29
|
+
@api_call
|
|
30
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
31
|
+
'/managed_institutions',
|
|
32
|
+
Server::DEFAULT)
|
|
33
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
34
|
+
.is_required(true))
|
|
35
|
+
.query_param(new_parameter(page, key: 'page'))
|
|
36
|
+
.query_param(new_parameter(records_per_page, key: 'records_per_page'))
|
|
37
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
38
|
+
.auth(Single.new('basicAuth')))
|
|
39
|
+
.response(new_response_handler
|
|
40
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
41
|
+
.deserialize_into(InstitutionsResponseBody.method(:from_hash))
|
|
42
|
+
.is_api_response(true))
|
|
43
|
+
.execute
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# This endpoint returns a list of all the partner-managed members associated
|
|
47
|
+
# with the specified `user`.
|
|
48
|
+
# :::warning Deprecated
|
|
49
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
50
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
51
|
+
# :::
|
|
52
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
53
|
+
# version.
|
|
54
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
55
|
+
# `user`, beginning with the prefix `USR-`.
|
|
56
|
+
# @param [Integer] page Optional parameter: Results are paginated. Specify
|
|
57
|
+
# current page.
|
|
58
|
+
# @param [Integer] records_per_page Optional parameter: This specifies the
|
|
59
|
+
# number of records to be returned on each page. Defaults to `25`. The valid
|
|
60
|
+
# range is from `10` to `1000`. If the value exceeds `1000`, the default
|
|
61
|
+
# value of `25` will be used instead.
|
|
62
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
63
|
+
def list_managed_members(accept_version,
|
|
64
|
+
user_guid,
|
|
65
|
+
page: nil,
|
|
66
|
+
records_per_page: nil)
|
|
67
|
+
warn 'Endpoint list_managed_members in ManagedDataDeprecatedApi is depre'\
|
|
68
|
+
'cated'
|
|
69
|
+
@api_call
|
|
70
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
71
|
+
'/users/{user_guid}/managed_members',
|
|
72
|
+
Server::DEFAULT)
|
|
73
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
74
|
+
.is_required(true))
|
|
75
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
76
|
+
.is_required(true)
|
|
77
|
+
.should_encode(true))
|
|
78
|
+
.query_param(new_parameter(page, key: 'page'))
|
|
79
|
+
.query_param(new_parameter(records_per_page, key: 'records_per_page'))
|
|
80
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
81
|
+
.auth(Single.new('basicAuth')))
|
|
82
|
+
.response(new_response_handler
|
|
83
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
84
|
+
.deserialize_into(MembersResponseBody.method(:from_hash))
|
|
85
|
+
.is_api_response(true))
|
|
86
|
+
.execute
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Use this endpoint to create a new partner-managed `member`.
|
|
90
|
+
# :::warning Deprecated
|
|
91
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
92
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
93
|
+
# :::
|
|
94
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
95
|
+
# version.
|
|
96
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
97
|
+
# `user`, beginning with the prefix `USR-`.
|
|
98
|
+
# @param [ManagedMemberCreateRequestBody] body Required parameter: Managed
|
|
99
|
+
# member to be created.
|
|
100
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
101
|
+
def create_managed_member(accept_version,
|
|
102
|
+
user_guid,
|
|
103
|
+
body)
|
|
104
|
+
warn 'Endpoint create_managed_member in ManagedDataDeprecatedApi is depr'\
|
|
105
|
+
'ecated'
|
|
106
|
+
@api_call
|
|
107
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
108
|
+
'/users/{user_guid}/managed_members',
|
|
109
|
+
Server::DEFAULT)
|
|
110
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
111
|
+
.is_required(true))
|
|
112
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
113
|
+
.is_required(true)
|
|
114
|
+
.should_encode(true))
|
|
115
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
116
|
+
.body_param(new_parameter(body)
|
|
117
|
+
.is_required(true))
|
|
118
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
119
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
120
|
+
.auth(Single.new('basicAuth')))
|
|
121
|
+
.response(new_response_handler
|
|
122
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
123
|
+
.deserialize_into(MemberResponseBody.method(:from_hash))
|
|
124
|
+
.is_api_response(true))
|
|
125
|
+
.execute
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Use this endpoint to delete the specified partner-managed `member`. The
|
|
129
|
+
# endpoint will respond with a status of `204 No Content` without a
|
|
130
|
+
# resource.
|
|
131
|
+
# :::warning Deprecated
|
|
132
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
133
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
134
|
+
# :::
|
|
135
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
136
|
+
# version.
|
|
137
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
138
|
+
# `member`.
|
|
139
|
+
# @param [String] accept Required parameter: Specifies the media type
|
|
140
|
+
# expected in the response.
|
|
141
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
142
|
+
# `user`, beginning with the prefix `USR-`.
|
|
143
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
144
|
+
def delete_managed_member(accept_version,
|
|
145
|
+
member_guid,
|
|
146
|
+
accept,
|
|
147
|
+
user_guid)
|
|
148
|
+
warn 'Endpoint delete_managed_member in ManagedDataDeprecatedApi is depr'\
|
|
149
|
+
'ecated'
|
|
150
|
+
@api_call
|
|
151
|
+
.request(new_request_builder(HttpMethodEnum::DELETE,
|
|
152
|
+
'/users/{user_guid}/managed_members/{member_guid}',
|
|
153
|
+
Server::DEFAULT)
|
|
154
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
155
|
+
.is_required(true))
|
|
156
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
157
|
+
.is_required(true)
|
|
158
|
+
.should_encode(true))
|
|
159
|
+
.header_param(new_parameter(accept, key: 'Accept')
|
|
160
|
+
.is_required(true))
|
|
161
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
162
|
+
.is_required(true)
|
|
163
|
+
.should_encode(true))
|
|
164
|
+
.auth(Single.new('basicAuth')))
|
|
165
|
+
.response(new_response_handler
|
|
166
|
+
.is_response_void(true)
|
|
167
|
+
.is_api_response(true))
|
|
168
|
+
.execute
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# This endpoint returns the attributes of the specified
|
|
172
|
+
# partner-managed`member`.
|
|
173
|
+
# :::warning Deprecated
|
|
174
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
175
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
176
|
+
# :::
|
|
177
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
178
|
+
# version.
|
|
179
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
180
|
+
# `member`.
|
|
181
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
182
|
+
# `user`, beginning with the prefix `USR-`.
|
|
183
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
184
|
+
def read_managed_member(accept_version,
|
|
185
|
+
member_guid,
|
|
186
|
+
user_guid)
|
|
187
|
+
warn 'Endpoint read_managed_member in ManagedDataDeprecatedApi is deprec'\
|
|
188
|
+
'ated'
|
|
189
|
+
@api_call
|
|
190
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
191
|
+
'/users/{user_guid}/managed_members/{member_guid}',
|
|
192
|
+
Server::DEFAULT)
|
|
193
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
194
|
+
.is_required(true))
|
|
195
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
196
|
+
.is_required(true)
|
|
197
|
+
.should_encode(true))
|
|
198
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
199
|
+
.is_required(true)
|
|
200
|
+
.should_encode(true))
|
|
201
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
202
|
+
.auth(Single.new('basicAuth')))
|
|
203
|
+
.response(new_response_handler
|
|
204
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
205
|
+
.deserialize_into(MemberResponseBody.method(:from_hash))
|
|
206
|
+
.is_api_response(true))
|
|
207
|
+
.execute
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Use this endpoint to update the attributes of the specified
|
|
211
|
+
# partner_managed `member`.
|
|
212
|
+
# :::warning Deprecated
|
|
213
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
214
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
215
|
+
# :::
|
|
216
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
217
|
+
# version.
|
|
218
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
219
|
+
# `member`.
|
|
220
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
221
|
+
# `user`, beginning with the prefix `USR-`.
|
|
222
|
+
# @param [ManagedMemberUpdateRequestBody] body Required parameter: Managed
|
|
223
|
+
# member object to be updated (While no single parameter is required, the
|
|
224
|
+
# request body can't be empty). :::warning Deprecated This endpoint has
|
|
225
|
+
# been deprecated. For more information, reference the [Migration
|
|
226
|
+
# guide](/api-reference/platform-api/overview/migration). :::
|
|
227
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
228
|
+
def update_managed_member(accept_version,
|
|
229
|
+
member_guid,
|
|
230
|
+
user_guid,
|
|
231
|
+
body)
|
|
232
|
+
warn 'Endpoint update_managed_member in ManagedDataDeprecatedApi is depr'\
|
|
233
|
+
'ecated'
|
|
234
|
+
@api_call
|
|
235
|
+
.request(new_request_builder(HttpMethodEnum::PUT,
|
|
236
|
+
'/users/{user_guid}/managed_members/{member_guid}',
|
|
237
|
+
Server::DEFAULT)
|
|
238
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
239
|
+
.is_required(true))
|
|
240
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
241
|
+
.is_required(true)
|
|
242
|
+
.should_encode(true))
|
|
243
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
244
|
+
.is_required(true)
|
|
245
|
+
.should_encode(true))
|
|
246
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
247
|
+
.body_param(new_parameter(body)
|
|
248
|
+
.is_required(true))
|
|
249
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
250
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
251
|
+
.auth(Single.new('basicAuth')))
|
|
252
|
+
.response(new_response_handler
|
|
253
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
254
|
+
.deserialize_into(MemberResponseBody.method(:from_hash))
|
|
255
|
+
.is_api_response(true))
|
|
256
|
+
.execute
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Use this endpoint to retrieve a list of all the partner-managed accounts
|
|
260
|
+
# associated with the given partner-managed member.
|
|
261
|
+
# :::warning Deprecated
|
|
262
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
263
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
264
|
+
# :::
|
|
265
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
266
|
+
# version.
|
|
267
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
268
|
+
# `member`.
|
|
269
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
270
|
+
# `user`, beginning with the prefix `USR-`.
|
|
271
|
+
# @param [Integer] page Optional parameter: Results are paginated. Specify
|
|
272
|
+
# current page.
|
|
273
|
+
# @param [Integer] records_per_page Optional parameter: This specifies the
|
|
274
|
+
# number of records to be returned on each page. Defaults to `25`. The valid
|
|
275
|
+
# range is from `10` to `1000`. If the value exceeds `1000`, the default
|
|
276
|
+
# value of `25` will be used instead.
|
|
277
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
278
|
+
def list_managed_accounts(accept_version,
|
|
279
|
+
member_guid,
|
|
280
|
+
user_guid,
|
|
281
|
+
page: nil,
|
|
282
|
+
records_per_page: nil)
|
|
283
|
+
warn 'Endpoint list_managed_accounts in ManagedDataDeprecatedApi is depr'\
|
|
284
|
+
'ecated'
|
|
285
|
+
@api_call
|
|
286
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
287
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts',
|
|
288
|
+
Server::DEFAULT)
|
|
289
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
290
|
+
.is_required(true))
|
|
291
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
292
|
+
.is_required(true)
|
|
293
|
+
.should_encode(true))
|
|
294
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
295
|
+
.is_required(true)
|
|
296
|
+
.should_encode(true))
|
|
297
|
+
.query_param(new_parameter(page, key: 'page'))
|
|
298
|
+
.query_param(new_parameter(records_per_page, key: 'records_per_page'))
|
|
299
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
300
|
+
.auth(Single.new('basicAuth')))
|
|
301
|
+
.response(new_response_handler
|
|
302
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
303
|
+
.deserialize_into(AccountsResponseBody.method(:from_hash))
|
|
304
|
+
.is_api_response(true))
|
|
305
|
+
.execute
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# Use this endpoint to create a partner-managed account.
|
|
309
|
+
# :::warning Deprecated
|
|
310
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
311
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
312
|
+
# :::
|
|
313
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
314
|
+
# version.
|
|
315
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
316
|
+
# `member`.
|
|
317
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
318
|
+
# `user`, beginning with the prefix `USR-`.
|
|
319
|
+
# @param [ManagedAccountCreateRequestBody] body Required parameter: Managed
|
|
320
|
+
# account to be created.
|
|
321
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
322
|
+
def create_managed_account(accept_version,
|
|
323
|
+
member_guid,
|
|
324
|
+
user_guid,
|
|
325
|
+
body)
|
|
326
|
+
warn 'Endpoint create_managed_account in ManagedDataDeprecatedApi is dep'\
|
|
327
|
+
'recated'
|
|
328
|
+
@api_call
|
|
329
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
330
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts',
|
|
331
|
+
Server::DEFAULT)
|
|
332
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
333
|
+
.is_required(true))
|
|
334
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
335
|
+
.is_required(true)
|
|
336
|
+
.should_encode(true))
|
|
337
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
338
|
+
.is_required(true)
|
|
339
|
+
.should_encode(true))
|
|
340
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
341
|
+
.body_param(new_parameter(body)
|
|
342
|
+
.is_required(true))
|
|
343
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
344
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
345
|
+
.auth(Single.new('basicAuth')))
|
|
346
|
+
.response(new_response_handler
|
|
347
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
348
|
+
.deserialize_into(AccountResponseBody.method(:from_hash))
|
|
349
|
+
.is_api_response(true))
|
|
350
|
+
.execute
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
# Use this endpoint to delete a partner-managed account according to its
|
|
354
|
+
# unique GUID. If successful, the API will respond with a status of `204 No
|
|
355
|
+
# Content`.
|
|
356
|
+
# :::warning Deprecated
|
|
357
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
358
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
359
|
+
# :::
|
|
360
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
361
|
+
# version.
|
|
362
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
363
|
+
# `account`.
|
|
364
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
365
|
+
# `member`.
|
|
366
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
367
|
+
# `user`, beginning with the prefix `USR-`.
|
|
368
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
369
|
+
def delete_managed_account(accept_version,
|
|
370
|
+
account_guid,
|
|
371
|
+
member_guid,
|
|
372
|
+
user_guid)
|
|
373
|
+
warn 'Endpoint delete_managed_account in ManagedDataDeprecatedApi is dep'\
|
|
374
|
+
'recated'
|
|
375
|
+
@api_call
|
|
376
|
+
.request(new_request_builder(HttpMethodEnum::DELETE,
|
|
377
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}',
|
|
378
|
+
Server::DEFAULT)
|
|
379
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
380
|
+
.is_required(true))
|
|
381
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
382
|
+
.is_required(true)
|
|
383
|
+
.should_encode(true))
|
|
384
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
385
|
+
.is_required(true)
|
|
386
|
+
.should_encode(true))
|
|
387
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
388
|
+
.is_required(true)
|
|
389
|
+
.should_encode(true))
|
|
390
|
+
.auth(Single.new('basicAuth')))
|
|
391
|
+
.response(new_response_handler
|
|
392
|
+
.is_response_void(true)
|
|
393
|
+
.is_api_response(true))
|
|
394
|
+
.execute
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
# Use this endpoint to read the attributes of a partner-managed account
|
|
398
|
+
# according to its unique guid.
|
|
399
|
+
# :::warning Deprecated
|
|
400
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
401
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
402
|
+
# :::
|
|
403
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
404
|
+
# version.
|
|
405
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
406
|
+
# `account`.
|
|
407
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
408
|
+
# `member`.
|
|
409
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
410
|
+
# `user`, beginning with the prefix `USR-`.
|
|
411
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
412
|
+
def read_managed_account(accept_version,
|
|
413
|
+
account_guid,
|
|
414
|
+
member_guid,
|
|
415
|
+
user_guid)
|
|
416
|
+
warn 'Endpoint read_managed_account in ManagedDataDeprecatedApi is depre'\
|
|
417
|
+
'cated'
|
|
418
|
+
@api_call
|
|
419
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
420
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}',
|
|
421
|
+
Server::DEFAULT)
|
|
422
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
423
|
+
.is_required(true))
|
|
424
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
425
|
+
.is_required(true)
|
|
426
|
+
.should_encode(true))
|
|
427
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
428
|
+
.is_required(true)
|
|
429
|
+
.should_encode(true))
|
|
430
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
431
|
+
.is_required(true)
|
|
432
|
+
.should_encode(true))
|
|
433
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
434
|
+
.auth(Single.new('basicAuth')))
|
|
435
|
+
.response(new_response_handler
|
|
436
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
437
|
+
.deserialize_into(AccountResponseBody.method(:from_hash))
|
|
438
|
+
.is_api_response(true))
|
|
439
|
+
.execute
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
# Use this endpoint to update the attributes of a partner-managed account
|
|
443
|
+
# according to its unique GUID.
|
|
444
|
+
# :::warning Deprecated
|
|
445
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
446
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
447
|
+
# :::
|
|
448
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
449
|
+
# version.
|
|
450
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
451
|
+
# `account`.
|
|
452
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
453
|
+
# `member`.
|
|
454
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
455
|
+
# `user`, beginning with the prefix `USR-`.
|
|
456
|
+
# @param [ManagedAccountUpdateRequestBody] body Required parameter: Managed
|
|
457
|
+
# account object to be updated (While no single parameter is required, the
|
|
458
|
+
# request body can't be empty).
|
|
459
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
460
|
+
def update_managed_account(accept_version,
|
|
461
|
+
account_guid,
|
|
462
|
+
member_guid,
|
|
463
|
+
user_guid,
|
|
464
|
+
body)
|
|
465
|
+
warn 'Endpoint update_managed_account in ManagedDataDeprecatedApi is dep'\
|
|
466
|
+
'recated'
|
|
467
|
+
@api_call
|
|
468
|
+
.request(new_request_builder(HttpMethodEnum::PUT,
|
|
469
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}',
|
|
470
|
+
Server::DEFAULT)
|
|
471
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
472
|
+
.is_required(true))
|
|
473
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
474
|
+
.is_required(true)
|
|
475
|
+
.should_encode(true))
|
|
476
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
477
|
+
.is_required(true)
|
|
478
|
+
.should_encode(true))
|
|
479
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
480
|
+
.is_required(true)
|
|
481
|
+
.should_encode(true))
|
|
482
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
483
|
+
.body_param(new_parameter(body)
|
|
484
|
+
.is_required(true))
|
|
485
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
486
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
487
|
+
.auth(Single.new('basicAuth')))
|
|
488
|
+
.response(new_response_handler
|
|
489
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
490
|
+
.deserialize_into(AccountResponseBody.method(:from_hash))
|
|
491
|
+
.is_api_response(true))
|
|
492
|
+
.execute
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
# This endpoint returns a list of all the partner-managed transactions
|
|
496
|
+
# associated with the specified `account`, scoped through a `user` and a
|
|
497
|
+
# `member`.
|
|
498
|
+
# :::warning Deprecated
|
|
499
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
500
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
501
|
+
# :::
|
|
502
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
503
|
+
# version.
|
|
504
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
505
|
+
# `account`.
|
|
506
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
507
|
+
# `member`.
|
|
508
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
509
|
+
# `user`, beginning with the prefix `USR-`.
|
|
510
|
+
# @param [Integer] page Optional parameter: Results are paginated. Specify
|
|
511
|
+
# current page.
|
|
512
|
+
# @param [String] from_date Optional parameter: Filter transactions from
|
|
513
|
+
# this date. This only supports ISO 8601 format without timestamp
|
|
514
|
+
# (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
515
|
+
# @param [String] to_date Optional parameter: Filter transactions to this
|
|
516
|
+
# date (at midnight). This only supports ISO 8601 format without timestamp
|
|
517
|
+
# (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made
|
|
518
|
+
# to capture pending transactions.
|
|
519
|
+
# @param [Integer] records_per_page Optional parameter: This specifies the
|
|
520
|
+
# number of records to be returned on each page. Defaults to `25`. The valid
|
|
521
|
+
# range is from `10` to `1000`. If the value exceeds `1000`, the default
|
|
522
|
+
# value of `25` will be used instead.
|
|
523
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
524
|
+
def list_managed_transactions(accept_version,
|
|
525
|
+
account_guid,
|
|
526
|
+
member_guid,
|
|
527
|
+
user_guid,
|
|
528
|
+
page: nil,
|
|
529
|
+
from_date: nil,
|
|
530
|
+
to_date: nil,
|
|
531
|
+
records_per_page: nil)
|
|
532
|
+
warn 'Endpoint list_managed_transactions in ManagedDataDeprecatedApi is '\
|
|
533
|
+
'deprecated'
|
|
534
|
+
@api_call
|
|
535
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
536
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions',
|
|
537
|
+
Server::DEFAULT)
|
|
538
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
539
|
+
.is_required(true))
|
|
540
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
541
|
+
.is_required(true)
|
|
542
|
+
.should_encode(true))
|
|
543
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
544
|
+
.is_required(true)
|
|
545
|
+
.should_encode(true))
|
|
546
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
547
|
+
.is_required(true)
|
|
548
|
+
.should_encode(true))
|
|
549
|
+
.query_param(new_parameter(page, key: 'page'))
|
|
550
|
+
.query_param(new_parameter(from_date, key: 'from_date'))
|
|
551
|
+
.query_param(new_parameter(to_date, key: 'to_date'))
|
|
552
|
+
.query_param(new_parameter(records_per_page, key: 'records_per_page'))
|
|
553
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
554
|
+
.auth(Single.new('basicAuth')))
|
|
555
|
+
.response(new_response_handler
|
|
556
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
557
|
+
.deserialize_into(TransactionsResponseBody.method(:from_hash))
|
|
558
|
+
.is_api_response(true))
|
|
559
|
+
.execute
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
# Use this endpoint to create a new partner-managed `transaction`.
|
|
563
|
+
# :::warning Deprecated
|
|
564
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
565
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
566
|
+
# :::
|
|
567
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
568
|
+
# version.
|
|
569
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
570
|
+
# `account`.
|
|
571
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
572
|
+
# `member`.
|
|
573
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
574
|
+
# `user`, beginning with the prefix `USR-`.
|
|
575
|
+
# @param [ManagedTransactionCreateRequestBody] body Required parameter:
|
|
576
|
+
# Managed transaction to be created.
|
|
577
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
578
|
+
def create_managed_transaction(accept_version,
|
|
579
|
+
account_guid,
|
|
580
|
+
member_guid,
|
|
581
|
+
user_guid,
|
|
582
|
+
body)
|
|
583
|
+
warn 'Endpoint create_managed_transaction in ManagedDataDeprecatedApi is'\
|
|
584
|
+
' deprecated'
|
|
585
|
+
@api_call
|
|
586
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
|
587
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions',
|
|
588
|
+
Server::DEFAULT)
|
|
589
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
590
|
+
.is_required(true))
|
|
591
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
592
|
+
.is_required(true)
|
|
593
|
+
.should_encode(true))
|
|
594
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
595
|
+
.is_required(true)
|
|
596
|
+
.should_encode(true))
|
|
597
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
598
|
+
.is_required(true)
|
|
599
|
+
.should_encode(true))
|
|
600
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
601
|
+
.body_param(new_parameter(body)
|
|
602
|
+
.is_required(true))
|
|
603
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
604
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
605
|
+
.auth(Single.new('basicAuth')))
|
|
606
|
+
.response(new_response_handler
|
|
607
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
608
|
+
.deserialize_into(TransactionResponseBody.method(:from_hash))
|
|
609
|
+
.is_api_response(true))
|
|
610
|
+
.execute
|
|
611
|
+
end
|
|
612
|
+
|
|
613
|
+
# Use this endpoint to delete the specified partner-managed `transaction`.
|
|
614
|
+
# The endpoint will respond with a status of `204 No Content` without a
|
|
615
|
+
# resource.
|
|
616
|
+
# :::warning Deprecated
|
|
617
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
618
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
619
|
+
# :::
|
|
620
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
621
|
+
# version.
|
|
622
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
623
|
+
# `account`.
|
|
624
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
625
|
+
# `member`.
|
|
626
|
+
# @param [String] transaction_guid Required parameter: The unique id for a
|
|
627
|
+
# `transaction`.
|
|
628
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
629
|
+
# `user`, beginning with the prefix `USR-`.
|
|
630
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
631
|
+
def delete_managed_transaction(accept_version,
|
|
632
|
+
account_guid,
|
|
633
|
+
member_guid,
|
|
634
|
+
transaction_guid,
|
|
635
|
+
user_guid)
|
|
636
|
+
warn 'Endpoint delete_managed_transaction in ManagedDataDeprecatedApi is'\
|
|
637
|
+
' deprecated'
|
|
638
|
+
@api_call
|
|
639
|
+
.request(new_request_builder(HttpMethodEnum::DELETE,
|
|
640
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}',
|
|
641
|
+
Server::DEFAULT)
|
|
642
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
643
|
+
.is_required(true))
|
|
644
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
645
|
+
.is_required(true)
|
|
646
|
+
.should_encode(true))
|
|
647
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
648
|
+
.is_required(true)
|
|
649
|
+
.should_encode(true))
|
|
650
|
+
.template_param(new_parameter(transaction_guid, key: 'transaction_guid')
|
|
651
|
+
.is_required(true)
|
|
652
|
+
.should_encode(true))
|
|
653
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
654
|
+
.is_required(true)
|
|
655
|
+
.should_encode(true))
|
|
656
|
+
.auth(Single.new('basicAuth')))
|
|
657
|
+
.response(new_response_handler
|
|
658
|
+
.is_response_void(true)
|
|
659
|
+
.is_api_response(true))
|
|
660
|
+
.execute
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
# Requests to this endpoint will return the attributes of the specified
|
|
664
|
+
# partner-managed `transaction`.
|
|
665
|
+
# :::warning Deprecated
|
|
666
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
667
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
668
|
+
# :::
|
|
669
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
670
|
+
# version.
|
|
671
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
672
|
+
# `account`.
|
|
673
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
674
|
+
# `member`.
|
|
675
|
+
# @param [String] transaction_guid Required parameter: The unique id for a
|
|
676
|
+
# `transaction`.
|
|
677
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
678
|
+
# `user`, beginning with the prefix `USR-`.
|
|
679
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
680
|
+
def read_managed_transaction(accept_version,
|
|
681
|
+
account_guid,
|
|
682
|
+
member_guid,
|
|
683
|
+
transaction_guid,
|
|
684
|
+
user_guid)
|
|
685
|
+
warn 'Endpoint read_managed_transaction in ManagedDataDeprecatedApi is d'\
|
|
686
|
+
'eprecated'
|
|
687
|
+
@api_call
|
|
688
|
+
.request(new_request_builder(HttpMethodEnum::GET,
|
|
689
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}',
|
|
690
|
+
Server::DEFAULT)
|
|
691
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
692
|
+
.is_required(true))
|
|
693
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
694
|
+
.is_required(true)
|
|
695
|
+
.should_encode(true))
|
|
696
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
697
|
+
.is_required(true)
|
|
698
|
+
.should_encode(true))
|
|
699
|
+
.template_param(new_parameter(transaction_guid, key: 'transaction_guid')
|
|
700
|
+
.is_required(true)
|
|
701
|
+
.should_encode(true))
|
|
702
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
703
|
+
.is_required(true)
|
|
704
|
+
.should_encode(true))
|
|
705
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
706
|
+
.auth(Single.new('basicAuth')))
|
|
707
|
+
.response(new_response_handler
|
|
708
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
709
|
+
.deserialize_into(TransactionResponseBody.method(:from_hash))
|
|
710
|
+
.is_api_response(true))
|
|
711
|
+
.execute
|
|
712
|
+
end
|
|
713
|
+
|
|
714
|
+
# Use this endpoint to update the attributes of the specified
|
|
715
|
+
# partner_managed `transaction`.
|
|
716
|
+
# :::warning Deprecated
|
|
717
|
+
# This endpoint has been deprecated. For more information, reference the
|
|
718
|
+
# [Migration guide](/api-reference/platform-api/overview/migration).
|
|
719
|
+
# :::
|
|
720
|
+
# @param [String] accept_version Required parameter: MX Platform API
|
|
721
|
+
# version.
|
|
722
|
+
# @param [String] account_guid Required parameter: The unique id for an
|
|
723
|
+
# `account`.
|
|
724
|
+
# @param [String] member_guid Required parameter: The unique id for a
|
|
725
|
+
# `member`.
|
|
726
|
+
# @param [String] transaction_guid Required parameter: The unique id for a
|
|
727
|
+
# `transaction`.
|
|
728
|
+
# @param [String] user_guid Required parameter: The unique identifier for a
|
|
729
|
+
# `user`, beginning with the prefix `USR-`.
|
|
730
|
+
# @param [ManagedTransactionUpdateRequestBody] body Required parameter:
|
|
731
|
+
# Managed transaction object to be updated (While no single parameter is
|
|
732
|
+
# required, the request body can't be empty)
|
|
733
|
+
# @return [ApiResponse] Complete http response with raw body and status code.
|
|
734
|
+
def update_managed_transaction(accept_version,
|
|
735
|
+
account_guid,
|
|
736
|
+
member_guid,
|
|
737
|
+
transaction_guid,
|
|
738
|
+
user_guid,
|
|
739
|
+
body)
|
|
740
|
+
warn 'Endpoint update_managed_transaction in ManagedDataDeprecatedApi is'\
|
|
741
|
+
' deprecated'
|
|
742
|
+
@api_call
|
|
743
|
+
.request(new_request_builder(HttpMethodEnum::PUT,
|
|
744
|
+
'/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}',
|
|
745
|
+
Server::DEFAULT)
|
|
746
|
+
.header_param(new_parameter(accept_version, key: 'Accept-Version')
|
|
747
|
+
.is_required(true))
|
|
748
|
+
.template_param(new_parameter(account_guid, key: 'account_guid')
|
|
749
|
+
.is_required(true)
|
|
750
|
+
.should_encode(true))
|
|
751
|
+
.template_param(new_parameter(member_guid, key: 'member_guid')
|
|
752
|
+
.is_required(true)
|
|
753
|
+
.should_encode(true))
|
|
754
|
+
.template_param(new_parameter(transaction_guid, key: 'transaction_guid')
|
|
755
|
+
.is_required(true)
|
|
756
|
+
.should_encode(true))
|
|
757
|
+
.template_param(new_parameter(user_guid, key: 'user_guid')
|
|
758
|
+
.is_required(true)
|
|
759
|
+
.should_encode(true))
|
|
760
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
|
761
|
+
.body_param(new_parameter(body)
|
|
762
|
+
.is_required(true))
|
|
763
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
|
764
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
|
765
|
+
.auth(Single.new('basicAuth')))
|
|
766
|
+
.response(new_response_handler
|
|
767
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
|
768
|
+
.deserialize_into(TransactionResponseBody.method(:from_hash))
|
|
769
|
+
.is_api_response(true))
|
|
770
|
+
.execute
|
|
771
|
+
end
|
|
772
|
+
end
|
|
773
|
+
end
|