docs/MxPlatformApi.md in mx-platform-ruby-0.2.1 vs docs/MxPlatformApi.md in mx-platform-ruby-0.3.0

- old
+ new

@@ -16,37 +16,37 @@ | [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member | | [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag | | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging | | [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule | | [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user | -| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement PDF | +| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf | | [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions | | [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history | -| [**fetch_statements_by_member**](MxPlatformApi.md#fetch_statements_by_member) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements by member | +| [**fetch_statements**](MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements | | [**identify_member**](MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member | | [**list_account_numbers_by_account**](MxPlatformApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account | | [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member | -| [**list_account_owners**](MxPlatformApi.md#list_account_owners) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners | +| [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member | | [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories | | [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories | -| [**list_favorites**](MxPlatformApi.md#list_favorites) | **GET** /institutions/favorites | List favorites | +| [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions | +| [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings | | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member | -| [**list_holdings_by_user**](MxPlatformApi.md#list_holdings_by_user) | **GET** /users/{user_guid}/holdings | List holdings by user | -| [**list_institution_required_credentials**](MxPlatformApi.md#list_institution_required_credentials) | **GET** /institutions/{institution_code}/credentials | List institution-required credentials | +| [**list_institution_credentials**](MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials | | [**list_institutions**](MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions | | [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges | | [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials | | [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members | | [**list_merchants**](MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants | | [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member | | [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings | | [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags | -| [**list_transaction_rules_by_user**](MxPlatformApi.md#list_transaction_rules_by_user) | **GET** /users/{user_guid}/transaction_rules | List transaction rules by user | +| [**list_transaction_rules**](MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules | +| [**list_transactions**](MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions | | [**list_transactions_by_account**](MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account | | [**list_transactions_by_member**](MxPlatformApi.md#list_transactions_by_member) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List transactions by member | | [**list_transactions_by_tag**](MxPlatformApi.md#list_transactions_by_tag) | **GET** /users/{user_guid}/tags/{tag_guid}/transactions | List transactions by tag | -| [**list_transactions_by_user**](MxPlatformApi.md#list_transactions_by_user) | **GET** /users/{user_guid}/transactions | List transactions by user | | [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts | | [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users | | [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account | | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category | | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding | @@ -58,15 +58,15 @@ | [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag | | [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging | | [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction | | [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule | | [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user | -| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget URL | -| [**request_o_auth_window**](MxPlatformApi.md#request_o_auth_window) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Read member | -| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request a widget URL | +| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url | +| [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri | +| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url | | [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation | -| [**update_account**](MxPlatformApi.md#update_account) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account | +| [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member | | [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category | | [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member | | [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag | | [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging | | [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction | @@ -363,11 +363,11 @@ - **Accept**: application/vnd.mx.api.v1+json ## create_tag -> <InlineResponse200> create_tag(user_guid, tag_create_request_body) +> <TagResponseBody> create_tag(user_guid, tag_create_request_body) Create tag Use this endpoint to create a new custom tag. @@ -398,19 +398,19 @@ #### Using the create_tag_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<InlineResponse200>, Integer, Hash)> create_tag_with_http_info(user_guid, tag_create_request_body) +> <Array(<TagResponseBody>, Integer, Hash)> create_tag_with_http_info(user_guid, tag_create_request_body) ```ruby begin # Create tag data, status_code, headers = api_instance.create_tag_with_http_info(user_guid, tag_create_request_body) p status_code # => 2xx p headers # => { ... } - p data # => <InlineResponse200> + p data # => <TagResponseBody> rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->create_tag_with_http_info: #{e}" end ``` @@ -421,11 +421,11 @@ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **tag_create_request_body** | [**TagCreateRequestBody**](TagCreateRequestBody.md) | Tag object to be created with required parameters (tag_guid) | | ### Return type -[**InlineResponse200**](InlineResponse200.md) +[**TagResponseBody**](TagResponseBody.md) ### Authorization [basicAuth](../README.md#basicAuth) @@ -1075,11 +1075,11 @@ ## download_statement_pdf > File download_statement_pdf(member_guid, statement_guid, user_guid) -Download statement PDF +Download statement pdf Use this endpoint to download a specified statement PDF. ### Examples @@ -1097,11 +1097,11 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for a `statement`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. begin - # Download statement PDF + # Download statement pdf result = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid) p result rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->download_statement_pdf: #{e}" end @@ -1113,11 +1113,11 @@ > <Array(File, Integer, Hash)> download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid) ```ruby begin - # Download statement PDF + # Download statement pdf data, status_code, headers = api_instance.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid) p status_code # => 2xx p headers # => { ... } p data # => File rescue MxPlatformRuby::ApiError => e @@ -1287,15 +1287,15 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## fetch_statements_by_member +## fetch_statements -> <MemberResponseBody> fetch_statements_by_member(member_guid, user_guid) +> <MemberResponseBody> fetch_statements(member_guid, user_guid) -Fetch statements by member +Fetch statements Use this endpoint to fetch the statements associated with a particular member. ### Examples @@ -1312,33 +1312,33 @@ api_instance = MxPlatformRuby::MxPlatformApi.new member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. begin - # Fetch statements by member - result = api_instance.fetch_statements_by_member(member_guid, user_guid) + # Fetch statements + result = api_instance.fetch_statements(member_guid, user_guid) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->fetch_statements_by_member: #{e}" + puts "Error when calling MxPlatformApi->fetch_statements: #{e}" end ``` -#### Using the fetch_statements_by_member_with_http_info variant +#### Using the fetch_statements_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<MemberResponseBody>, Integer, Hash)> fetch_statements_by_member_with_http_info(member_guid, user_guid) +> <Array(<MemberResponseBody>, Integer, Hash)> fetch_statements_with_http_info(member_guid, user_guid) ```ruby begin - # Fetch statements by member - data, status_code, headers = api_instance.fetch_statements_by_member_with_http_info(member_guid, user_guid) + # Fetch statements + data, status_code, headers = api_instance.fetch_statements_with_http_info(member_guid, user_guid) p status_code # => 2xx p headers # => { ... } p data # => <MemberResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->fetch_statements_by_member_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->fetch_statements_with_http_info: #{e}" end ``` ### Parameters @@ -1587,15 +1587,15 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_account_owners +## list_account_owners_by_member -> <AccountOwnersResponseBody> list_account_owners(member_guid, user_guid, opts) +> <AccountOwnersResponseBody> list_account_owners_by_member(member_guid, user_guid, opts) -List account owners +List account owners by member This endpoint returns an array with information about every account associated with a particular member. ### Examples @@ -1616,33 +1616,33 @@ page: 1, # Integer | Specify current page. records_per_page: 10 # Integer | Specify records per page. } begin - # List account owners - result = api_instance.list_account_owners(member_guid, user_guid, opts) + # List account owners by member + result = api_instance.list_account_owners_by_member(member_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_account_owners: #{e}" + puts "Error when calling MxPlatformApi->list_account_owners_by_member: #{e}" end ``` -#### Using the list_account_owners_with_http_info variant +#### Using the list_account_owners_by_member_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AccountOwnersResponseBody>, Integer, Hash)> list_account_owners_with_http_info(member_guid, user_guid, opts) +> <Array(<AccountOwnersResponseBody>, Integer, Hash)> list_account_owners_by_member_with_http_info(member_guid, user_guid, opts) ```ruby begin - # List account owners - data, status_code, headers = api_instance.list_account_owners_with_http_info(member_guid, user_guid, opts) + # List account owners by member + data, status_code, headers = api_instance.list_account_owners_by_member_with_http_info(member_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <AccountOwnersResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_account_owners_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_account_owners_by_member_with_http_info: #{e}" end ``` ### Parameters @@ -1811,15 +1811,15 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_favorites +## list_favorite_institutions -> <InstitutionsResponseBody> list_favorites(opts) +> <InstitutionsResponseBody> list_favorite_institutions(opts) -List favorites +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. ### Examples @@ -1838,33 +1838,33 @@ page: 1, # Integer | Specify current page. records_per_page: 10 # Integer | Specify records per page. } begin - # List favorites - result = api_instance.list_favorites(opts) + # List favorite institutions + result = api_instance.list_favorite_institutions(opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_favorites: #{e}" + puts "Error when calling MxPlatformApi->list_favorite_institutions: #{e}" end ``` -#### Using the list_favorites_with_http_info variant +#### Using the list_favorite_institutions_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<InstitutionsResponseBody>, Integer, Hash)> list_favorites_with_http_info(opts) +> <Array(<InstitutionsResponseBody>, Integer, Hash)> list_favorite_institutions_with_http_info(opts) ```ruby begin - # List favorites - data, status_code, headers = api_instance.list_favorites_with_http_info(opts) + # List favorite institutions + data, status_code, headers = api_instance.list_favorite_institutions_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => <InstitutionsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_favorites_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_favorite_institutions_with_http_info: #{e}" end ``` ### Parameters @@ -1885,17 +1885,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_holdings_by_member +## list_holdings -> <HoldingsResponseBody> list_holdings_by_member(member_guid, user_guid, opts) +> <HoldingsResponseBody> list_holdings(user_guid, opts) -List holdings by member +List holdings -This endpoint returns all holdings associated with the specified `member` across all accounts. +This endpoint returns all holdings associated with the specified `user` across all accounts and members. ### Examples ```ruby require 'time' @@ -1906,51 +1906,49 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new -member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. opts = { from_date: '2015-09-20', # String | Filter holdings from this date. page: 1, # Integer | Specify current page. records_per_page: 10, # Integer | Specify records per page. to_date: '2019-10-20' # String | Filter holdings to this date. } begin - # List holdings by member - result = api_instance.list_holdings_by_member(member_guid, user_guid, opts) + # List holdings + result = api_instance.list_holdings(user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_holdings_by_member: #{e}" + puts "Error when calling MxPlatformApi->list_holdings: #{e}" end ``` -#### Using the list_holdings_by_member_with_http_info variant +#### Using the list_holdings_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_member_with_http_info(member_guid, user_guid, opts) +> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_with_http_info(user_guid, opts) ```ruby begin - # List holdings by member - data, status_code, headers = api_instance.list_holdings_by_member_with_http_info(member_guid, user_guid, opts) + # List holdings + data, status_code, headers = api_instance.list_holdings_with_http_info(user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <HoldingsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_holdings_by_member_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_holdings_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **from_date** | **String** | Filter holdings from this date. | [optional] | | **page** | **Integer** | Specify current page. | [optional] | | **records_per_page** | **Integer** | Specify records per page. | [optional] | | **to_date** | **String** | Filter holdings to this date. | [optional] | @@ -1967,17 +1965,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_holdings_by_user +## list_holdings_by_member -> <HoldingsResponseBody> list_holdings_by_user(user_guid, opts) +> <HoldingsResponseBody> list_holdings_by_member(member_guid, user_guid, opts) -List holdings by user +List holdings by member -This endpoint returns all holdings associated with the specified `user` across all accounts and members. +This endpoint returns all holdings associated with the specified `member` across all accounts. ### Examples ```ruby require 'time' @@ -1988,49 +1986,51 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new +member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. opts = { from_date: '2015-09-20', # String | Filter holdings from this date. page: 1, # Integer | Specify current page. records_per_page: 10, # Integer | Specify records per page. to_date: '2019-10-20' # String | Filter holdings to this date. } begin - # List holdings by user - result = api_instance.list_holdings_by_user(user_guid, opts) + # List holdings by member + result = api_instance.list_holdings_by_member(member_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_holdings_by_user: #{e}" + puts "Error when calling MxPlatformApi->list_holdings_by_member: #{e}" end ``` -#### Using the list_holdings_by_user_with_http_info variant +#### Using the list_holdings_by_member_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_user_with_http_info(user_guid, opts) +> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_member_with_http_info(member_guid, user_guid, opts) ```ruby begin - # List holdings by user - data, status_code, headers = api_instance.list_holdings_by_user_with_http_info(user_guid, opts) + # List holdings by member + data, status_code, headers = api_instance.list_holdings_by_member_with_http_info(member_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <HoldingsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_holdings_by_user_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_holdings_by_member_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **from_date** | **String** | Filter holdings from this date. | [optional] | | **page** | **Integer** | Specify current page. | [optional] | | **records_per_page** | **Integer** | Specify records per page. | [optional] | | **to_date** | **String** | Filter holdings to this date. | [optional] | @@ -2047,15 +2047,15 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_institution_required_credentials +## list_institution_credentials -> <CredentialsResponseBody> list_institution_required_credentials(institution_code, opts) +> <CredentialsResponseBody> list_institution_credentials(institution_code, opts) -List institution-required credentials +List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution. ### Examples @@ -2075,33 +2075,33 @@ page: 1, # Integer | Specify current page. records_per_page: 10 # Integer | Specify records per page. } begin - # List institution-required credentials - result = api_instance.list_institution_required_credentials(institution_code, opts) + # List institution credentials + result = api_instance.list_institution_credentials(institution_code, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_institution_required_credentials: #{e}" + puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}" end ``` -#### Using the list_institution_required_credentials_with_http_info variant +#### Using the list_institution_credentials_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_required_credentials_with_http_info(institution_code, opts) +> <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts) ```ruby begin - # List institution-required credentials - data, status_code, headers = api_instance.list_institution_required_credentials_with_http_info(institution_code, opts) + # List institution credentials + data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts) p status_code # => 2xx p headers # => { ... } p data # => <CredentialsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_institution_required_credentials_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}" end ``` ### Parameters @@ -2739,15 +2739,15 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_transaction_rules_by_user +## list_transaction_rules -> <TransactionRulesResponseBody> list_transaction_rules_by_user(user_guid, opts) +> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts) -List transaction rules by user +List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user. ### Examples @@ -2767,33 +2767,33 @@ page: 1, # Integer | Specify current page. records_per_page: 10 # Integer | Specify records per page. } begin - # List transaction rules by user - result = api_instance.list_transaction_rules_by_user(user_guid, opts) + # List transaction rules + result = api_instance.list_transaction_rules(user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transaction_rules_by_user: #{e}" + puts "Error when calling MxPlatformApi->list_transaction_rules: #{e}" end ``` -#### Using the list_transaction_rules_by_user_with_http_info variant +#### Using the list_transaction_rules_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_by_user_with_http_info(user_guid, opts) +> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_with_http_info(user_guid, opts) ```ruby begin - # List transaction rules by user - data, status_code, headers = api_instance.list_transaction_rules_by_user_with_http_info(user_guid, opts) + # List transaction rules + data, status_code, headers = api_instance.list_transaction_rules_with_http_info(user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <TransactionRulesResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transaction_rules_by_user_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_transaction_rules_with_http_info: #{e}" end ``` ### Parameters @@ -2815,17 +2815,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_transactions_by_account +## list_transactions -> <TransactionsResponseBody> list_transactions_by_account(account_guid, user_guid, opts) +> <TransactionsResponseBody> list_transactions(user_guid, opts) -List transactions by account +List transactions -This endpoint returns a list of the last 90 days of transactions associated with the specified account. +Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. ### Examples ```ruby require 'time' @@ -2836,51 +2836,49 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new -account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. opts = { from_date: '2015-09-20', # String | Filter transactions from this date. page: 1, # Integer | Specify current page. records_per_page: 10, # Integer | Specify records per page. to_date: '2019-10-20' # String | Filter transactions to this date. } begin - # List transactions by account - result = api_instance.list_transactions_by_account(account_guid, user_guid, opts) + # List transactions + result = api_instance.list_transactions(user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_account: #{e}" + puts "Error when calling MxPlatformApi->list_transactions: #{e}" end ``` -#### Using the list_transactions_by_account_with_http_info variant +#### Using the list_transactions_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts) +> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_with_http_info(user_guid, opts) ```ruby begin - # List transactions by account - data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts) + # List transactions + data, status_code, headers = api_instance.list_transactions_with_http_info(user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <TransactionsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_account_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **from_date** | **String** | Filter transactions from this date. | [optional] | | **page** | **Integer** | Specify current page. | [optional] | | **records_per_page** | **Integer** | Specify records per page. | [optional] | | **to_date** | **String** | Filter transactions to this date. | [optional] | @@ -2897,17 +2895,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_transactions_by_member +## list_transactions_by_account -> <TransactionsResponseBody> list_transactions_by_member(member_guid, user_guid, opts) +> <TransactionsResponseBody> list_transactions_by_account(account_guid, user_guid, opts) -List transactions by member +List transactions by account -Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. +This endpoint returns a list of the last 90 days of transactions associated with the specified account. ### Examples ```ruby require 'time' @@ -2918,51 +2916,51 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new -member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. +account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. opts = { from_date: '2015-09-20', # String | Filter transactions from this date. page: 1, # Integer | Specify current page. records_per_page: 10, # Integer | Specify records per page. to_date: '2019-10-20' # String | Filter transactions to this date. } begin - # List transactions by member - result = api_instance.list_transactions_by_member(member_guid, user_guid, opts) + # List transactions by account + result = api_instance.list_transactions_by_account(account_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_member: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_account: #{e}" end ``` -#### Using the list_transactions_by_member_with_http_info variant +#### Using the list_transactions_by_account_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts) +> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts) ```ruby begin - # List transactions by member - data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts) + # List transactions by account + data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <TransactionsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_member_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_account_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | | +| **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **from_date** | **String** | Filter transactions from this date. | [optional] | | **page** | **Integer** | Specify current page. | [optional] | | **records_per_page** | **Integer** | Specify records per page. | [optional] | | **to_date** | **String** | Filter transactions to this date. | [optional] | @@ -2979,17 +2977,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_transactions_by_tag +## list_transactions_by_member -> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid) +> <TransactionsResponseBody> list_transactions_by_member(member_guid, user_guid, opts) -List transactions by tag +List transactions by member -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. +Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. ### Examples ```ruby require 'time' @@ -3000,46 +2998,56 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new -tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`. +member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. +opts = { + from_date: '2015-09-20', # String | Filter transactions from this date. + page: 1, # Integer | Specify current page. + records_per_page: 10, # Integer | Specify records per page. + to_date: '2019-10-20' # String | Filter transactions to this date. +} begin - # List transactions by tag - result = api_instance.list_transactions_by_tag(tag_guid, user_guid) + # List transactions by member + result = api_instance.list_transactions_by_member(member_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_member: #{e}" end ``` -#### Using the list_transactions_by_tag_with_http_info variant +#### Using the list_transactions_by_member_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid) +> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts) ```ruby begin - # List transactions by tag - data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid) + # List transactions by member + data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <TransactionsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_member_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | | +| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | +| **from_date** | **String** | Filter transactions from this date. | [optional] | +| **page** | **Integer** | Specify current page. | [optional] | +| **records_per_page** | **Integer** | Specify records per page. | [optional] | +| **to_date** | **String** | Filter transactions to this date. | [optional] | ### Return type [**TransactionsResponseBody**](TransactionsResponseBody.md) @@ -3051,17 +3059,17 @@ - **Content-Type**: Not defined - **Accept**: application/vnd.mx.api.v1+json -## list_transactions_by_user +## list_transactions_by_tag -> <TransactionsResponseBody> list_transactions_by_user(user_guid, opts) +> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid) -List transactions by user +List transactions by tag -Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. +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. ### Examples ```ruby require 'time' @@ -3072,54 +3080,46 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new +tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. -opts = { - from_date: '2015-09-20', # String | Filter transactions from this date. - page: 1, # Integer | Specify current page. - records_per_page: 10, # Integer | Specify records per page. - to_date: '2019-10-20' # String | Filter transactions to this date. -} begin - # List transactions by user - result = api_instance.list_transactions_by_user(user_guid, opts) + # List transactions by tag + result = api_instance.list_transactions_by_tag(tag_guid, user_guid) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_user: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}" end ``` -#### Using the list_transactions_by_user_with_http_info variant +#### Using the list_transactions_by_tag_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_user_with_http_info(user_guid, opts) +> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid) ```ruby begin - # List transactions by user - data, status_code, headers = api_instance.list_transactions_by_user_with_http_info(user_guid, opts) + # List transactions by tag + data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid) p status_code # => 2xx p headers # => { ... } p data # => <TransactionsResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->list_transactions_by_user_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | -| **from_date** | **String** | Filter transactions from this date. | [optional] | -| **page** | **Integer** | Specify current page. | [optional] | -| **records_per_page** | **Integer** | Specify records per page. | [optional] | -| **to_date** | **String** | Filter transactions to this date. | [optional] | ### Return type [**TransactionsResponseBody**](TransactionsResponseBody.md) @@ -4217,11 +4217,11 @@ ## request_connect_widget_url > <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, opts) -Request connect widget URL +Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect. ### Examples @@ -4240,11 +4240,11 @@ opts = { connect_widget_request_body: MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) } begin - # Request connect widget URL + # Request connect widget url result = api_instance.request_connect_widget_url(user_guid, opts) p result rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->request_connect_widget_url: #{e}" end @@ -4256,11 +4256,11 @@ > <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid, opts) ```ruby begin - # Request connect widget URL + # Request connect widget url data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <ConnectWidgetResponseBody> rescue MxPlatformRuby::ApiError => e @@ -4287,15 +4287,15 @@ - **Content-Type**: application/json - **Accept**: application/vnd.mx.api.v1+json -## request_o_auth_window +## request_o_auth_window_uri -> <OAuthWindowResponseBody> request_o_auth_window(member_guid, user_guid, opts) +> <OAuthWindowResponseBody> request_o_auth_window_uri(member_guid, user_guid, opts) -Read member +Request oauth window uri This endpoint will generate an `oauth_window_uri` for the specified `member`. ### Examples @@ -4316,33 +4316,33 @@ referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`. ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in. } begin - # Read member - result = api_instance.request_o_auth_window(member_guid, user_guid, opts) + # Request oauth window uri + result = api_instance.request_o_auth_window_uri(member_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->request_o_auth_window: #{e}" + puts "Error when calling MxPlatformApi->request_o_auth_window_uri: #{e}" end ``` -#### Using the request_o_auth_window_with_http_info variant +#### Using the request_o_auth_window_uri_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<OAuthWindowResponseBody>, Integer, Hash)> request_o_auth_window_with_http_info(member_guid, user_guid, opts) +> <Array(<OAuthWindowResponseBody>, Integer, Hash)> request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts) ```ruby begin - # Read member - data, status_code, headers = api_instance.request_o_auth_window_with_http_info(member_guid, user_guid, opts) + # Request oauth window uri + data, status_code, headers = api_instance.request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <OAuthWindowResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->request_o_auth_window_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->request_o_auth_window_uri_with_http_info: #{e}" end ``` ### Parameters @@ -4369,11 +4369,11 @@ ## request_widget_url > <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts) -Request a widget URL +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. ### Examples @@ -4393,11 +4393,11 @@ opts = { accept_language: 'en-US' # String | The desired language of the widget. } begin - # Request a widget URL + # Request widget url result = api_instance.request_widget_url(user_guid, widget_request_body, opts) p result rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->request_widget_url: #{e}" end @@ -4409,11 +4409,11 @@ > <Array(<WidgetResponseBody>, Integer, Hash)> request_widget_url_with_http_info(user_guid, widget_request_body, opts) ```ruby begin - # Request a widget URL + # Request widget url data, status_code, headers = api_instance.request_widget_url_with_http_info(user_guid, widget_request_body, opts) p status_code # => 2xx p headers # => { ... } p data # => <WidgetResponseBody> rescue MxPlatformRuby::ApiError => e @@ -4515,15 +4515,15 @@ - **Content-Type**: application/json - **Accept**: application/vnd.mx.api.v1+json -## update_account +## update_account_by_member -> <AccountResponseBody> update_account(user_guid, member_guid, account_guid, account_update_request_body) +> <AccountResponseBody> update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body) -Update account +Update account by member This endpoint allows you to update certain attributes of an `account` resource. ### Examples @@ -4542,33 +4542,33 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`. account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`. account_update_request_body = MxPlatformRuby::AccountUpdateRequestBody.new # AccountUpdateRequestBody | Account object to be created with optional parameters (is_hidden) begin - # Update account - result = api_instance.update_account(user_guid, member_guid, account_guid, account_update_request_body) + # Update account by member + result = api_instance.update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body) p result rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->update_account: #{e}" + puts "Error when calling MxPlatformApi->update_account_by_member: #{e}" end ``` -#### Using the update_account_with_http_info variant +#### Using the update_account_by_member_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AccountResponseBody>, Integer, Hash)> update_account_with_http_info(user_guid, member_guid, account_guid, account_update_request_body) +> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body) ```ruby begin - # Update account - data, status_code, headers = api_instance.update_account_with_http_info(user_guid, member_guid, account_guid, account_update_request_body) + # Update account by member + data, status_code, headers = api_instance.update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body) p status_code # => 2xx p headers # => { ... } p data # => <AccountResponseBody> rescue MxPlatformRuby::ApiError => e - puts "Error when calling MxPlatformApi->update_account_with_http_info: #{e}" + puts "Error when calling MxPlatformApi->update_account_by_member_with_http_info: #{e}" end ``` ### Parameters @@ -4741,11 +4741,11 @@ - **Accept**: application/vnd.mx.api.v1+json ## update_tag -> <InlineResponse200> update_tag(tag_guid, user_guid, tag_update_request_body) +> <TagResponseBody> update_tag(tag_guid, user_guid, tag_update_request_body) Update tag Use this endpoint to update the name of a specific tag according to its unique GUID. @@ -4777,19 +4777,19 @@ #### Using the update_tag_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<InlineResponse200>, Integer, Hash)> update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body) +> <Array(<TagResponseBody>, Integer, Hash)> update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body) ```ruby begin # Update tag data, status_code, headers = api_instance.update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body) p status_code # => 2xx p headers # => { ... } - p data # => <InlineResponse200> + p data # => <TagResponseBody> rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->update_tag_with_http_info: #{e}" end ``` @@ -4801,10 +4801,10 @@ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | | **tag_update_request_body** | [**TagUpdateRequestBody**](TagUpdateRequestBody.md) | Tag object to be updated with required parameter (tag_guid) | | ### Return type -[**InlineResponse200**](InlineResponse200.md) +[**TagResponseBody**](TagResponseBody.md) ### Authorization [basicAuth](../README.md#basicAuth)