@cdx-forge/di-typescript-sdk 0.1.0-beta.1

package/dist/generated/src/apis/AccountsApi.d.ts

@@ -0,0 +1,447 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { Account, Account2Inner, AccountsResponse, BankingImage, BankingImages, CustomerAccountsResponse, SearchCriteriaRequestBody, SearchResultResponse, TransactionList } from '../models/index.js';
+export interface AccountsApiGetRequest {
+    accountId: string;
+    hostUserId?: string;
+    loginId?: string;
+    viewName?: string;
+    crossAccount?: boolean;
+    institutionCustomerId?: string;
+}
+export interface AccountsApiGetAccountsRequest {
+    customerId: string;
+}
+export interface AccountsApiGetBankingImageRequest {
+    accountId: string;
+    imageType: string;
+    bankingImageId: string;
+    hostUserId?: string;
+    loginId?: string;
+    statementDate?: Date;
+    institutionCustomerId?: string;
+}
+export interface AccountsApiListRequest {
+    hostUserId?: string;
+    loginId?: string;
+    viewName?: string;
+    crossAccount?: boolean;
+    $filter?: string;
+    additionalFields?: boolean;
+    $apply?: string;
+    $skipGroups?: string;
+    $topGroups?: string;
+    institutionCustomerId?: string;
+}
+export interface AccountsApiListBankingImagesRequest {
+    accountId: string;
+    imageType: string;
+    hostUserId?: string;
+    loginId?: string;
+    transactionDate?: Date;
+    transactionImageNumber?: string;
+    statementStartDate?: Date;
+    statementEndDate?: Date;
+    statementPreview?: string;
+    institutionCustomerId?: string;
+}
+export interface AccountsApiListCustomerAccountsRequest {
+    diFicustomer: string;
+    diFiid: string;
+    userAgent?: string;
+    originatingIp?: string;
+}
+export interface AccountsApiListTransactionsRequest {
+    accountId: string;
+    hostUserId?: string;
+    loginId?: string;
+    institutionCustomerId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    retrieveFutureTransactions?: boolean;
+}
+export interface AccountsApiSearchActivitiesRequest {
+    searchCriteriaRequestBody: SearchCriteriaRequestBody;
+    acceptEncoding?: string;
+}
+/**
+ * AccountsApi - interface
+ *
+ * @export
+ * @interface AccountsApiInterface
+ */
+export interface AccountsApiInterface {
+    /**
+     * Creates request options for get without sending the request
+     * @param {string} accountId The ID of the account to retrieve.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [viewName] Filters the returned fields based on the provided view name. Can be: - &#x60;s&#x60; - Small view - &#x60;m&#x60; - Medium view
+     * @param {boolean} [crossAccount] Excludes cross user accounts from the response when false.
+     * @param {string} [institutionCustomerId] The institution customer ID that identifies the business location. Required for Business Banking users.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getRequestOpts(requestParameters: AccountsApiGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves detailed information for a specific account by its unique identifier.  **Parameters:** - Use `viewName` to control response detail level (`s` for small, `m` for medium) - Set `crossAccount=false` to exclude cross-user accounts from validation
+     * @summary Get account by ID
+     * @param {string} accountId The ID of the account to retrieve.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [viewName] Filters the returned fields based on the provided view name. Can be: - &#x60;s&#x60; - Small view - &#x60;m&#x60; - Medium view
+     * @param {boolean} [crossAccount] Excludes cross user accounts from the response when false.
+     * @param {string} [institutionCustomerId] The institution customer ID that identifies the business location. Required for Business Banking users.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getRaw(requestParameters: AccountsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Account>>;
+    /**
+     * Retrieves detailed information for a specific account by its unique identifier.  **Parameters:** - Use `viewName` to control response detail level (`s` for small, `m` for medium) - Set `crossAccount=false` to exclude cross-user accounts from validation
+     * Get account by ID
+     */
+    get(requestParameters: AccountsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Account>;
+    /**
+     * Creates request options for getAccounts without sending the request
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getAccountsRequestOpts(requestParameters: AccountsApiGetAccountsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to fetch Accounts registration information like account number, accounts status, account\'s transactions and more.
+     * @summary To fetch customer\'s accounts
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getAccountsRaw(requestParameters: AccountsApiGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Account2Inner>>>;
+    /**
+     * API to fetch Accounts registration information like account number, accounts status, account\'s transactions and more.
+     * To fetch customer\'s accounts
+     */
+    getAccounts(requestParameters: AccountsApiGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Account2Inner>>;
+    /**
+     * Creates request options for getBankingImage without sending the request
+     * @param {string} accountId The ID of the account for which images are being requested.
+     * @param {string} imageType The type of the image(s) to fetch. The possible options are CHECK, DEPOSIT_SLIP, and STATEMENT.
+     * @param {string} bankingImageId The ID of the image to be retrieved.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Date} [statementDate] The date for which statement image will be generated.
+     * @param {string} [institutionCustomerId] LocationId for the business banking user for which onlinestatements are being retrieved. This is a required parameter for BB User.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getBankingImageRequestOpts(requestParameters: AccountsApiGetBankingImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves and returns a specific scanned document image (check, deposit slip, or statement) using the image identifier obtained from the image list endpoint.  **Response Format:** - Check and deposit slip images are returned as base64-encoded TIFF data - Statement images are returned as base64-encoded PDF data - The `imageInfoItems` array contains one or more image representations  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip for record keeping - Download a statement in PDF format
+     * @summary Get banking image by ID
+     * @param {string} accountId The ID of the account for which images are being requested.
+     * @param {string} imageType The type of the image(s) to fetch. The possible options are CHECK, DEPOSIT_SLIP, and STATEMENT.
+     * @param {string} bankingImageId The ID of the image to be retrieved.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Date} [statementDate] The date for which statement image will be generated.
+     * @param {string} [institutionCustomerId] LocationId for the business banking user for which onlinestatements are being retrieved. This is a required parameter for BB User.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getBankingImageRaw(requestParameters: AccountsApiGetBankingImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImage>>;
+    /**
+     * Retrieves and returns a specific scanned document image (check, deposit slip, or statement) using the image identifier obtained from the image list endpoint.  **Response Format:** - Check and deposit slip images are returned as base64-encoded TIFF data - Statement images are returned as base64-encoded PDF data - The `imageInfoItems` array contains one or more image representations  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip for record keeping - Download a statement in PDF format
+     * Get banking image by ID
+     */
+    getBankingImage(requestParameters: AccountsApiGetBankingImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImage>;
+    /**
+     * Creates request options for list without sending the request
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [viewName] Filters the returned fields based on the provided view name. Can be: - &#x60;s&#x60; - Small view - &#x60;m&#x60; - Medium view
+     * @param {boolean} [crossAccount] Excludes cross user accounts from the response when false.
+     * @param {string} [$filter] An ODATA filter expression to apply to the returned accounts.  **Allowed fields:** - &#x60;id&#x60; - Unique account identifier - &#x60;nickName&#x60; - Customer-defined account nickname - &#x60;accountNumber&#x60; - Account number (last 4 digits) - &#x60;category&#x60; - Account category  **Category values:** DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT  **Example:** &#x60;$filter&#x3D;category eq \&#39;DEPOSIT\&#39;&#x60;
+     * @param {boolean} [additionalFields] Provides additional fields for each account when true.
+     * @param {string} [$apply] When passed along with $skipGroups and $topGroups (all three must be provided), accounts will be returned for all institution customers that the user has access to, grouped by the specified field. Currently only grouping by customer is supported. Must be: - &#x60;groupBy(customer)&#x60;
+     * @param {string} [$skipGroups] Skips the specified number of groups in the response. Must be between 0 and [total number of institution customers in the JWT] - 1
+     * @param {string} [$topGroups] Returns the top n groups in the response. Currently only a value of \&quot;1\&quot; is supported. Must be: - &#x60;1&#x60;
+     * @param {string} [institutionCustomerId] The institution customer ID that identifies the business location for which accounts should be retrieved. Required for Business Banking users to scope the request to a specific location.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listRequestOpts(requestParameters: AccountsApiListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all accounts associated with the authenticated customer. Returns account details including balances, account numbers, and status.  **Key Features:** - Returns **Cross Accounts** by default (use `crossAccount=false` to exclude) - Filter accounts by category using ODATA `$filter` expressions (DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT) - Retrieve accounts for Business Banking entities using `$apply=groupBy(customer)` with pagination - Control response detail level with `viewName` parameter (`s` for small, `m` for medium)  **Business Banking Users:** Include `institutionCustomerId` parameter for business context.  **Example Filter:** `$filter=category eq \'DEPOSIT\'` returns only deposit accounts.
+     * @summary List customer accounts
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [viewName] Filters the returned fields based on the provided view name. Can be: - &#x60;s&#x60; - Small view - &#x60;m&#x60; - Medium view
+     * @param {boolean} [crossAccount] Excludes cross user accounts from the response when false.
+     * @param {string} [$filter] An ODATA filter expression to apply to the returned accounts.  **Allowed fields:** - &#x60;id&#x60; - Unique account identifier - &#x60;nickName&#x60; - Customer-defined account nickname - &#x60;accountNumber&#x60; - Account number (last 4 digits) - &#x60;category&#x60; - Account category  **Category values:** DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT  **Example:** &#x60;$filter&#x3D;category eq \&#39;DEPOSIT\&#39;&#x60;
+     * @param {boolean} [additionalFields] Provides additional fields for each account when true.
+     * @param {string} [$apply] When passed along with $skipGroups and $topGroups (all three must be provided), accounts will be returned for all institution customers that the user has access to, grouped by the specified field. Currently only grouping by customer is supported. Must be: - &#x60;groupBy(customer)&#x60;
+     * @param {string} [$skipGroups] Skips the specified number of groups in the response. Must be between 0 and [total number of institution customers in the JWT] - 1
+     * @param {string} [$topGroups] Returns the top n groups in the response. Currently only a value of \&quot;1\&quot; is supported. Must be: - &#x60;1&#x60;
+     * @param {string} [institutionCustomerId] The institution customer ID that identifies the business location for which accounts should be retrieved. Required for Business Banking users to scope the request to a specific location.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listRaw(requestParameters: AccountsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountsResponse>>;
+    /**
+     * Retrieves all accounts associated with the authenticated customer. Returns account details including balances, account numbers, and status.  **Key Features:** - Returns **Cross Accounts** by default (use `crossAccount=false` to exclude) - Filter accounts by category using ODATA `$filter` expressions (DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT) - Retrieve accounts for Business Banking entities using `$apply=groupBy(customer)` with pagination - Control response detail level with `viewName` parameter (`s` for small, `m` for medium)  **Business Banking Users:** Include `institutionCustomerId` parameter for business context.  **Example Filter:** `$filter=category eq \'DEPOSIT\'` returns only deposit accounts.
+     * List customer accounts
+     */
+    list(requestParameters: AccountsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountsResponse>;
+    /**
+     * Creates request options for listBankingImages without sending the request
+     * @param {string} accountId The ID of the account for which images are being requested.
+     * @param {string} imageType The type of the image(s) to fetch. The possible options are CHECK, DEPOSIT_SLIP, and STATEMENT.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Date} [transactionDate] This param is only applcable for check or deposit slip images. This is the date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
+     * @param {string} [transactionImageNumber] This param is only applicable for check or deposit slip images. This is a reference number on the check (eg. check number) or the deposit slip (eg. deposit slip number). This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
+     * @param {Date} [statementStartDate] The start of the date for which statement images will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
+     * @param {Date} [statementEndDate] The end of the date for which statement images will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
+     * @param {string} [statementPreview] The param is only applicable for statement images. This supports one OLS vendor. The vendor’s host request requires a statementPreview parameter.The options are PREVIEW or CURRENT which allows an administrator to view a preview of the Statement List. From AP, an administrator can view a preview of the Statement List. Only the request originating from AP will send the preview&#x3D;true parameter.
+     * @param {string} [institutionCustomerId] LocationId for the business banking user for which onlinestatements are being retrieved. This is a required parameter for BB User.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listBankingImagesRequestOpts(requestParameters: AccountsApiListBankingImagesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a list of available scanned document images based on query parameters including account, image type, and date range. The response contains individual image IDs and metadata that can be used to retrieve, view, and print specific images.  **Image Types:** - `CHECK` - Check images (requires transactionDate and transactionImageNumber) - `DEPOSIT_SLIP` - Deposit slip images (requires transactionDate and transactionImageNumber) - `STATEMENT` - Statement images (requires statementStartDate and statementEndDate)  **Use this endpoint to:** - Build a UI component displaying available images for customers - Retrieve image metadata for transaction history displays - Get image IDs for subsequent individual image retrieval
+     * @summary List banking images
+     * @param {string} accountId The ID of the account for which images are being requested.
+     * @param {string} imageType The type of the image(s) to fetch. The possible options are CHECK, DEPOSIT_SLIP, and STATEMENT.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Date} [transactionDate] This param is only applcable for check or deposit slip images. This is the date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
+     * @param {string} [transactionImageNumber] This param is only applicable for check or deposit slip images. This is a reference number on the check (eg. check number) or the deposit slip (eg. deposit slip number). This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
+     * @param {Date} [statementStartDate] The start of the date for which statement images will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
+     * @param {Date} [statementEndDate] The end of the date for which statement images will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
+     * @param {string} [statementPreview] The param is only applicable for statement images. This supports one OLS vendor. The vendor’s host request requires a statementPreview parameter.The options are PREVIEW or CURRENT which allows an administrator to view a preview of the Statement List. From AP, an administrator can view a preview of the Statement List. Only the request originating from AP will send the preview&#x3D;true parameter.
+     * @param {string} [institutionCustomerId] LocationId for the business banking user for which onlinestatements are being retrieved. This is a required parameter for BB User.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listBankingImagesRaw(requestParameters: AccountsApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImages>>;
+    /**
+     * Returns a list of available scanned document images based on query parameters including account, image type, and date range. The response contains individual image IDs and metadata that can be used to retrieve, view, and print specific images.  **Image Types:** - `CHECK` - Check images (requires transactionDate and transactionImageNumber) - `DEPOSIT_SLIP` - Deposit slip images (requires transactionDate and transactionImageNumber) - `STATEMENT` - Statement images (requires statementStartDate and statementEndDate)  **Use this endpoint to:** - Build a UI component displaying available images for customers - Retrieve image metadata for transaction history displays - Get image IDs for subsequent individual image retrieval
+     * List banking images
+     */
+    listBankingImages(requestParameters: AccountsApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImages | null | undefined>;
+    /**
+     * Creates request options for listCustomerAccounts without sending the request
+     * @param {string} diFicustomer The digital banking user\&#39;s internal system ID (GUID)
+     * @param {string} diFiid The financial institution from which the accounts information is being requested. The scope of the OAuth token will be restricted to this Financial Institution.
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60;, e.g., &#x60;iPhone/1.0/abc12345;Nokia3110&#x60;.
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided, the IP address logged will be extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request (e.g., if a mobile device is used, the IP address should be that of the mobile device, rather than a back-end service).
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listCustomerAccountsRequestOpts(requestParameters: AccountsApiListCustomerAccountsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all accounts associated with a customer for the specified Financial Institution and Customer ID.  **Requires V1 OAuth Token**  **Note:** After OAuth token expired, the token must be refreshed or a new token requested.
+     * @summary List customer accounts (Legacy)
+     * @param {string} diFicustomer The digital banking user\&#39;s internal system ID (GUID)
+     * @param {string} diFiid The financial institution from which the accounts information is being requested. The scope of the OAuth token will be restricted to this Financial Institution.
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60;, e.g., &#x60;iPhone/1.0/abc12345;Nokia3110&#x60;.
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided, the IP address logged will be extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request (e.g., if a mobile device is used, the IP address should be that of the mobile device, rather than a back-end service).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listCustomerAccountsRaw(requestParameters: AccountsApiListCustomerAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerAccountsResponse>>;
+    /**
+     * Retrieves all accounts associated with a customer for the specified Financial Institution and Customer ID.  **Requires V1 OAuth Token**  **Note:** After OAuth token expired, the token must be refreshed or a new token requested.
+     * List customer accounts (Legacy)
+     */
+    listCustomerAccounts(requestParameters: AccountsApiListCustomerAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerAccountsResponse>;
+    /**
+     * Creates request options for listTransactions without sending the request
+     * @param {string} accountId The ID of the account for which transactions are being requested.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] The institution customer id that identifies the location for which transactions should be retrieved. Required for BB users.
+     * @param {Date} [startDate] The start of the date range for which transactions will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
+     * @param {Date} [endDate] The end of the date range for which transactions will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
+     * @param {boolean} [retrieveFutureTransactions] When true, adds an FI configurable number of days to today, and sets this date as the end date. If an end date is sent in the request, this parameter will override it.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listTransactionsRequestOpts(requestParameters: AccountsApiListTransactionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves transaction history for a specified account. Transactions include all financial  actions performed by the customer including deposits, withdrawals, transfers, and payments.  **Key Features:** - Filter by date range using startDate and endDate parameters - Retrieve pending/future transactions with retrieveFutureTransactions parameter - Business Banking support with institutionCustomerId for location-specific transactions - Returns transaction details including amounts, types, status indicators, and image identifiers  **Date Parameters:** - Dates must be in ISO 8601 format (YYYY-MM-DD) - Start date must be before or equal to end date - If no dates provided, returns transactions based on FI-configured default range  See the Transactions tag documentation for complete error codes and additional details.
+     * @summary List account transactions
+     * @param {string} accountId The ID of the account for which transactions are being requested.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] The institution customer id that identifies the location for which transactions should be retrieved. Required for BB users.
+     * @param {Date} [startDate] The start of the date range for which transactions will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
+     * @param {Date} [endDate] The end of the date range for which transactions will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
+     * @param {boolean} [retrieveFutureTransactions] When true, adds an FI configurable number of days to today, and sets this date as the end date. If an end date is sent in the request, this parameter will override it.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    listTransactionsRaw(requestParameters: AccountsApiListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionList>>;
+    /**
+     * Retrieves transaction history for a specified account. Transactions include all financial  actions performed by the customer including deposits, withdrawals, transfers, and payments.  **Key Features:** - Filter by date range using startDate and endDate parameters - Retrieve pending/future transactions with retrieveFutureTransactions parameter - Business Banking support with institutionCustomerId for location-specific transactions - Returns transaction details including amounts, types, status indicators, and image identifiers  **Date Parameters:** - Dates must be in ISO 8601 format (YYYY-MM-DD) - Start date must be before or equal to end date - If no dates provided, returns transactions based on FI-configured default range  See the Transactions tag documentation for complete error codes and additional details.
+     * List account transactions
+     */
+    listTransactions(requestParameters: AccountsApiListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionList>;
+    /**
+     * Creates request options for searchActivities without sending the request
+     * @param {SearchCriteriaRequestBody} searchCriteriaRequestBody Criterias for search
+     * @param {string} [acceptEncoding] The server supports gzip compression. It is recommended to always pass this header to get compressed response faster.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    searchActivitiesRequestOpts(requestParameters: AccountsApiSearchActivitiesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * A list of banking activity events with given criterias with reference to query next batch.
+     * @summary Returns a list of events in batch.
+     * @param {SearchCriteriaRequestBody} searchCriteriaRequestBody Criterias for search
+     * @param {string} [acceptEncoding] The server supports gzip compression. It is recommended to always pass this header to get compressed response faster.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    searchActivitiesRaw(requestParameters: AccountsApiSearchActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResultResponse>>;
+    /**
+     * A list of banking activity events with given criterias with reference to query next batch.
+     * Returns a list of events in batch.
+     */
+    searchActivities(requestParameters: AccountsApiSearchActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResultResponse | null | undefined>;
+}
+/**
+ *
+ */
+export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
+    /**
+     * Creates request options for get without sending the request
+     */
+    getRequestOpts(requestParameters: AccountsApiGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves detailed information for a specific account by its unique identifier.  **Parameters:** - Use `viewName` to control response detail level (`s` for small, `m` for medium) - Set `crossAccount=false` to exclude cross-user accounts from validation
+     * Get account by ID
+     */
+    getRaw(requestParameters: AccountsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Account>>;
+    /**
+     * Retrieves detailed information for a specific account by its unique identifier.  **Parameters:** - Use `viewName` to control response detail level (`s` for small, `m` for medium) - Set `crossAccount=false` to exclude cross-user accounts from validation
+     * Get account by ID
+     */
+    get(requestParameters: AccountsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Account>;
+    /**
+     * Creates request options for getAccounts without sending the request
+     */
+    getAccountsRequestOpts(requestParameters: AccountsApiGetAccountsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to fetch Accounts registration information like account number, accounts status, account\'s transactions and more.
+     * To fetch customer\'s accounts
+     */
+    getAccountsRaw(requestParameters: AccountsApiGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Account2Inner>>>;
+    /**
+     * API to fetch Accounts registration information like account number, accounts status, account\'s transactions and more.
+     * To fetch customer\'s accounts
+     */
+    getAccounts(requestParameters: AccountsApiGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Account2Inner>>;
+    /**
+     * Creates request options for getBankingImage without sending the request
+     */
+    getBankingImageRequestOpts(requestParameters: AccountsApiGetBankingImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves and returns a specific scanned document image (check, deposit slip, or statement) using the image identifier obtained from the image list endpoint.  **Response Format:** - Check and deposit slip images are returned as base64-encoded TIFF data - Statement images are returned as base64-encoded PDF data - The `imageInfoItems` array contains one or more image representations  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip for record keeping - Download a statement in PDF format
+     * Get banking image by ID
+     */
+    getBankingImageRaw(requestParameters: AccountsApiGetBankingImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImage>>;
+    /**
+     * Retrieves and returns a specific scanned document image (check, deposit slip, or statement) using the image identifier obtained from the image list endpoint.  **Response Format:** - Check and deposit slip images are returned as base64-encoded TIFF data - Statement images are returned as base64-encoded PDF data - The `imageInfoItems` array contains one or more image representations  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip for record keeping - Download a statement in PDF format
+     * Get banking image by ID
+     */
+    getBankingImage(requestParameters: AccountsApiGetBankingImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImage>;
+    /**
+     * Creates request options for list without sending the request
+     */
+    listRequestOpts(requestParameters: AccountsApiListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all accounts associated with the authenticated customer. Returns account details including balances, account numbers, and status.  **Key Features:** - Returns **Cross Accounts** by default (use `crossAccount=false` to exclude) - Filter accounts by category using ODATA `$filter` expressions (DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT) - Retrieve accounts for Business Banking entities using `$apply=groupBy(customer)` with pagination - Control response detail level with `viewName` parameter (`s` for small, `m` for medium)  **Business Banking Users:** Include `institutionCustomerId` parameter for business context.  **Example Filter:** `$filter=category eq \'DEPOSIT\'` returns only deposit accounts.
+     * List customer accounts
+     */
+    listRaw(requestParameters: AccountsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountsResponse>>;
+    /**
+     * Retrieves all accounts associated with the authenticated customer. Returns account details including balances, account numbers, and status.  **Key Features:** - Returns **Cross Accounts** by default (use `crossAccount=false` to exclude) - Filter accounts by category using ODATA `$filter` expressions (DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT) - Retrieve accounts for Business Banking entities using `$apply=groupBy(customer)` with pagination - Control response detail level with `viewName` parameter (`s` for small, `m` for medium)  **Business Banking Users:** Include `institutionCustomerId` parameter for business context.  **Example Filter:** `$filter=category eq \'DEPOSIT\'` returns only deposit accounts.
+     * List customer accounts
+     */
+    list(requestParameters?: AccountsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountsResponse>;
+    /**
+     * Creates request options for listBankingImages without sending the request
+     */
+    listBankingImagesRequestOpts(requestParameters: AccountsApiListBankingImagesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a list of available scanned document images based on query parameters including account, image type, and date range. The response contains individual image IDs and metadata that can be used to retrieve, view, and print specific images.  **Image Types:** - `CHECK` - Check images (requires transactionDate and transactionImageNumber) - `DEPOSIT_SLIP` - Deposit slip images (requires transactionDate and transactionImageNumber) - `STATEMENT` - Statement images (requires statementStartDate and statementEndDate)  **Use this endpoint to:** - Build a UI component displaying available images for customers - Retrieve image metadata for transaction history displays - Get image IDs for subsequent individual image retrieval
+     * List banking images
+     */
+    listBankingImagesRaw(requestParameters: AccountsApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImages>>;
+    /**
+     * Returns a list of available scanned document images based on query parameters including account, image type, and date range. The response contains individual image IDs and metadata that can be used to retrieve, view, and print specific images.  **Image Types:** - `CHECK` - Check images (requires transactionDate and transactionImageNumber) - `DEPOSIT_SLIP` - Deposit slip images (requires transactionDate and transactionImageNumber) - `STATEMENT` - Statement images (requires statementStartDate and statementEndDate)  **Use this endpoint to:** - Build a UI component displaying available images for customers - Retrieve image metadata for transaction history displays - Get image IDs for subsequent individual image retrieval
+     * List banking images
+     */
+    listBankingImages(requestParameters: AccountsApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImages | null | undefined>;
+    /**
+     * Creates request options for listCustomerAccounts without sending the request
+     */
+    listCustomerAccountsRequestOpts(requestParameters: AccountsApiListCustomerAccountsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all accounts associated with a customer for the specified Financial Institution and Customer ID.  **Requires V1 OAuth Token**  **Note:** After OAuth token expired, the token must be refreshed or a new token requested.
+     * List customer accounts (Legacy)
+     */
+    listCustomerAccountsRaw(requestParameters: AccountsApiListCustomerAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerAccountsResponse>>;
+    /**
+     * Retrieves all accounts associated with a customer for the specified Financial Institution and Customer ID.  **Requires V1 OAuth Token**  **Note:** After OAuth token expired, the token must be refreshed or a new token requested.
+     * List customer accounts (Legacy)
+     */
+    listCustomerAccounts(requestParameters: AccountsApiListCustomerAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerAccountsResponse>;
+    /**
+     * Creates request options for listTransactions without sending the request
+     */
+    listTransactionsRequestOpts(requestParameters: AccountsApiListTransactionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves transaction history for a specified account. Transactions include all financial  actions performed by the customer including deposits, withdrawals, transfers, and payments.  **Key Features:** - Filter by date range using startDate and endDate parameters - Retrieve pending/future transactions with retrieveFutureTransactions parameter - Business Banking support with institutionCustomerId for location-specific transactions - Returns transaction details including amounts, types, status indicators, and image identifiers  **Date Parameters:** - Dates must be in ISO 8601 format (YYYY-MM-DD) - Start date must be before or equal to end date - If no dates provided, returns transactions based on FI-configured default range  See the Transactions tag documentation for complete error codes and additional details.
+     * List account transactions
+     */
+    listTransactionsRaw(requestParameters: AccountsApiListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionList>>;
+    /**
+     * Retrieves transaction history for a specified account. Transactions include all financial  actions performed by the customer including deposits, withdrawals, transfers, and payments.  **Key Features:** - Filter by date range using startDate and endDate parameters - Retrieve pending/future transactions with retrieveFutureTransactions parameter - Business Banking support with institutionCustomerId for location-specific transactions - Returns transaction details including amounts, types, status indicators, and image identifiers  **Date Parameters:** - Dates must be in ISO 8601 format (YYYY-MM-DD) - Start date must be before or equal to end date - If no dates provided, returns transactions based on FI-configured default range  See the Transactions tag documentation for complete error codes and additional details.
+     * List account transactions
+     */
+    listTransactions(requestParameters: AccountsApiListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionList>;
+    /**
+     * Creates request options for searchActivities without sending the request
+     */
+    searchActivitiesRequestOpts(requestParameters: AccountsApiSearchActivitiesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * A list of banking activity events with given criterias with reference to query next batch.
+     * Returns a list of events in batch.
+     */
+    searchActivitiesRaw(requestParameters: AccountsApiSearchActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResultResponse>>;
+    /**
+     * A list of banking activity events with given criterias with reference to query next batch.
+     * Returns a list of events in batch.
+     */
+    searchActivities(requestParameters: AccountsApiSearchActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResultResponse | null | undefined>;
+}