apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/accounts_api.rb

@@ -0,0 +1,619 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountsApi
+  class AccountsApi < BaseApi
+    # This endpoint returns a list of all the accounts associated with the
+    # specified `user`.
+    # :::warning Account Numbers
+    # This request will not return the full account number. It may return the
+    # last four digits of the account number if that information has been
+    # provided during aggregation. If you need the full account number, please
+    # refer to [List account numbers by
+    # member](/api-reference/platform-api/reference/list-account-numbers-by-memb
+    # er/) or [List account numbers by
+    # account](/api-reference/platform-api/reference/list-account-numbers-by-acc
+    # ount/).
+    # :::
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] accept Required parameter: Specifies the media type
+    # expected in the response.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [TrueClass | FalseClass] member_is_managed_by_user Optional
+    # parameter: List only accounts whose member is managed by the user.
+    # @param [TrueClass | FalseClass] is_manual Optional parameter: List only
+    # accounts that were manually created.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @param [String] use_case Optional parameter: The use case associated with
+    # the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you
+    # can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_user_accounts(accept_version,
+                           accept,
+                           user_identifier,
+                           page: nil,
+                           member_is_managed_by_user: nil,
+                           is_manual: nil,
+                           records_per_page: nil,
+                           use_case: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(member_is_managed_by_user, key: 'member_is_managed_by_user'))
+                   .query_param(new_parameter(is_manual, key: 'is_manual'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .query_param(new_parameter(use_case, key: 'use_case'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint can only be used to create manual accounts. Creating a
+    # manual account will automatically create it under the Manual Institution
+    # member. Since a manual account has no credentials tied to the member, the
+    # account will never aggregate or include data from a data feed.
+    # :::warning
+    # You must use the user `guid` when setting `user_identifier` in the path.
+    # :::
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [AccountCreateRequestBody] body Required parameter: Manual account
+    # object to be created.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_manual_account(accept_version,
+                              user_identifier,
+                              body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns the specified `account` resource.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_guid Required parameter: The unique id for an
+    # `account`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_account(accept_version,
+                     account_guid,
+                     user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/accounts/{account_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_guid, key: 'account_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint deletes accounts that were manually created. The API will
+    # respond with an empty object and a status of `204 No Content`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_guid Required parameter: The unique id for an
+    # `account`.
+    # @param [String] accept Required parameter: Specifies the media type
+    # expected in the response.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_manual_account(accept_version,
+                              account_guid,
+                              accept,
+                              user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/users/{user_guid}/accounts/{account_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_guid, key: 'account_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns a list of account numbers associated with the
+    # specified `account`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_identifier Required parameter: Use either the
+    # account `id` you defined or the MX-defined account `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_account_numbers_by_account(accept_version,
+                                        account_identifier,
+                                        user_identifier,
+                                        page: nil,
+                                        records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/accounts/{account_identifier}/account_numbers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_identifier, key: 'account_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountNumbersResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint is used to delete existing data and block new data from
+    # being stored on the specified account. This may be necessary to comply
+    # with certain rules, regulations, or standards. This endpoint also:
+    # - Immediately and permanently deletes most data from the account object.
+    # Certain information is retained that is necessary for MX to prevent the
+    # account from being re-added.
+    # - Prevents MX from creating or storing any additional data associated with
+    # the account, for example transactions, holdings, statements, and so on.
+    # - Immediately and permanently deletes all data associated with the
+    # account, for example transactions, holdings, statements, etc.
+    # This action is scoped to the member the account belongs to. This means
+    # that if the real world account is connected or reconnected via another
+    # member, the block will have no effect on that account.
+    # This action cannot be taken on accounts where `is_manual` is `true`.
+    # Objects deleted as a result of blocking an account will issue a webhook
+    # for that object with the action set to deleted. For example, account
+    # deleted, transaction deleted, and so on. There is no special webhook or
+    # action for blocking.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_guid Required parameter: The unique id for an
+    # `account`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def block_account(accept_version,
+                      account_guid,
+                      user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/accounts/{account_guid}/block',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_guid, key: 'account_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Merge two or more financial accounts that an end user has identified as
+    # duplicates.
+    # Provide at least two account GUIDs belonging to the same user.
+    # :::danger
+    # The response will return a single consolidated account. Any other accounts
+    # you provided that were not included in the response will be deleted.
+    # This is a destructive action and can't be undone.
+    # :::
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [AccountsMergeRequestBody] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def merge_accounts(accept_version,
+                       user_guid,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/accounts/merge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all monthly account balances associated with an
+    # account GUID. Setting `from_date` returns account balances starting from
+    # the set month. Setting `to_date` returns account balances ending with the
+    # set month.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] account_guid Required parameter: The unique id for an
+    # `account`.
+    # @param [String] from_date Required parameter: Filter transactions from
+    # this date. This only supports ISO 8601 format without timestamp
+    # (YYYY-MM-DD). Defaults to 120 days ago if not provided.
+    # @param [String] to_date Required parameter: Filter transactions to this
+    # date (at midnight). This only supports ISO 8601 format without timestamp
+    # (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made
+    # to capture pending transactions.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_account_balances_by_month(accept_version,
+                                       user_guid,
+                                       account_guid,
+                                       from_date,
+                                       to_date)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/accounts/{account_guid}/monthly_account_balances',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_guid, key: 'account_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(from_date, key: 'from_date')
+                                 .is_required(true))
+                   .query_param(new_parameter(to_date, key: 'to_date')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MonthlyAccountBalancesResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns a list of account numbers associated with the
+    # specified `member`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_account_numbers_by_member(accept_version,
+                                       member_guid,
+                                       user_guid,
+                                       page: nil,
+                                       records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/account_numbers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_guid, key: 'member_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountNumbersResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns an array with information about every account
+    # associated with a particular member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_account_owners_by_member(accept_version,
+                                      member_identifier,
+                                      user_identifier,
+                                      page: nil,
+                                      records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/account_owners',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountOwnersResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns a list of all the accounts associated with the
+    # specified `member`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [TrueClass | FalseClass] member_is_managed_by_user Optional
+    # parameter: List only accounts whose member is managed by the user.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_member_accounts(accept_version,
+                             user_identifier,
+                             member_identifier,
+                             member_is_managed_by_user: nil,
+                             page: nil,
+                             records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(member_is_managed_by_user, key: 'member_is_managed_by_user'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint allows you to read the attributes of an `account` resource.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_identifier Required parameter: Use either the
+    # account `id` you defined or the MX-defined account `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_account_by_member(accept_version,
+                               account_identifier,
+                               member_identifier,
+                               user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_identifier, key: 'account_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint allows you to update certain attributes of an `account`
+    # resource, including manual accounts. For manual accounts, you can update
+    # every field listed. For aggregated accounts, you can only update
+    # `is_business`, `is_hidden` and `metadata`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_identifier Required parameter: Use either the
+    # account `id` you defined or the MX-defined account `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [AccountUpdateRequestBody] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_account_by_member(accept_version,
+                                 account_identifier,
+                                 member_identifier,
+                                 user_identifier,
+                                 body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_identifier, key: 'account_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end