apimatic-plaid-sdk 0.0.1

data/lib/plaid/apis/asset_report_api.rb

@@ -0,0 +1,301 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportApi
+  class AssetReportApi < BaseApi
+    # Plaid can provide an Audit Copy of any Asset Report directly to a
+    # participating third party on your behalf. For example, Plaid can supply an
+    # Audit Copy directly to Fannie Mae on your behalf if you participate in the
+    # Day 1 Certainty™ program. An Audit Copy contains the same underlying data
+    # as the Asset Report.
+    # To grant access to an Audit Copy, use the
+    # `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token`
+    # and then pass that token to the third party who needs access. Each third
+    # party has its own `auditor_id`, for example `fannie_mae`. You’ll need to
+    # create a separate Audit Copy for each third party to whom you want to
+    # grant access to the Report.
+    # @param [AssetReportAuditCopyCreateRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_audit_copy_create(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/audit_copy/create',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportAuditCopyCreateResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # An Asset Report is an immutable snapshot of a user's assets. In order to
+    # "refresh" an Asset Report you created previously, you can use the
+    # `/asset_report/refresh` endpoint to create a new Asset Report based on the
+    # old one, but with the most recent data available.
+    # The new Asset Report will contain the same Items as the original Report,
+    # as well as the same filters applied by any call to `/asset_report/filter`.
+    # By default, the new Asset Report will also use the same parameters you
+    # submitted with your original `/asset_report/create` request, but the
+    # original `days_requested` value and the values of any parameters in the
+    # `options` object can be overridden with new values. To change these
+    # arguments, simply supply new values for them in your request to
+    # `/asset_report/refresh`. Submit an empty string ("") for any
+    # previously-populated fields you would like set as empty.
+    # @param [AssetReportRefreshRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_refresh(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/refresh',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportRefreshResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # By default, an Asset Report will contain all of the accounts on a given
+    # Item. In some cases, you may not want the Asset Report to contain all
+    # accounts. For example, you might have the end user choose which accounts
+    # are relevant in Link using the Account Select view, which you can enable
+    # in the dashboard. Or, you might always exclude certain account types or
+    # subtypes, which you can identify by using the `/accounts/get` endpoint. To
+    # narrow an Asset Report to only a subset of accounts, use the
+    # `/asset_report/filter` endpoint.
+    # To exclude certain Accounts from an Asset Report, first use the
+    # `/asset_report/create` endpoint to create the report, then send the
+    # `asset_report_token` along with a list of `account_ids` to exclude to the
+    # `/asset_report/filter` endpoint, to create a new Asset Report which
+    # contains only a subset of the original Asset Report's data.
+    # Because Asset Reports are immutable, calling `/asset_report/filter` does
+    # not alter the original Asset Report in any way; rather,
+    # `/asset_report/filter` creates a new Asset Report with a new token and id.
+    # Asset Reports created via `/asset_report/filter` do not contain new Asset
+    # data, and are not billed.
+    # Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks)
+    # webhook once generation of the filtered Asset Report has completed.
+    # @param [AssetReportFilterRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_filter(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/filter',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportFilterResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The `/asset_report/create` endpoint initiates the process of creating an
+    # Asset Report, which can then be retrieved by passing the
+    # `asset_report_token` return value to the `/asset_report/get` or
+    # `/asset_report/pdf/get` endpoints.
+    # The Asset Report takes some time to be created and is not available
+    # immediately after calling `/asset_report/create`. When the Asset Report is
+    # ready to be retrieved using `/asset_report/get` or
+    # `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For
+    # full details of the webhook schema, see [Asset Report
+    # webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks).
+    # The `/asset_report/create` endpoint creates an Asset Report at a moment in
+    # time. Asset Reports are immutable. To get an updated Asset Report, use the
+    # `/asset_report/refresh` endpoint.
+    # @param [AssetReportCreateRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_create(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/create',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportCreateResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The `/item/remove` endpoint allows you to invalidate an `access_token`,
+    # meaning you will not be able to create new Asset Reports with it. Removing
+    # an Item does not affect any Asset Reports or Audit Copies you have already
+    # created, which will remain accessible until you remove them specifically.
+    # The `/asset_report/remove` endpoint allows you to remove an Asset Report.
+    # Removing an Asset Report invalidates its `asset_report_token`, meaning you
+    # will no longer be able to use it to access Report data or create new Audit
+    # Copies. Removing an Asset Report does not affect the underlying Items, but
+    # does invalidate any `audit_copy_tokens` associated with the Asset Report.
+    # @param [AssetReportRemoveRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_remove(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/remove',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportRemoveResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF
+    # format. Before calling `/asset_report/pdf/get`, you must first create the
+    # Asset Report using `/asset_report/create` (or filter an Asset Report using
+    # `/asset_report/filter`) and then wait for the
+    # [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire,
+    # indicating that the Report is ready to be retrieved.
+    # The response to `/asset_report/pdf/get` is the PDF binary data. The
+    # `request_id`  is returned in the `Plaid-Request-ID` header.
+    # [View a sample PDF Asset
+    # Report](https://plaid.com/documents/sample-asset-report.pdf).
+    # @param [AssetReportPdfGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_pdf_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/pdf/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:dynamic_deserializer))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The `/asset_report/get` endpoint retrieves the Asset Report in JSON
+    # format. Before calling `/asset_report/get`, you must first create the
+    # Asset Report using `/asset_report/create` (or filter an Asset Report using
+    # `/asset_report/filter`) and then wait for the
+    # [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire,
+    # indicating that the Report is ready to be retrieved.
+    # By default, an Asset Report includes transaction descriptions as returned
+    # by the bank, as opposed to parsed and categorized by Plaid. You can also
+    # receive cleaned and categorized transactions, as well as additional
+    # insights like merchant name or location information. We call this an Asset
+    # Report with Insights. An Asset Report with Insights provides transaction
+    # category, location, and merchant information in addition to the
+    # transaction strings provided in a standard Asset Report.
+    # To retrieve an Asset Report with Insights, call the `/asset_report/get`
+    # endpoint with `include_insights` set to `true`.
+    # @param [AssetReportGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportGetResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The `/asset_report/audit_copy/remove` endpoint allows you to remove an
+    # Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token`
+    # associated with it, meaning both you and any third parties holding the
+    # token will no longer be able to use it to access Report data. Items
+    # associated with the Asset Report, the Asset Report itself and other Audit
+    # Copies of it are not affected and will remain accessible after removing
+    # the given Audit Copy.
+    # @param [AssetReportAuditCopyRemoveRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_audit_copy_remove(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/audit_copy/remove',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportAuditCopyRemoveResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset
+    # Report that was previously shared via the
+    # `/asset_report/audit_copy/create` endpoint.  The caller of
+    # `/asset_report/audit_copy/create` must provide the `audit_copy_token` to
+    # the auditor.  This token can then be used to call
+    # `/asset_report/audit_copy/create`.
+    # @param [AssetReportAuditCopyGetRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def asset_report_audit_copy_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/asset_report/audit_copy/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssetReportGetResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/plaid/apis/auth_api.rb

@@ -0,0 +1,43 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AuthApi
+  class AuthApi < BaseApi
+    # The `/auth/get` endpoint returns the bank account and bank identification
+    # numbers (such as routing numbers, for US accounts) associated with an
+    # Item's checking and savings accounts, along with high-level account data
+    # and balances when available.
+    # Note: This request may take some time to complete if `auth` was not
+    # specified as an initial product when creating the Item. This is because
+    # Plaid must communicate directly with the institution to retrieve the data.
+    # Also note that `/auth/get` will not return data for any new accounts
+    # opened after the Item was created. To obtain data for new accounts, create
+    # a new Item.
+    # @param [AuthGetRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def auth_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/auth/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuthGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default error',
+                                 ErrorErrorException))
+        .execute
+    end
+  end
+end

data/lib/plaid/apis/bank_transfer_api.rb

@@ -0,0 +1,287 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # BankTransferApi
+  class BankTransferApi < BaseApi
+    # Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer.  A
+    # transfer is eligible for cancelation if the `cancellable` property
+    # returned by `/bank_transfer/get` is `true`.
+    # @param [BankTransferCancelRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_cancel(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/cancel',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferCancelResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # The `/bank_transfer/sweep/get` endpoint fetches information about the
+    # sweep corresponding to the given `sweep_id`.
+    # @param [BankTransferSweepGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_sweep_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/sweep/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferSweepGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # Use the `/bank_transfer/list` endpoint to see a list of all your bank
+    # transfers and their statuses. Results are paginated; use the `count` and
+    # `offset` query parameters to retrieve the desired bank transfers.
+    # @param [BankTransferListRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/list',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # `/bank_transfer/event/sync` allows you to request up to the next 25 bank
+    # transfer events that happened after a specific `event_id`. Use the
+    # `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank
+    # transfer events.
+    # @param [BankTransferEventSyncRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_event_sync(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/event/sync',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferEventSyncResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # As an alternative to adding Items via Link, you can also use the
+    # `/bank_transfer/migrate_account` endpoint to migrate known account and
+    # routing numbers to Plaid Items.  Note that Items created in this way are
+    # not compatible with endpoints for other products, such as
+    # `/accounts/balance/get`, and can only be used with Bank Transfer
+    # endpoints.  If you require access to other endpoints, create the Item
+    # through Link instead.  Access to `/bank_transfer/migrate_account` is not
+    # enabled by default; to obtain access, contact your Plaid Account Manager.
+    # @param [BankTransferMigrateAccountRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_migrate_account(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/migrate_account',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferMigrateAccountResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
+    # @param [BankTransferCreateRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_create(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/create',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferCreateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # The `/bank_transfer/sweep/list` endpoint fetches information about the
+    # sweeps matching the given filters.
+    # @param [BankTransferSweepListRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_sweep_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/sweep/list',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferSweepListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # Use the `/bank_transfer/event/list` endpoint to get a list of bank
+    # transfer events based on specified filter criteria.
+    # @param [BankTransferEventListRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_event_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/event/list',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferEventListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # The `/bank_transfer/get` fetches information about the bank transfer
+    # corresponding to the given `bank_transfer_id`.
+    # @param [BankTransferGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # Use the `/bank_transfer/balance/get` endpoint to see the available balance
+    # in your bank transfer account. Debit transfers increase this balance once
+    # their status is posted. Credit transfers decrease this balance when they
+    # are created.
+    # The transactable balance shows the amount in your account that you are
+    # able to use for transfers, and is essentially your available balance minus
+    # your minimum balance.
+    # Note that this endpoint can only be used with FBO accounts, when using
+    # Bank Transfers in the Full Service configuration. It cannot be used on
+    # your own account when using Bank Transfers in the BTS Platform
+    # configuration.
+    # @param [BankTransferBalanceGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bank_transfer_balance_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/bank_transfer/balance/get',
+                                     Server::DEFAULT)
+                   .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(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BankTransferBalanceGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ErrorErrorException))
+        .execute
+    end
+  end
+end