Class: MxPlatformRuby::MxPlatformApi
- Inherits:
-
Object
- Object
- MxPlatformRuby::MxPlatformApi
- Defined in:
- lib/mx-platform-ruby/api/mx_platform_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#aggregate_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Aggregate member Calling this endpoint initiates an aggregation event for the member.
-
#aggregate_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Aggregate member Calling this endpoint initiates an aggregation event for the member.
-
#check_balances(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
-
#check_balances_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
-
#create_category(user_guid, category_create_request_body, opts = {}) ⇒ CategoryResponseBody
Create category Use this endpoint to create a new custom category for a specific ‘user`.
-
#create_category_with_http_info(user_guid, category_create_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Create category Use this endpoint to create a new custom category for a specific `user`.
-
#create_managed_account(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ AccountResponseBody
Create managed account Use this endpoint to create a partner-managed account.
-
#create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Create managed account Use this endpoint to create a partner-managed account.
-
#create_managed_member(user_guid, managed_member_create_request_body, opts = {}) ⇒ MemberResponseBody
Create managed member Use this endpoint to create a new partner-managed ‘member`.
-
#create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Create managed member Use this endpoint to create a new partner-managed `member`.
-
#create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ TransactionResponseBody
Create managed transaction Use this endpoint to create a new partner-managed ‘transaction`.
-
#create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Create managed transaction Use this endpoint to create a new partner-managed `transaction`.
-
#create_member(user_guid, member_create_request_body, opts = {}) ⇒ MemberResponseBody
Create member This endpoint allows you to create a new member.
-
#create_member_with_http_info(user_guid, member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Create member This endpoint allows you to create a new member.
-
#create_tag(user_guid, tag_create_request_body, opts = {}) ⇒ TagResponseBody
Create tag Use this endpoint to create a new custom tag.
-
#create_tag_with_http_info(user_guid, tag_create_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Create tag Use this endpoint to create a new custom tag.
-
#create_tagging(user_guid, tagging_create_request_body, opts = {}) ⇒ TaggingResponseBody
Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.
-
#create_tagging_with_http_info(user_guid, tagging_create_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.
-
#create_transaction_rule(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ TransactionRuleResponseBody
Create transaction rule Use this endpoint to create a new transaction rule.
-
#create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Create transaction rule Use this endpoint to create a new transaction rule.
-
#create_user(user_create_request_body, opts = {}) ⇒ UserResponseBody
Create user Call this endpoint to create a new user.
-
#create_user_with_http_info(user_create_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Create user Call this endpoint to create a new user.
-
#delete_category(category_guid, user_guid, opts = {}) ⇒ nil
Delete category Use this endpoint to delete a specific custom category according to its unique GUID.
-
#delete_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete category Use this endpoint to delete a specific custom category according to its unique GUID.
-
#delete_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ nil
Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID.
-
#delete_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID.
-
#delete_managed_member(member_guid, user_guid, opts = {}) ⇒ nil
Delete managed member Use this endpoint to delete the specified partner-managed ‘member`.
-
#delete_managed_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed member Use this endpoint to delete the specified partner-managed `member`.
-
#delete_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ nil
Delete managed transaction Use this endpoint to delete the specified partner-managed ‘transaction`.
-
#delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed transaction Use this endpoint to delete the specified partner-managed `transaction`.
-
#delete_member(member_guid, user_guid, opts = {}) ⇒ nil
Delete member Accessing this endpoint will permanently delete a member.
-
#delete_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete member Accessing this endpoint will permanently delete a member.
-
#delete_tag(tag_guid, user_guid, opts = {}) ⇒ nil
Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID.
-
#delete_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID.
-
#delete_tagging(tagging_guid, user_guid, opts = {}) ⇒ nil
Delete tagging Use this endpoint to delete a tagging according to its unique GUID.
-
#delete_tagging_with_http_info(tagging_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete tagging Use this endpoint to delete a tagging according to its unique GUID.
-
#delete_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ nil
Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.
-
#delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.
-
#delete_user(user_guid, opts = {}) ⇒ nil
Delete user Use this endpoint to delete the specified ‘user`.
-
#delete_user_with_http_info(user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete user Use this endpoint to delete the specified `user`.
-
#download_statement_pdf(member_guid, statement_guid, user_guid, opts = {}) ⇒ File
Download statement pdf Use this endpoint to download a specified statement PDF.
-
#download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(File, Integer, Hash)>
Download statement pdf Use this endpoint to download a specified statement PDF.
-
#enhance_transactions(enhance_transactions_request_body, opts = {}) ⇒ EnhanceTransactionsResponseBody
Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions.
-
#enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {}) ⇒ Array<(EnhanceTransactionsResponseBody, Integer, Hash)>
Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions.
-
#extend_history(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member.
-
#extend_history_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member.
-
#fetch_statements(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Fetch statements Use this endpoint to fetch the statements associated with a particular member.
-
#fetch_statements_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Fetch statements Use this endpoint to fetch the statements associated with a particular member.
-
#identify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Identify member The identify endpoint begins an identification process for an already-existing member.
-
#identify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Identify member The identify endpoint begins an identification process for an already-existing member.
-
#initialize(api_client = ApiClient.default) ⇒ MxPlatformApi
constructor
A new instance of MxPlatformApi.
-
#list_account_numbers_by_account(account_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody
List account numbers by account This endpoint returns a list of account numbers associated with the specified ‘account`.
-
#list_account_numbers_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>
List account numbers by account This endpoint returns a list of account numbers associated with the specified `account`.
-
#list_account_numbers_by_member(member_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody
List account numbers by member This endpoint returns a list of account numbers associated with the specified ‘member`.
-
#list_account_numbers_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>
List account numbers by member This endpoint returns a list of account numbers associated with the specified `member`.
-
#list_account_owners_by_member(member_guid, user_guid, opts = {}) ⇒ AccountOwnersResponseBody
List account owners by member This endpoint returns an array with information about every account associated with a particular member.
-
#list_account_owners_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountOwnersResponseBody, Integer, Hash)>
List account owners by member This endpoint returns an array with information about every account associated with a particular member.
-
#list_categories(user_guid, opts = {}) ⇒ CategoriesResponseBody
List categories Use this endpoint to list all categories associated with a ‘user`, including both default and custom categories.
-
#list_categories_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>
List categories Use this endpoint to list all categories associated with a `user`, including both default and custom categories.
-
#list_default_categories(user_guid, opts = {}) ⇒ CategoriesResponseBody
List default categories Use this endpoint to read the attributes of a specific user.
-
#list_default_categories_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>
List default categories Use this endpoint to read the attributes of a specific user.
-
#list_favorite_institutions(opts = {}) ⇒ InstitutionsResponseBody
List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity.
-
#list_favorite_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity.
-
#list_holdings(user_guid, opts = {}) ⇒ HoldingsResponseBody
List holdings This endpoint returns all holdings associated with the specified ‘user` across all accounts and members.
-
#list_holdings_by_member(member_guid, user_guid, opts = {}) ⇒ HoldingsResponseBody
List holdings by member This endpoint returns all holdings associated with the specified ‘member` across all accounts.
-
#list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>
List holdings by member This endpoint returns all holdings associated with the specified `member` across all accounts.
-
#list_holdings_with_http_info(user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>
List holdings This endpoint returns all holdings associated with the specified `user` across all accounts and members.
-
#list_institution_credentials(institution_code, opts = {}) ⇒ CredentialsResponseBody
List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.
-
#list_institution_credentials_with_http_info(institution_code, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>
List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.
-
#list_institutions(opts = {}) ⇒ InstitutionsResponseBody
List institutions This endpoint returns a list of institutions based on the specified search term or parameter.
-
#list_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List institutions This endpoint returns a list of institutions based on the specified search term or parameter.
-
#list_managed_accounts(user_guid, member_guid, opts = {}) ⇒ AccountsResponseBody
List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
-
#list_managed_accounts_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>
List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
-
#list_managed_institutions(opts = {}) ⇒ InstitutionsResponseBody
List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.
-
#list_managed_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.
-
#list_managed_members(user_guid, opts = {}) ⇒ MembersResponseBody
List managed members This endpoint returns a list of all the partner-managed members associated with the specified ‘user`.
-
#list_managed_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>
List managed members This endpoint returns a list of all the partner-managed members associated with the specified `user`.
-
#list_managed_transactions(user_guid, member_guid, opts = {}) ⇒ TransactionsResponseBody
List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified ‘account`, scoped through a `user` and a `member`.
-
#list_managed_transactions_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
-
#list_member_challenges(member_guid, user_guid, opts = {}) ⇒ ChallengesResponseBody
List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.
-
#list_member_challenges_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(ChallengesResponseBody, Integer, Hash)>
List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.
-
#list_member_credentials(member_guid, user_guid, opts = {}) ⇒ CredentialsResponseBody
List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
-
#list_member_credentials_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>
List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
-
#list_members(user_guid, opts = {}) ⇒ MembersResponseBody
List members This endpoint returns an array which contains information on every member associated with a specific user.
-
#list_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>
List members This endpoint returns an array which contains information on every member associated with a specific user.
-
#list_merchants(opts = {}) ⇒ MerchantsResponseBody
List merchants This endpoint returns a paginated list of all the merchants in the MX system.
-
#list_merchants_with_http_info(opts = {}) ⇒ Array<(MerchantsResponseBody, Integer, Hash)>
List merchants This endpoint returns a paginated list of all the merchants in the MX system.
-
#list_statements_by_member(member_guid, user_guid, opts = {}) ⇒ StatementsResponseBody
List statements by member Use this endpoint to get an array of available statements.
-
#list_statements_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(StatementsResponseBody, Integer, Hash)>
List statements by member Use this endpoint to get an array of available statements.
-
#list_taggings(user_guid, opts = {}) ⇒ TaggingsResponseBody
List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.
-
#list_taggings_with_http_info(user_guid, opts = {}) ⇒ Array<(TaggingsResponseBody, Integer, Hash)>
List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.
-
#list_tags(user_guid, opts = {}) ⇒ TagsResponseBody
List tags Use this endpoint to list all tags associated with the specified ‘user`.
-
#list_tags_with_http_info(user_guid, opts = {}) ⇒ Array<(TagsResponseBody, Integer, Hash)>
List tags Use this endpoint to list all tags associated with the specified `user`.
-
#list_transaction_rules(user_guid, opts = {}) ⇒ TransactionRulesResponseBody
List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
-
#list_transaction_rules_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionRulesResponseBody, Integer, Hash)>
List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
-
#list_transactions(user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions Requests to this endpoint return a list of transactions associated with the specified ‘user`, accross all members and accounts associated with that `user`.
-
#list_transactions_by_account(account_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.
-
#list_transactions_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.
-
#list_transactions_by_member(member_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by member Requests to this endpoint return a list of transactions associated with the specified ‘member`, accross all accounts associated with that `member`.
-
#list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by member Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
-
#list_transactions_by_tag(tag_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID.
-
#list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID.
-
#list_transactions_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
-
#list_user_accounts(user_guid, opts = {}) ⇒ AccountsResponseBody
List accounts This endpoint returns a list of all the accounts associated with the specified ‘user`.
-
#list_user_accounts_with_http_info(user_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>
List accounts This endpoint returns a list of all the accounts associated with the specified `user`.
-
#list_users(opts = {}) ⇒ UsersResponseBody
List users Use this endpoint to list every user you’ve created in the MX Platform API.
-
#list_users_with_http_info(opts = {}) ⇒ Array<(UsersResponseBody, Integer, Hash)>
List users Use this endpoint to list every user you've created in the MX Platform API.
-
#read_account(account_guid, user_guid, opts = {}) ⇒ AccountResponseBody
Read account This endpoint returns the specified ‘account` resource.
-
#read_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Read account This endpoint returns the specified `account` resource.
-
#read_category(category_guid, user_guid, opts = {}) ⇒ CategoryResponseBody
Read category Use this endpoint to read the attributes of either a default category or a custom category.
-
#read_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Read category Use this endpoint to read the attributes of either a default category or a custom category.
-
#read_holding(holding_guid, user_guid, opts = {}) ⇒ HoldingResponseBody
Read holding Use this endpoint to read the attributes of a specific ‘holding`.
-
#read_holding_with_http_info(holding_guid, user_guid, opts = {}) ⇒ Array<(HoldingResponseBody, Integer, Hash)>
Read holding Use this endpoint to read the attributes of a specific `holding`.
-
#read_institution(institution_code, opts = {}) ⇒ InstitutionResponseBody
Read institution This endpoint returns information about the institution specified by ‘institution_code`.
-
#read_institution_with_http_info(institution_code, opts = {}) ⇒ Array<(InstitutionResponseBody, Integer, Hash)>
Read institution This endpoint returns information about the institution specified by `institution_code`.
-
#read_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ AccountResponseBody
Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
-
#read_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
-
#read_managed_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Read managed member This endpoint returns the attributes of the specified partner-managed ‘member`.
-
#read_managed_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Read managed member This endpoint returns the attributes of the specified partner-managed `member`.
-
#read_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ TransactionResponseBody
Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed ‘transaction`.
-
#read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
-
#read_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Read member Use this endpoint to read the attributes of a specific member.
-
#read_member_status(member_guid, user_guid, opts = {}) ⇒ MemberStatusResponseBody
Read member status This endpoint provides the status of the members most recent aggregation event.
-
#read_member_status_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberStatusResponseBody, Integer, Hash)>
Read member status This endpoint provides the status of the members most recent aggregation event.
-
#read_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Read member Use this endpoint to read the attributes of a specific member.
-
#read_merchant(merchant_guid, opts = {}) ⇒ MerchantResponseBody
Read merchant Returns information about a particular merchant, such as a logo, name, and website.
-
#read_merchant_location(merchant_location_guid, opts = {}) ⇒ MerchantLocationResponseBody
Read merchant location This endpoint returns the specified merchant_location resource.
-
#read_merchant_location_with_http_info(merchant_location_guid, opts = {}) ⇒ Array<(MerchantLocationResponseBody, Integer, Hash)>
Read merchant location This endpoint returns the specified merchant_location resource.
-
#read_merchant_with_http_info(merchant_guid, opts = {}) ⇒ Array<(MerchantResponseBody, Integer, Hash)>
Read merchant Returns information about a particular merchant, such as a logo, name, and website.
-
#read_statement_by_member(member_guid, statement_guid, user_guid, opts = {}) ⇒ StatementResponseBody
Read statement by member Use this endpoint to read a JSON representation of the statement.
-
#read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(StatementResponseBody, Integer, Hash)>
Read statement by member Use this endpoint to read a JSON representation of the statement.
-
#read_tag(tag_guid, user_guid, opts = {}) ⇒ TagResponseBody
Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.
-
#read_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.
-
#read_tagging(tagging_guid, user_guid, opts = {}) ⇒ TaggingResponseBody
Read tagging Use this endpoint to read the attributes of a ‘tagging` according to its unique GUID.
-
#read_tagging_with_http_info(tagging_guid, user_guid, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Read tagging Use this endpoint to read the attributes of a `tagging` according to its unique GUID.
-
#read_transaction(transaction_guid, user_guid, opts = {}) ⇒ TransactionResponseBody
Read transaction Requests to this endpoint will return the attributes of the specified ‘transaction`.
-
#read_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ TransactionRuleResponseBody
Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
-
#read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
-
#read_transaction_with_http_info(transaction_guid, user_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Read transaction Requests to this endpoint will return the attributes of the specified `transaction`.
-
#read_user(user_guid, opts = {}) ⇒ UserResponseBody
Read user Use this endpoint to read the attributes of a specific user.
-
#read_user_with_http_info(user_guid, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Read user Use this endpoint to read the attributes of a specific user.
-
#request_connect_widget_url(user_guid, opts = {}) ⇒ ConnectWidgetResponseBody
Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.
-
#request_connect_widget_url_with_http_info(user_guid, opts = {}) ⇒ Array<(ConnectWidgetResponseBody, Integer, Hash)>
Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.
-
#request_o_auth_window_uri(member_guid, user_guid, opts = {}) ⇒ OAuthWindowResponseBody
Request oauth window uri This endpoint will generate an ‘oauth_window_uri` for the specified `member`.
-
#request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(OAuthWindowResponseBody, Integer, Hash)>
Request oauth window uri This endpoint will generate an `oauth_window_uri` for the specified `member`.
-
#request_widget_url(user_guid, widget_request_body, opts = {}) ⇒ WidgetResponseBody
Request widget url This endpoint allows partners to get a URL by passing the ‘widget_type` in the request body, as well as configuring it in several different ways.
-
#request_widget_url_with_http_info(user_guid, widget_request_body, opts = {}) ⇒ Array<(WidgetResponseBody, Integer, Hash)>
Request widget url This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways.
-
#resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ MemberResponseBody
Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
-
#resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
-
#update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ AccountResponseBody
Update account by member This endpoint allows you to update certain attributes of an ‘account` resource.
-
#update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Update account by member This endpoint allows you to update certain attributes of an `account` resource.
-
#update_category(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ CategoryResponseBody
Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.
-
#update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.
-
#update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ AccountResponseBody
Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
-
#update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
-
#update_managed_member(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ MemberResponseBody
Update managed member Use this endpoint to update the attributes of the specified partner_managed ‘member`.
-
#update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Update managed member Use this endpoint to update the attributes of the specified partner_managed `member`.
-
#update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody
Update managed transaction Use this endpoint to update the attributes of the specified partner_managed ‘transaction`.
-
#update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Update managed transaction Use this endpoint to update the attributes of the specified partner_managed `transaction`.
-
#update_member(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ MemberResponseBody
Update member Use this endpoint to update a members attributes.
-
#update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Update member Use this endpoint to update a members attributes.
-
#update_tag(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ TagResponseBody
Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.
-
#update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.
-
#update_tagging(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ TaggingResponseBody
Update tagging Use this endpoint to update a tagging.
-
#update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Update tagging Use this endpoint to update a tagging.
-
#update_transaction(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody
Update transaction Use this endpoint to update the ‘description` of a specific transaction according to its unique GUID.
-
#update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ TransactionRuleResponseBody
Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID.
-
#update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID.
-
#update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Update transaction Use this endpoint to update the `description` of a specific transaction according to its unique GUID.
-
#update_user(user_guid, user_update_request_body, opts = {}) ⇒ UserResponseBody
Update user Use this endpoint to update the attributes of a specific user.
-
#update_user_with_http_info(user_guid, user_update_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Update user Use this endpoint to update the attributes of a specific user.
-
#verify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Verify member The verify endpoint begins a verification process for a member.
-
#verify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Verify member The verify endpoint begins a verification process for a member.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ MxPlatformApi
Returns a new instance of MxPlatformApi.
19 20 21 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#aggregate_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.
28 29 30 31 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 28 def aggregate_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts) data end |
#aggregate_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 39 def aggregate_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.aggregate_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.aggregate_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.aggregate_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/aggregate'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.aggregate_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#aggregate_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#check_balances(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
97 98 99 100 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 97 def check_balances(member_guid, user_guid, opts = {}) data, _status_code, _headers = check_balances_with_http_info(member_guid, user_guid, opts) data end |
#check_balances_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 108 def check_balances_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.check_balances ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.check_balances" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.check_balances" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/check_balance'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.check_balances", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#check_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_category(user_guid, category_create_request_body, opts = {}) ⇒ CategoryResponseBody
Create category Use this endpoint to create a new custom category for a specific ‘user`.
166 167 168 169 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 166 def create_category(user_guid, category_create_request_body, opts = {}) data, _status_code, _headers = create_category_with_http_info(user_guid, category_create_request_body, opts) data end |
#create_category_with_http_info(user_guid, category_create_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Create category Use this endpoint to create a new custom category for a specific `user`.
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 177 def create_category_with_http_info(user_guid, category_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_category ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_category" end # verify the required parameter 'category_create_request_body' is set if @api_client.config.client_side_validation && category_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'category_create_request_body' when calling MxPlatformApi.create_category" end # resource path local_var_path = '/users/{user_guid}/categories'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(category_create_request_body) # return_type return_type = opts[:debug_return_type] || 'CategoryResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_category", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_managed_account(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ AccountResponseBody
Create managed account Use this endpoint to create a partner-managed account.
241 242 243 244 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 241 def create_managed_account(user_guid, member_guid, managed_account_create_request_body, opts = {}) data, _status_code, _headers = create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body, opts) data end |
#create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Create managed account Use this endpoint to create a partner-managed account.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 253 def create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_account ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_managed_account" end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.create_managed_account" end # verify the required parameter 'managed_account_create_request_body' is set if @api_client.config.client_side_validation && managed_account_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_account_create_request_body' when calling MxPlatformApi.create_managed_account" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_account_create_request_body) # return_type return_type = opts[:debug_return_type] || 'AccountResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_managed_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_managed_member(user_guid, managed_member_create_request_body, opts = {}) ⇒ MemberResponseBody
Create managed member Use this endpoint to create a new partner-managed ‘member`.
320 321 322 323 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 320 def create_managed_member(user_guid, managed_member_create_request_body, opts = {}) data, _status_code, _headers = create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts) data end |
#create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Create managed member Use this endpoint to create a new partner-managed `member`.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 331 def create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_member ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_managed_member" end # verify the required parameter 'managed_member_create_request_body' is set if @api_client.config.client_side_validation && managed_member_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_member_create_request_body' when calling MxPlatformApi.create_managed_member" end # resource path local_var_path = '/users/{user_guid}/managed_members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_member_create_request_body) # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_managed_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ TransactionResponseBody
Create managed transaction Use this endpoint to create a new partner-managed ‘transaction`.
395 396 397 398 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 395 def create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) data, _status_code, _headers = create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts) data end |
#create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Create managed transaction Use this endpoint to create a new partner-managed `transaction`.
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 407 def create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_transaction ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_managed_transaction" end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.create_managed_transaction" end # verify the required parameter 'managed_transaction_create_request_body' is set if @api_client.config.client_side_validation && managed_transaction_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_transaction_create_request_body' when calling MxPlatformApi.create_managed_transaction" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_transaction_create_request_body) # return_type return_type = opts[:debug_return_type] || 'TransactionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_managed_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_member(user_guid, member_create_request_body, opts = {}) ⇒ MemberResponseBody
Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the ‘/institutions/institution_code/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
474 475 476 477 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 474 def create_member(user_guid, member_create_request_body, opts = {}) data, _status_code, _headers = create_member_with_http_info(user_guid, member_create_request_body, opts) data end |
#create_member_with_http_info(user_guid, member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/institution_code/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 485 def create_member_with_http_info(user_guid, member_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_member ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_member" end # verify the required parameter 'member_create_request_body' is set if @api_client.config.client_side_validation && member_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'member_create_request_body' when calling MxPlatformApi.create_member" end # resource path local_var_path = '/users/{user_guid}/members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(member_create_request_body) # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag(user_guid, tag_create_request_body, opts = {}) ⇒ TagResponseBody
Create tag Use this endpoint to create a new custom tag.
548 549 550 551 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 548 def create_tag(user_guid, tag_create_request_body, opts = {}) data, _status_code, _headers = create_tag_with_http_info(user_guid, tag_create_request_body, opts) data end |
#create_tag_with_http_info(user_guid, tag_create_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Create tag Use this endpoint to create a new custom tag.
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 559 def create_tag_with_http_info(user_guid, tag_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_tag ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_tag" end # verify the required parameter 'tag_create_request_body' is set if @api_client.config.client_side_validation && tag_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'tag_create_request_body' when calling MxPlatformApi.create_tag" end # resource path local_var_path = '/users/{user_guid}/tags'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_create_request_body) # return_type return_type = opts[:debug_return_type] || 'TagResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_tag", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tagging(user_guid, tagging_create_request_body, opts = {}) ⇒ TaggingResponseBody
Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.
622 623 624 625 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 622 def create_tagging(user_guid, tagging_create_request_body, opts = {}) data, _status_code, _headers = create_tagging_with_http_info(user_guid, tagging_create_request_body, opts) data end |
#create_tagging_with_http_info(user_guid, tagging_create_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 633 def create_tagging_with_http_info(user_guid, tagging_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_tagging ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_tagging" end # verify the required parameter 'tagging_create_request_body' is set if @api_client.config.client_side_validation && tagging_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'tagging_create_request_body' when calling MxPlatformApi.create_tagging" end # resource path local_var_path = '/users/{user_guid}/taggings'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(tagging_create_request_body) # return_type return_type = opts[:debug_return_type] || 'TaggingResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_tagging", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_transaction_rule(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ TransactionRuleResponseBody
Create transaction rule Use this endpoint to create a new transaction rule. The newly-created ‘transaction_rule` object will be returned if successful.
696 697 698 699 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 696 def create_transaction_rule(user_guid, transaction_rule_create_request_body, opts = {}) data, _status_code, _headers = create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts) data end |
#create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Create transaction rule Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful.
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 707 def create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_transaction_rule ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_transaction_rule" end # verify the required parameter 'transaction_rule_create_request_body' is set if @api_client.config.client_side_validation && transaction_rule_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'transaction_rule_create_request_body' when calling MxPlatformApi.create_transaction_rule" end # resource path local_var_path = '/users/{user_guid}/transaction_rules'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_rule_create_request_body) # return_type return_type = opts[:debug_return_type] || 'TransactionRuleResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_transaction_rule", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_user(user_create_request_body, opts = {}) ⇒ UserResponseBody
Create user Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
769 770 771 772 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 769 def create_user(user_create_request_body, opts = {}) data, _status_code, _headers = create_user_with_http_info(user_create_request_body, opts) data end |
#create_user_with_http_info(user_create_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Create user Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 779 def create_user_with_http_info(user_create_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_user ...' end # verify the required parameter 'user_create_request_body' is set if @api_client.config.client_side_validation && user_create_request_body.nil? fail ArgumentError, "Missing the required parameter 'user_create_request_body' when calling MxPlatformApi.create_user" end # resource path local_var_path = '/users' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_request_body) # return_type return_type = opts[:debug_return_type] || 'UserResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.create_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_category(category_guid, user_guid, opts = {}) ⇒ nil
Delete category Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of ‘204 No Content`.
838 839 840 841 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 838 def delete_category(category_guid, user_guid, opts = {}) delete_category_with_http_info(category_guid, user_guid, opts) nil end |
#delete_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete category Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`.
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 849 def delete_category_with_http_info(category_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_category ...' end # verify the required parameter 'category_guid' is set if @api_client.config.client_side_validation && category_guid.nil? fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.delete_category" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_category" end # resource path local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_category", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ nil
Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of ‘204 No Content`.
908 909 910 911 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 908 def delete_managed_account(member_guid, user_guid, account_guid, opts = {}) delete_managed_account_with_http_info(member_guid, user_guid, account_guid, opts) nil end |
#delete_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 920 def delete_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_account ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_managed_account" end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.delete_managed_account" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_managed_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_managed_member(member_guid, user_guid, opts = {}) ⇒ nil
Delete managed member Use this endpoint to delete the specified partner-managed ‘member`. The endpoint will respond with a status of `204 No Content` without a resource.
982 983 984 985 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 982 def delete_managed_member(member_guid, user_guid, opts = {}) delete_managed_member_with_http_info(member_guid, user_guid, opts) nil end |
#delete_managed_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed member Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 993 def delete_managed_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_managed_member" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_managed_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ nil
Delete managed transaction Use this endpoint to delete the specified partner-managed ‘transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
1052 1053 1054 1055 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1052 def delete_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts) nil end |
#delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete managed transaction Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1064 def delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_transaction ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_transaction" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_managed_transaction" end # verify the required parameter 'transaction_guid' is set if @api_client.config.client_side_validation && transaction_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.delete_managed_transaction" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_managed_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_member(member_guid, user_guid, opts = {}) ⇒ nil
Delete member Accessing this endpoint will permanently delete a member.
1126 1127 1128 1129 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1126 def delete_member(member_guid, user_guid, opts = {}) delete_member_with_http_info(member_guid, user_guid, opts) nil end |
#delete_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete member Accessing this endpoint will permanently delete a member.
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1137 def delete_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag(tag_guid, user_guid, opts = {}) ⇒ nil
Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of ‘204 No Content`.
1195 1196 1197 1198 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1195 def delete_tag(tag_guid, user_guid, opts = {}) delete_tag_with_http_info(tag_guid, user_guid, opts) nil end |
#delete_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1206 def delete_tag_with_http_info(tag_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_tag ...' end # verify the required parameter 'tag_guid' is set if @api_client.config.client_side_validation && tag_guid.nil? fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.delete_tag" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_tag" end # resource path local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_tag", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tagging(tagging_guid, user_guid, opts = {}) ⇒ nil
Delete tagging Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1264 1265 1266 1267 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1264 def delete_tagging(tagging_guid, user_guid, opts = {}) delete_tagging_with_http_info(tagging_guid, user_guid, opts) nil end |
#delete_tagging_with_http_info(tagging_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete tagging Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1275 def delete_tagging_with_http_info(tagging_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_tagging ...' end # verify the required parameter 'tagging_guid' is set if @api_client.config.client_side_validation && tagging_guid.nil? fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.delete_tagging" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_tagging" end # resource path local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_tagging", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ nil
Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1333 1334 1335 1336 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1333 def delete_transaction_rule(transaction_rule_guid, user_guid, opts = {}) delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts) nil end |
#delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1344 def delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_transaction_rule ...' end # verify the required parameter 'transaction_rule_guid' is set if @api_client.config.client_side_validation && transaction_rule_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.delete_transaction_rule" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_transaction_rule" end # resource path local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_transaction_rule", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_user(user_guid, opts = {}) ⇒ nil
Delete user Use this endpoint to delete the specified ‘user`. The response will have a status of `204 No Content` without an object.
1401 1402 1403 1404 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1401 def delete_user(user_guid, opts = {}) delete_user_with_http_info(user_guid, opts) nil end |
#delete_user_with_http_info(user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete user Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1411 def delete_user_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_user ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_user" end # resource path local_var_path = '/users/{user_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.delete_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#download_statement_pdf(member_guid, statement_guid, user_guid, opts = {}) ⇒ File
Download statement pdf Use this endpoint to download a specified statement PDF.
1466 1467 1468 1469 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1466 def download_statement_pdf(member_guid, statement_guid, user_guid, opts = {}) data, _status_code, _headers = download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts) data end |
#download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(File, Integer, Hash)>
Download statement pdf Use this endpoint to download a specified statement PDF.
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1478 def download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.download_statement_pdf ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.download_statement_pdf" end # verify the required parameter 'statement_guid' is set if @api_client.config.client_side_validation && statement_guid.nil? fail ArgumentError, "Missing the required parameter 'statement_guid' when calling MxPlatformApi.download_statement_pdf" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.download_statement_pdf" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'statement_guid' + '}', CGI.escape(statement_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+pdf']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'File' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.download_statement_pdf", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#download_statement_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#enhance_transactions(enhance_transactions_request_body, opts = {}) ⇒ EnhanceTransactionsResponseBody
Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
1539 1540 1541 1542 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1539 def enhance_transactions(enhance_transactions_request_body, opts = {}) data, _status_code, _headers = enhance_transactions_with_http_info(enhance_transactions_request_body, opts) data end |
#enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {}) ⇒ Array<(EnhanceTransactionsResponseBody, Integer, Hash)>
Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1549 def enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.enhance_transactions ...' end # verify the required parameter 'enhance_transactions_request_body' is set if @api_client.config.client_side_validation && enhance_transactions_request_body.nil? fail ArgumentError, "Missing the required parameter 'enhance_transactions_request_body' when calling MxPlatformApi.enhance_transactions" end # resource path local_var_path = '/transactions/enhance' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(enhance_transactions_request_body) # return_type return_type = opts[:debug_return_type] || 'EnhanceTransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.enhance_transactions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#enhance_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#extend_history(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
1608 1609 1610 1611 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1608 def extend_history(member_guid, user_guid, opts = {}) data, _status_code, _headers = extend_history_with_http_info(member_guid, user_guid, opts) data end |
#extend_history_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1619 def extend_history_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.extend_history ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.extend_history" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.extend_history" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/extend_history'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.extend_history", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#extend_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#fetch_statements(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Fetch statements Use this endpoint to fetch the statements associated with a particular member.
1677 1678 1679 1680 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1677 def fetch_statements(member_guid, user_guid, opts = {}) data, _status_code, _headers = fetch_statements_with_http_info(member_guid, user_guid, opts) data end |
#fetch_statements_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Fetch statements Use this endpoint to fetch the statements associated with a particular member.
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1688 def fetch_statements_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.fetch_statements ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.fetch_statements" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.fetch_statements" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/fetch_statements'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.fetch_statements", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#fetch_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#identify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Identify member The identify endpoint begins an identification process for an already-existing member.
1746 1747 1748 1749 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1746 def identify_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = identify_member_with_http_info(member_guid, user_guid, opts) data end |
#identify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Identify member The identify endpoint begins an identification process for an already-existing member.
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1757 def identify_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.identify_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.identify_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.identify_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/identify'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.identify_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#identify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_numbers_by_account(account_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody
List account numbers by account This endpoint returns a list of account numbers associated with the specified ‘account`.
1817 1818 1819 1820 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1817 def list_account_numbers_by_account(account_guid, user_guid, opts = {}) data, _status_code, _headers = list_account_numbers_by_account_with_http_info(account_guid, user_guid, opts) data end |
#list_account_numbers_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>
List account numbers by account This endpoint returns a list of account numbers associated with the specified `account`.
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1830 def list_account_numbers_by_account_with_http_info(account_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_numbers_by_account ...' end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.list_account_numbers_by_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_account_numbers_by_account" end # resource path local_var_path = '/users/{user_guid}/accounts/{account_guid}/account_numbers'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountNumbersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_account_numbers_by_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_account_numbers_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_numbers_by_member(member_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody
List account numbers by member This endpoint returns a list of account numbers associated with the specified ‘member`.
1892 1893 1894 1895 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1892 def list_account_numbers_by_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_account_numbers_by_member_with_http_info(member_guid, user_guid, opts) data end |
#list_account_numbers_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>
List account numbers by member This endpoint returns a list of account numbers associated with the specified `member`.
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1905 def list_account_numbers_by_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_numbers_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_account_numbers_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_account_numbers_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/account_numbers'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountNumbersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_account_numbers_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_account_numbers_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_owners_by_member(member_guid, user_guid, opts = {}) ⇒ AccountOwnersResponseBody
List account owners by member This endpoint returns an array with information about every account associated with a particular member.
1967 1968 1969 1970 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1967 def list_account_owners_by_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_account_owners_by_member_with_http_info(member_guid, user_guid, opts) data end |
#list_account_owners_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountOwnersResponseBody, Integer, Hash)>
List account owners by member This endpoint returns an array with information about every account associated with a particular member.
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1980 def list_account_owners_by_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_owners_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_account_owners_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_account_owners_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/account_owners'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountOwnersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_account_owners_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_account_owners_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_categories(user_guid, opts = {}) ⇒ CategoriesResponseBody
List categories Use this endpoint to list all categories associated with a ‘user`, including both default and custom categories.
2041 2042 2043 2044 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2041 def list_categories(user_guid, opts = {}) data, _status_code, _headers = list_categories_with_http_info(user_guid, opts) data end |
#list_categories_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>
List categories Use this endpoint to list all categories associated with a `user`, including both default and custom categories.
2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2053 def list_categories_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_categories ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_categories" end # resource path local_var_path = '/users/{user_guid}/categories'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CategoriesResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_categories", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_default_categories(user_guid, opts = {}) ⇒ CategoriesResponseBody
List default categories Use this endpoint to read the attributes of a specific user.
2110 2111 2112 2113 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2110 def list_default_categories(user_guid, opts = {}) data, _status_code, _headers = list_default_categories_with_http_info(user_guid, opts) data end |
#list_default_categories_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>
List default categories Use this endpoint to read the attributes of a specific user.
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2122 def list_default_categories_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories" end # resource path local_var_path = '/users/{user_guid}/categories/default'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CategoriesResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_default_categories", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_favorite_institutions(opts = {}) ⇒ InstitutionsResponseBody
List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
2178 2179 2180 2181 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2178 def list_favorite_institutions(opts = {}) data, _status_code, _headers = list_favorite_institutions_with_http_info(opts) data end |
#list_favorite_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2189 def list_favorite_institutions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_favorite_institutions ...' end # resource path local_var_path = '/institutions/favorites' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InstitutionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_favorite_institutions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_favorite_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_holdings(user_guid, opts = {}) ⇒ HoldingsResponseBody
List holdings This endpoint returns all holdings associated with the specified ‘user` across all accounts and members.
2244 2245 2246 2247 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2244 def list_holdings(user_guid, opts = {}) data, _status_code, _headers = list_holdings_with_http_info(user_guid, opts) data end |
#list_holdings_by_member(member_guid, user_guid, opts = {}) ⇒ HoldingsResponseBody
List holdings by member This endpoint returns all holdings associated with the specified ‘member` across all accounts.
2320 2321 2322 2323 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2320 def list_holdings_by_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_holdings_by_member_with_http_info(member_guid, user_guid, opts) data end |
#list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>
List holdings by member This endpoint returns all holdings associated with the specified `member` across all accounts.
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2335 def list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_holdings_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_holdings_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_holdings_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/holdings'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HoldingsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_holdings_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_holdings_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_holdings_with_http_info(user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>
List holdings This endpoint returns all holdings associated with the specified `user` across all accounts and members.
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2258 def list_holdings_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_holdings ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_holdings" end # resource path local_var_path = '/users/{user_guid}/holdings'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HoldingsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_holdings", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_institution_credentials(institution_code, opts = {}) ⇒ CredentialsResponseBody
List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2398 2399 2400 2401 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2398 def list_institution_credentials(institution_code, opts = {}) data, _status_code, _headers = list_institution_credentials_with_http_info(institution_code, opts) data end |
#list_institution_credentials_with_http_info(institution_code, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>
List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2410 def list_institution_credentials_with_http_info(institution_code, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_institution_credentials ...' end # verify the required parameter 'institution_code' is set if @api_client.config.client_side_validation && institution_code.nil? fail ArgumentError, "Missing the required parameter 'institution_code' when calling MxPlatformApi.list_institution_credentials" end # resource path local_var_path = '/institutions/{institution_code}/credentials'.sub('{' + 'institution_code' + '}', CGI.escape(institution_code.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CredentialsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_institution_credentials", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_institution_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_institutions(opts = {}) ⇒ InstitutionsResponseBody
List institutions This endpoint returns a list of institutions based on the specified search term or parameter.
2471 2472 2473 2474 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2471 def list_institutions(opts = {}) data, _status_code, _headers = list_institutions_with_http_info(opts) data end |
#list_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List institutions This endpoint returns a list of institutions based on the specified search term or parameter.
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2487 def list_institutions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_institutions ...' end # resource path local_var_path = '/institutions' # query parameters query_params = opts[:query_params] || {} query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil? query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil? query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil? query_params[:'supports_transaction_history'] = opts[:'supports_transaction_history'] if !opts[:'supports_transaction_history'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InstitutionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_institutions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_managed_accounts(user_guid, member_guid, opts = {}) ⇒ AccountsResponseBody
List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
2546 2547 2548 2549 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2546 def list_managed_accounts(user_guid, member_guid, opts = {}) data, _status_code, _headers = list_managed_accounts_with_http_info(user_guid, member_guid, opts) data end |
#list_managed_accounts_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>
List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2559 def list_managed_accounts_with_http_info(user_guid, member_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_accounts ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_managed_accounts" end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_managed_accounts" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_managed_accounts", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_managed_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_managed_institutions(opts = {}) ⇒ InstitutionsResponseBody
List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.
2619 2620 2621 2622 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2619 def list_managed_institutions(opts = {}) data, _status_code, _headers = list_managed_institutions_with_http_info(opts) data end |
#list_managed_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>
List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.
2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2630 def list_managed_institutions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_institutions ...' end # resource path local_var_path = '/managed_institutions' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InstitutionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_managed_institutions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_managed_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_managed_members(user_guid, opts = {}) ⇒ MembersResponseBody
List managed members This endpoint returns a list of all the partner-managed members associated with the specified ‘user`.
2683 2684 2685 2686 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2683 def list_managed_members(user_guid, opts = {}) data, _status_code, _headers = list_managed_members_with_http_info(user_guid, opts) data end |
#list_managed_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>
List managed members This endpoint returns a list of all the partner-managed members associated with the specified `user`.
2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2695 def list_managed_members_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_members ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_managed_members" end # resource path local_var_path = '/users/{user_guid}/managed_members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MembersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_managed_members", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_managed_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_managed_transactions(user_guid, member_guid, opts = {}) ⇒ TransactionsResponseBody
List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified ‘account`, scoped through a `user` and a `member`.
2753 2754 2755 2756 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2753 def list_managed_transactions(user_guid, member_guid, opts = {}) data, _status_code, _headers = list_managed_transactions_with_http_info(user_guid, member_guid, opts) data end |
#list_managed_transactions_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2766 def list_managed_transactions_with_http_info(user_guid, member_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_transactions ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_managed_transactions" end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_managed_transactions" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_managed_transactions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_managed_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_member_challenges(member_guid, user_guid, opts = {}) ⇒ ChallengesResponseBody
List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of ‘CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials.
2828 2829 2830 2831 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2828 def list_member_challenges(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_member_challenges_with_http_info(member_guid, user_guid, opts) data end |
#list_member_challenges_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(ChallengesResponseBody, Integer, Hash)>
List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials.
2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2841 def list_member_challenges_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_member_challenges ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_member_challenges" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_member_challenges" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/challenges'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ChallengesResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_member_challenges", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_member_challenges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_member_credentials(member_guid, user_guid, opts = {}) ⇒ CredentialsResponseBody
List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
2903 2904 2905 2906 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2903 def list_member_credentials(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_member_credentials_with_http_info(member_guid, user_guid, opts) data end |
#list_member_credentials_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>
List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2916 def list_member_credentials_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_member_credentials ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_member_credentials" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_member_credentials" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/credentials'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CredentialsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_member_credentials", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_member_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_members(user_guid, opts = {}) ⇒ MembersResponseBody
List members This endpoint returns an array which contains information on every member associated with a specific user.
2977 2978 2979 2980 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2977 def list_members(user_guid, opts = {}) data, _status_code, _headers = list_members_with_http_info(user_guid, opts) data end |
#list_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>
List members This endpoint returns an array which contains information on every member associated with a specific user.
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2989 def list_members_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_members ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_members" end # resource path local_var_path = '/users/{user_guid}/members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MembersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_members", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_merchants(opts = {}) ⇒ MerchantsResponseBody
List merchants This endpoint returns a paginated list of all the merchants in the MX system.
3045 3046 3047 3048 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3045 def list_merchants(opts = {}) data, _status_code, _headers = list_merchants_with_http_info(opts) data end |
#list_merchants_with_http_info(opts = {}) ⇒ Array<(MerchantsResponseBody, Integer, Hash)>
List merchants This endpoint returns a paginated list of all the merchants in the MX system.
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3056 def list_merchants_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_merchants ...' end # resource path local_var_path = '/merchants' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MerchantsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_merchants", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_merchants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_statements_by_member(member_guid, user_guid, opts = {}) ⇒ StatementsResponseBody
List statements by member Use this endpoint to get an array of available statements.
3110 3111 3112 3113 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3110 def list_statements_by_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_statements_by_member_with_http_info(member_guid, user_guid, opts) data end |
#list_statements_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(StatementsResponseBody, Integer, Hash)>
List statements by member Use this endpoint to get an array of available statements.
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3123 def list_statements_by_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_statements_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_statements_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_statements_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/statements'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'StatementsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_statements_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_statements_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_taggings(user_guid, opts = {}) ⇒ TaggingsResponseBody
List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.
3184 3185 3186 3187 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3184 def list_taggings(user_guid, opts = {}) data, _status_code, _headers = list_taggings_with_http_info(user_guid, opts) data end |
#list_taggings_with_http_info(user_guid, opts = {}) ⇒ Array<(TaggingsResponseBody, Integer, Hash)>
List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.
3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3196 def list_taggings_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_taggings ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_taggings" end # resource path local_var_path = '/users/{user_guid}/taggings'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TaggingsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_taggings", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_taggings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_tags(user_guid, opts = {}) ⇒ TagsResponseBody
List tags Use this endpoint to list all tags associated with the specified ‘user`. Each user includes the `Business` tag by default.
3253 3254 3255 3256 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3253 def (user_guid, opts = {}) data, _status_code, _headers = (user_guid, opts) data end |
#list_tags_with_http_info(user_guid, opts = {}) ⇒ Array<(TagsResponseBody, Integer, Hash)>
List tags Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3265 def (user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_tags ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_tags" end # resource path local_var_path = '/users/{user_guid}/tags'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TagsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_tags", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transaction_rules(user_guid, opts = {}) ⇒ TransactionRulesResponseBody
List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
3322 3323 3324 3325 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3322 def list_transaction_rules(user_guid, opts = {}) data, _status_code, _headers = list_transaction_rules_with_http_info(user_guid, opts) data end |
#list_transaction_rules_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionRulesResponseBody, Integer, Hash)>
List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3334 def list_transaction_rules_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transaction_rules ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_transaction_rules" end # resource path local_var_path = '/users/{user_guid}/transaction_rules'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionRulesResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_transaction_rules", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_transaction_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transactions(user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions Requests to this endpoint return a list of transactions associated with the specified ‘user`, accross all members and accounts associated with that `user`.
3393 3394 3395 3396 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3393 def list_transactions(user_guid, opts = {}) data, _status_code, _headers = list_transactions_with_http_info(user_guid, opts) data end |
#list_transactions_by_account(account_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.
3469 3470 3471 3472 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3469 def list_transactions_by_account(account_guid, user_guid, opts = {}) data, _status_code, _headers = list_transactions_by_account_with_http_info(account_guid, user_guid, opts) data end |
#list_transactions_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.
3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3484 def list_transactions_by_account_with_http_info(account_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_account ...' end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.list_transactions_by_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_transactions_by_account" end # resource path local_var_path = '/users/{user_guid}/accounts/{account_guid}/transactions'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_transactions_by_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_transactions_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transactions_by_member(member_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by member Requests to this endpoint return a list of transactions associated with the specified ‘member`, accross all accounts associated with that `member`.
3550 3551 3552 3553 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3550 def list_transactions_by_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = list_transactions_by_member_with_http_info(member_guid, user_guid, opts) data end |
#list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by member Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3565 def list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_transactions_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_transactions_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/transactions'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_transactions_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_transactions_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transactions_by_tag(tag_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody
List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.
3631 3632 3633 3634 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3631 def list_transactions_by_tag(tag_guid, user_guid, opts = {}) data, _status_code, _headers = list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts) data end |
#list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.
3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3646 def list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_tag ...' end # verify the required parameter 'tag_guid' is set if @api_client.config.client_side_validation && tag_guid.nil? fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.list_transactions_by_tag" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_transactions_by_tag" end # resource path local_var_path = '/users/{user_guid}/tags/{tag_guid}/transactions'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_transactions_by_tag", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_transactions_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transactions_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>
List transactions Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3407 def list_transactions_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_transactions" end # resource path local_var_path = '/users/{user_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_transactions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_user_accounts(user_guid, opts = {}) ⇒ AccountsResponseBody
List accounts This endpoint returns a list of all the accounts associated with the specified ‘user`.
3709 3710 3711 3712 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3709 def list_user_accounts(user_guid, opts = {}) data, _status_code, _headers = list_user_accounts_with_http_info(user_guid, opts) data end |
#list_user_accounts_with_http_info(user_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>
List accounts This endpoint returns a list of all the accounts associated with the specified `user`.
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3721 def list_user_accounts_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_user_accounts ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_user_accounts" end # resource path local_var_path = '/users/{user_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountsResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_user_accounts", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_user_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_users(opts = {}) ⇒ UsersResponseBody
List users Use this endpoint to list every user you’ve created in the MX Platform API.
3777 3778 3779 3780 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3777 def list_users(opts = {}) data, _status_code, _headers = list_users_with_http_info(opts) data end |
#list_users_with_http_info(opts = {}) ⇒ Array<(UsersResponseBody, Integer, Hash)>
List users Use this endpoint to list every user you've created in the MX Platform API.
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3788 def list_users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_users ...' end # resource path local_var_path = '/users' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'UsersResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.list_users", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_account(account_guid, user_guid, opts = {}) ⇒ AccountResponseBody
Read account This endpoint returns the specified ‘account` resource.
3840 3841 3842 3843 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3840 def read_account(account_guid, user_guid, opts = {}) data, _status_code, _headers = read_account_with_http_info(account_guid, user_guid, opts) data end |
#read_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Read account This endpoint returns the specified `account` resource.
3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3851 def read_account_with_http_info(account_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_account ...' end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.read_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_account" end # resource path local_var_path = '/users/{user_guid}/accounts/{account_guid}'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_category(category_guid, user_guid, opts = {}) ⇒ CategoryResponseBody
Read category Use this endpoint to read the attributes of either a default category or a custom category.
3909 3910 3911 3912 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3909 def read_category(category_guid, user_guid, opts = {}) data, _status_code, _headers = read_category_with_http_info(category_guid, user_guid, opts) data end |
#read_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Read category Use this endpoint to read the attributes of either a default category or a custom category.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3920 def read_category_with_http_info(category_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_category ...' end # verify the required parameter 'category_guid' is set if @api_client.config.client_side_validation && category_guid.nil? fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_category" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_category" end # resource path local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CategoryResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_category", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_holding(holding_guid, user_guid, opts = {}) ⇒ HoldingResponseBody
Read holding Use this endpoint to read the attributes of a specific ‘holding`.
3978 3979 3980 3981 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3978 def read_holding(holding_guid, user_guid, opts = {}) data, _status_code, _headers = read_holding_with_http_info(holding_guid, user_guid, opts) data end |
#read_holding_with_http_info(holding_guid, user_guid, opts = {}) ⇒ Array<(HoldingResponseBody, Integer, Hash)>
Read holding Use this endpoint to read the attributes of a specific `holding`.
3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3989 def read_holding_with_http_info(holding_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_holding ...' end # verify the required parameter 'holding_guid' is set if @api_client.config.client_side_validation && holding_guid.nil? fail ArgumentError, "Missing the required parameter 'holding_guid' when calling MxPlatformApi.read_holding" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_holding" end # resource path local_var_path = '/users/{user_guid}/holdings/{holding_guid}'.sub('{' + 'holding_guid' + '}', CGI.escape(holding_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HoldingResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_holding", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_holding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_institution(institution_code, opts = {}) ⇒ InstitutionResponseBody
Read institution This endpoint returns information about the institution specified by ‘institution_code`.
4046 4047 4048 4049 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4046 def read_institution(institution_code, opts = {}) data, _status_code, _headers = read_institution_with_http_info(institution_code, opts) data end |
#read_institution_with_http_info(institution_code, opts = {}) ⇒ Array<(InstitutionResponseBody, Integer, Hash)>
Read institution This endpoint returns information about the institution specified by `institution_code`.
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4056 def read_institution_with_http_info(institution_code, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_institution ...' end # verify the required parameter 'institution_code' is set if @api_client.config.client_side_validation && institution_code.nil? fail ArgumentError, "Missing the required parameter 'institution_code' when calling MxPlatformApi.read_institution" end # resource path local_var_path = '/institutions/{institution_code}'.sub('{' + 'institution_code' + '}', CGI.escape(institution_code.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InstitutionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_institution", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_institution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ AccountResponseBody
Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
4111 4112 4113 4114 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4111 def read_managed_account(member_guid, user_guid, account_guid, opts = {}) data, _status_code, _headers = read_managed_account_with_http_info(member_guid, user_guid, account_guid, opts) data end |
#read_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4123 def read_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_account ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_managed_account" end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.read_managed_account" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccountResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_managed_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_managed_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Read managed member This endpoint returns the attributes of the specified partner-managed ‘member`.
4185 4186 4187 4188 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4185 def read_managed_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = read_managed_member_with_http_info(member_guid, user_guid, opts) data end |
#read_managed_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Read managed member This endpoint returns the attributes of the specified partner-managed `member`.
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4196 def read_managed_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_managed_member" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_managed_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ TransactionResponseBody
Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed ‘transaction`.
4255 4256 4257 4258 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4255 def read_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) data, _status_code, _headers = read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts) data end |
#read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4267 def read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_transaction ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_transaction" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_managed_transaction" end # verify the required parameter 'transaction_guid' is set if @api_client.config.client_side_validation && transaction_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.read_managed_transaction" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_managed_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Read member Use this endpoint to read the attributes of a specific member.
4329 4330 4331 4332 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4329 def read_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = read_member_with_http_info(member_guid, user_guid, opts) data end |
#read_member_status(member_guid, user_guid, opts = {}) ⇒ MemberStatusResponseBody
Read member status This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
4398 4399 4400 4401 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4398 def read_member_status(member_guid, user_guid, opts = {}) data, _status_code, _headers = read_member_status_with_http_info(member_guid, user_guid, opts) data end |
#read_member_status_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberStatusResponseBody, Integer, Hash)>
Read member status This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4409 def read_member_status_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_member_status ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_member_status" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_member_status" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/status'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberStatusResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_member_status", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_member_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Read member Use this endpoint to read the attributes of a specific member.
4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4340 def read_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_merchant(merchant_guid, opts = {}) ⇒ MerchantResponseBody
Read merchant Returns information about a particular merchant, such as a logo, name, and website.
4466 4467 4468 4469 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4466 def read_merchant(merchant_guid, opts = {}) data, _status_code, _headers = read_merchant_with_http_info(merchant_guid, opts) data end |
#read_merchant_location(merchant_location_guid, opts = {}) ⇒ MerchantLocationResponseBody
Read merchant location This endpoint returns the specified merchant_location resource.
4529 4530 4531 4532 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4529 def read_merchant_location(merchant_location_guid, opts = {}) data, _status_code, _headers = read_merchant_location_with_http_info(merchant_location_guid, opts) data end |
#read_merchant_location_with_http_info(merchant_location_guid, opts = {}) ⇒ Array<(MerchantLocationResponseBody, Integer, Hash)>
Read merchant location This endpoint returns the specified merchant_location resource.
4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4539 def read_merchant_location_with_http_info(merchant_location_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_merchant_location ...' end # verify the required parameter 'merchant_location_guid' is set if @api_client.config.client_side_validation && merchant_location_guid.nil? fail ArgumentError, "Missing the required parameter 'merchant_location_guid' when calling MxPlatformApi.read_merchant_location" end # resource path local_var_path = '/merchant_locations/{merchant_location_guid}'.sub('{' + 'merchant_location_guid' + '}', CGI.escape(merchant_location_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MerchantLocationResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_merchant_location", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_merchant_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_merchant_with_http_info(merchant_guid, opts = {}) ⇒ Array<(MerchantResponseBody, Integer, Hash)>
Read merchant Returns information about a particular merchant, such as a logo, name, and website.
4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4476 def read_merchant_with_http_info(merchant_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_merchant ...' end # verify the required parameter 'merchant_guid' is set if @api_client.config.client_side_validation && merchant_guid.nil? fail ArgumentError, "Missing the required parameter 'merchant_guid' when calling MxPlatformApi.read_merchant" end # resource path local_var_path = '/merchants/{merchant_guid}'.sub('{' + 'merchant_guid' + '}', CGI.escape(merchant_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MerchantResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_merchant", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_statement_by_member(member_guid, statement_guid, user_guid, opts = {}) ⇒ StatementResponseBody
Read statement by member Use this endpoint to read a JSON representation of the statement.
4594 4595 4596 4597 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4594 def read_statement_by_member(member_guid, statement_guid, user_guid, opts = {}) data, _status_code, _headers = read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts) data end |
#read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(StatementResponseBody, Integer, Hash)>
Read statement by member Use this endpoint to read a JSON representation of the statement.
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4606 def read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_statement_by_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_statement_by_member" end # verify the required parameter 'statement_guid' is set if @api_client.config.client_side_validation && statement_guid.nil? fail ArgumentError, "Missing the required parameter 'statement_guid' when calling MxPlatformApi.read_statement_by_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_statement_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'statement_guid' + '}', CGI.escape(statement_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'StatementResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_statement_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_statement_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_tag(tag_guid, user_guid, opts = {}) ⇒ TagResponseBody
Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.
4668 4669 4670 4671 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4668 def read_tag(tag_guid, user_guid, opts = {}) data, _status_code, _headers = read_tag_with_http_info(tag_guid, user_guid, opts) data end |
#read_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.
4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4679 def read_tag_with_http_info(tag_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_tag ...' end # verify the required parameter 'tag_guid' is set if @api_client.config.client_side_validation && tag_guid.nil? fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.read_tag" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_tag" end # resource path local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TagResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_tag", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_tagging(tagging_guid, user_guid, opts = {}) ⇒ TaggingResponseBody
Read tagging Use this endpoint to read the attributes of a ‘tagging` according to its unique GUID.
4737 4738 4739 4740 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4737 def read_tagging(tagging_guid, user_guid, opts = {}) data, _status_code, _headers = read_tagging_with_http_info(tagging_guid, user_guid, opts) data end |
#read_tagging_with_http_info(tagging_guid, user_guid, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Read tagging Use this endpoint to read the attributes of a `tagging` according to its unique GUID.
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4748 def read_tagging_with_http_info(tagging_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_tagging ...' end # verify the required parameter 'tagging_guid' is set if @api_client.config.client_side_validation && tagging_guid.nil? fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.read_tagging" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_tagging" end # resource path local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TaggingResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_tagging", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_transaction(transaction_guid, user_guid, opts = {}) ⇒ TransactionResponseBody
Read transaction Requests to this endpoint will return the attributes of the specified ‘transaction`.
4806 4807 4808 4809 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4806 def read_transaction(transaction_guid, user_guid, opts = {}) data, _status_code, _headers = read_transaction_with_http_info(transaction_guid, user_guid, opts) data end |
#read_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ TransactionRuleResponseBody
Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
4875 4876 4877 4878 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4875 def read_transaction_rule(transaction_rule_guid, user_guid, opts = {}) data, _status_code, _headers = read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts) data end |
#read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4886 def read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_transaction_rule ...' end # verify the required parameter 'transaction_rule_guid' is set if @api_client.config.client_side_validation && transaction_rule_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.read_transaction_rule" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_transaction_rule" end # resource path local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionRuleResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_transaction_rule", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_transaction_with_http_info(transaction_guid, user_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Read transaction Requests to this endpoint will return the attributes of the specified `transaction`.
4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4817 def read_transaction_with_http_info(transaction_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_transaction ...' end # verify the required parameter 'transaction_guid' is set if @api_client.config.client_side_validation && transaction_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.read_transaction" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_transaction" end # resource path local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read_user(user_guid, opts = {}) ⇒ UserResponseBody
Read user Use this endpoint to read the attributes of a specific user.
4943 4944 4945 4946 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4943 def read_user(user_guid, opts = {}) data, _status_code, _headers = read_user_with_http_info(user_guid, opts) data end |
#read_user_with_http_info(user_guid, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Read user Use this endpoint to read the attributes of a specific user.
4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4953 def read_user_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_user ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_user" end # resource path local_var_path = '/users/{user_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'UserResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.read_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#read_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#request_connect_widget_url(user_guid, opts = {}) ⇒ ConnectWidgetResponseBody
Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.
5007 5008 5009 5010 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5007 def (user_guid, opts = {}) data, _status_code, _headers = (user_guid, opts) data end |
#request_connect_widget_url_with_http_info(user_guid, opts = {}) ⇒ Array<(ConnectWidgetResponseBody, Integer, Hash)>
Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.
5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5018 def (user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_connect_widget_url ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.request_connect_widget_url" end # resource path local_var_path = '/users/{user_guid}/connect_widget_url'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'connect_widget_request_body']) # return_type return_type = opts[:debug_return_type] || 'ConnectWidgetResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.request_connect_widget_url", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#request_connect_widget_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#request_o_auth_window_uri(member_guid, user_guid, opts = {}) ⇒ OAuthWindowResponseBody
Request oauth window uri This endpoint will generate an ‘oauth_window_uri` for the specified `member`.
5080 5081 5082 5083 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5080 def request_o_auth_window_uri(member_guid, user_guid, opts = {}) data, _status_code, _headers = request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts) data end |
#request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(OAuthWindowResponseBody, Integer, Hash)>
Request oauth window uri This endpoint will generate an `oauth_window_uri` for the specified `member`.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5094 def request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_o_auth_window_uri ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.request_o_auth_window_uri" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.request_o_auth_window_uri" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/oauth_window_uri'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'referral_source'] = opts[:'referral_source'] if !opts[:'referral_source'].nil? query_params[:'ui_message_webview_url_scheme'] = opts[:'ui_message_webview_url_scheme'] if !opts[:'ui_message_webview_url_scheme'].nil? query_params[:'skip_aggregation'] = opts[:'skip_aggregation'] if !opts[:'skip_aggregation'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OAuthWindowResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.request_o_auth_window_uri", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#request_o_auth_window_uri\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#request_widget_url(user_guid, widget_request_body, opts = {}) ⇒ WidgetResponseBody
Request widget url This endpoint allows partners to get a URL by passing the ‘widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.
5156 5157 5158 5159 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5156 def (user_guid, , opts = {}) data, _status_code, _headers = (user_guid, , opts) data end |
#request_widget_url_with_http_info(user_guid, widget_request_body, opts = {}) ⇒ Array<(WidgetResponseBody, Integer, Hash)>
Request widget url This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.
5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5168 def (user_guid, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_widget_url ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.request_widget_url" end # verify the required parameter 'widget_request_body' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'widget_request_body' when calling MxPlatformApi.request_widget_url" end # resource path local_var_path = '/users/{user_guid}/widget_urls'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body() # return_type return_type = opts[:debug_return_type] || 'WidgetResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.request_widget_url", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#request_widget_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ MemberResponseBody
Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
5233 5234 5235 5236 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5233 def resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {}) data, _status_code, _headers = resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts) data end |
#resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5245 def resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.resume_aggregation ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.resume_aggregation" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.resume_aggregation" end # verify the required parameter 'member_resume_request_body' is set if @api_client.config.client_side_validation && member_resume_request_body.nil? fail ArgumentError, "Missing the required parameter 'member_resume_request_body' when calling MxPlatformApi.resume_aggregation" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/resume'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(member_resume_request_body) # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.resume_aggregation", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#resume_aggregation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ AccountResponseBody
Update account by member This endpoint allows you to update certain attributes of an ‘account` resource.
5314 5315 5316 5317 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5314 def update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) data, _status_code, _headers = update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body, opts) data end |
#update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Update account by member This endpoint allows you to update certain attributes of an `account` resource.
5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5327 def update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_account_by_member ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_account_by_member" end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_account_by_member" end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.update_account_by_member" end # verify the required parameter 'account_update_request_body' is set if @api_client.config.client_side_validation && account_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'account_update_request_body' when calling MxPlatformApi.update_account_by_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/accounts/{account_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(account_update_request_body) # return_type return_type = opts[:debug_return_type] || 'AccountResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_account_by_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_account_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_category(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ CategoryResponseBody
Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.
5399 5400 5401 5402 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5399 def update_category(category_guid, user_guid, category_update_request_body, opts = {}) data, _status_code, _headers = update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts) data end |
#update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>
Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.
5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5411 def update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_category ...' end # verify the required parameter 'category_guid' is set if @api_client.config.client_side_validation && category_guid.nil? fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.update_category" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_category" end # verify the required parameter 'category_update_request_body' is set if @api_client.config.client_side_validation && category_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'category_update_request_body' when calling MxPlatformApi.update_category" end # resource path local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(category_update_request_body) # return_type return_type = opts[:debug_return_type] || 'CategoryResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_category", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ AccountResponseBody
Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
5480 5481 5482 5483 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5480 def update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) data, _status_code, _headers = update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body, opts) data end |
#update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>
Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5493 def update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_account ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_account" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_managed_account" end # verify the required parameter 'account_guid' is set if @api_client.config.client_side_validation && account_guid.nil? fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.update_managed_account" end # verify the required parameter 'managed_account_update_request_body' is set if @api_client.config.client_side_validation && managed_account_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_account_update_request_body' when calling MxPlatformApi.update_managed_account" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_account_update_request_body) # return_type return_type = opts[:debug_return_type] || 'AccountResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_managed_account", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_managed_member(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ MemberResponseBody
Update managed member Use this endpoint to update the attributes of the specified partner_managed ‘member`.
5565 5566 5567 5568 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5565 def update_managed_member(member_guid, user_guid, managed_member_update_request_body, opts = {}) data, _status_code, _headers = update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts) data end |
#update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Update managed member Use this endpoint to update the attributes of the specified partner_managed `member`.
5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5577 def update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_managed_member" end # verify the required parameter 'managed_member_update_request_body' is set if @api_client.config.client_side_validation && managed_member_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_member_update_request_body' when calling MxPlatformApi.update_managed_member" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_member_update_request_body) # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_managed_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody
Update managed transaction Use this endpoint to update the attributes of the specified partner_managed ‘transaction`.
5646 5647 5648 5649 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5646 def update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) data, _status_code, _headers = update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts) data end |
#update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Update managed transaction Use this endpoint to update the attributes of the specified partner_managed `transaction`.
5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5659 def update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_transaction ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_transaction" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_managed_transaction" end # verify the required parameter 'transaction_guid' is set if @api_client.config.client_side_validation && transaction_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.update_managed_transaction" end # verify the required parameter 'managed_transaction_update_request_body' is set if @api_client.config.client_side_validation && managed_transaction_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'managed_transaction_update_request_body' when calling MxPlatformApi.update_managed_transaction" end # resource path local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(managed_transaction_update_request_body) # return_type return_type = opts[:debug_return_type] || 'TransactionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_managed_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_member(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ MemberResponseBody
Update member Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.
5731 5732 5733 5734 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5731 def update_member(member_guid, user_guid, member_update_request_body, opts = {}) data, _status_code, _headers = update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts) data end |
#update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Update member Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.
5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5743 def update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_member" end # verify the required parameter 'member_update_request_body' is set if @api_client.config.client_side_validation && member_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'member_update_request_body' when calling MxPlatformApi.update_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(member_update_request_body) # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tag(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ TagResponseBody
Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.
5811 5812 5813 5814 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5811 def update_tag(tag_guid, user_guid, tag_update_request_body, opts = {}) data, _status_code, _headers = update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts) data end |
#update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>
Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.
5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5823 def update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_tag ...' end # verify the required parameter 'tag_guid' is set if @api_client.config.client_side_validation && tag_guid.nil? fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.update_tag" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_tag" end # verify the required parameter 'tag_update_request_body' is set if @api_client.config.client_side_validation && tag_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'tag_update_request_body' when calling MxPlatformApi.update_tag" end # resource path local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_update_request_body) # return_type return_type = opts[:debug_return_type] || 'TagResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_tag", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tagging(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ TaggingResponseBody
Update tagging Use this endpoint to update a tagging.
5891 5892 5893 5894 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5891 def update_tagging(tagging_guid, user_guid, tagging_update_request_body, opts = {}) data, _status_code, _headers = update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts) data end |
#update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>
Update tagging Use this endpoint to update a tagging.
5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5903 def update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_tagging ...' end # verify the required parameter 'tagging_guid' is set if @api_client.config.client_side_validation && tagging_guid.nil? fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.update_tagging" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_tagging" end # verify the required parameter 'tagging_update_request_body' is set if @api_client.config.client_side_validation && tagging_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'tagging_update_request_body' when calling MxPlatformApi.update_tagging" end # resource path local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(tagging_update_request_body) # return_type return_type = opts[:debug_return_type] || 'TaggingResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_tagging", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_transaction(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody
Update transaction Use this endpoint to update the ‘description` of a specific transaction according to its unique GUID.
5971 5972 5973 5974 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5971 def update_transaction(transaction_guid, user_guid, transaction_update_request_body, opts = {}) data, _status_code, _headers = update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts) data end |
#update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ TransactionRuleResponseBody
Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.
6051 6052 6053 6054 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6051 def update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) data, _status_code, _headers = update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts) data end |
#update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>
Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.
6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6063 def update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_transaction_rule ...' end # verify the required parameter 'transaction_rule_guid' is set if @api_client.config.client_side_validation && transaction_rule_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.update_transaction_rule" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_transaction_rule" end # verify the required parameter 'transaction_rule_update_request_body' is set if @api_client.config.client_side_validation && transaction_rule_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'transaction_rule_update_request_body' when calling MxPlatformApi.update_transaction_rule" end # resource path local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_rule_update_request_body) # return_type return_type = opts[:debug_return_type] || 'TransactionRuleResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_transaction_rule", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>
Update transaction Use this endpoint to update the `description` of a specific transaction according to its unique GUID.
5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5983 def update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_transaction ...' end # verify the required parameter 'transaction_guid' is set if @api_client.config.client_side_validation && transaction_guid.nil? fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.update_transaction" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_transaction" end # verify the required parameter 'transaction_update_request_body' is set if @api_client.config.client_side_validation && transaction_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'transaction_update_request_body' when calling MxPlatformApi.update_transaction" end # resource path local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_update_request_body) # return_type return_type = opts[:debug_return_type] || 'TransactionResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_user(user_guid, user_update_request_body, opts = {}) ⇒ UserResponseBody
Update user Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
6130 6131 6132 6133 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6130 def update_user(user_guid, user_update_request_body, opts = {}) data, _status_code, _headers = update_user_with_http_info(user_guid, user_update_request_body, opts) data end |
#update_user_with_http_info(user_guid, user_update_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>
Update user Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6141 def update_user_with_http_info(user_guid, user_update_request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_user ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_user" end # verify the required parameter 'user_update_request_body' is set if @api_client.config.client_side_validation && user_update_request_body.nil? fail ArgumentError, "Missing the required parameter 'user_update_request_body' when calling MxPlatformApi.update_user" end # resource path local_var_path = '/users/{user_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(user_update_request_body) # return_type return_type = opts[:debug_return_type] || 'UserResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.update_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#verify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody
Verify member The verify endpoint begins a verification process for a member.
6204 6205 6206 6207 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6204 def verify_member(member_guid, user_guid, opts = {}) data, _status_code, _headers = verify_member_with_http_info(member_guid, user_guid, opts) data end |
#verify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>
Verify member The verify endpoint begins a verification process for a member.
6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 |
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6215 def verify_member_with_http_info(member_guid, user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MxPlatformApi.verify_member ...' end # verify the required parameter 'member_guid' is set if @api_client.config.client_side_validation && member_guid.nil? fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.verify_member" end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.verify_member" end # resource path local_var_path = '/users/{user_guid}/members/{member_guid}/verify'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MemberResponseBody' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"MxPlatformApi.verify_member", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MxPlatformApi#verify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |