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

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

@@ -0,0 +1,299 @@
+/**
+ * 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 { Recipient, Recipients, Transfer } from '../models/index.js';
+export interface MoneyMovementApiCreateRecipientRequest {
+    recipient: Recipient;
+    hostUserId?: string;
+    loginId?: string;
+    validate?: boolean;
+    fromAccountId?: string;
+}
+export interface MoneyMovementApiCreateTransferRequest {
+    hostUserId?: string;
+    loginId?: string;
+    transferRequest?: Transfer;
+}
+export interface MoneyMovementApiDeleteRecipientRequest {
+    recipientId: string;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface MoneyMovementApiGetRecipientRequest {
+    recipientId: string;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface MoneyMovementApiListRecipientsRequest {
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface MoneyMovementApiUpdateRecipientRequest {
+    recipientId: string;
+    recipient: Recipient;
+    hostUserId?: string;
+    loginId?: string;
+    fromAccountId?: string;
+}
+/**
+ * MoneyMovementApi - interface
+ *
+ * @export
+ * @interface MoneyMovementApiInterface
+ */
+export interface MoneyMovementApiInterface {
+    /**
+     * Creates request options for createRecipient without sending the request
+     * @param {Recipient} recipient Information needed for creating a new recipient record
+     * @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 {boolean} [validate] When true, validates that the recipient exists at the institution before saving. Recommended to prevent transfers to invalid accounts.
+     * @param {string} [fromAccountId] The account ID of the sender. Required when validate&#x3D;true to perform the validation transfer test.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    createRecipientRequestOpts(requestParameters: MoneyMovementApiCreateRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * @summary Create recipient
+     * @param {Recipient} recipient Information needed for creating a new recipient record
+     * @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 {boolean} [validate] When true, validates that the recipient exists at the institution before saving. Recommended to prevent transfers to invalid accounts.
+     * @param {string} [fromAccountId] The account ID of the sender. Required when validate&#x3D;true to perform the validation transfer test.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    createRecipientRaw(requestParameters: MoneyMovementApiCreateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * Create recipient
+     */
+    createRecipient(requestParameters: MoneyMovementApiCreateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for createTransfer 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 {Transfer} [transferRequest] The transfer request object containing source account, destination account, amount,  and optional scheduling information.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    createTransferRequestOpts(requestParameters: MoneyMovementApiCreateTransferRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * @summary Create transfer
+     * @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 {Transfer} [transferRequest] The transfer request object containing source account, destination account, amount,  and optional scheduling information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    createTransferRaw(requestParameters: MoneyMovementApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Transfer>>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create transfer
+     */
+    createTransfer(requestParameters: MoneyMovementApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Transfer>;
+    /**
+     * Creates request options for deleteRecipient without sending the request
+     * @param {string} recipientId The unique identifier of the recipient to delete.
+     * @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.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    deleteRecipientRequestOpts(requestParameters: MoneyMovementApiDeleteRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * @summary Delete recipient
+     * @param {string} recipientId The unique identifier of the recipient to delete.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    deleteRecipientRaw(requestParameters: MoneyMovementApiDeleteRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * Delete recipient
+     */
+    deleteRecipient(requestParameters: MoneyMovementApiDeleteRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for getRecipient without sending the request
+     * @param {string} recipientId The unique identifier of the recipient to retrieve. This ID is returned when creating a recipient.
+     * @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.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    getRecipientRequestOpts(requestParameters: MoneyMovementApiGetRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * @summary Get recipient by ID
+     * @param {string} recipientId The unique identifier of the recipient to retrieve. This ID is returned when creating a recipient.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    getRecipientRaw(requestParameters: MoneyMovementApiGetRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * Get recipient by ID
+     */
+    getRecipient(requestParameters: MoneyMovementApiGetRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for listRecipients 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.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    listRecipientsRequestOpts(requestParameters: MoneyMovementApiListRecipientsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * @summary List recipients
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    listRecipientsRaw(requestParameters: MoneyMovementApiListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * List recipients
+     */
+    listRecipients(requestParameters: MoneyMovementApiListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for updateRecipient without sending the request
+     * @param {string} recipientId The unique identifier of the recipient to update.
+     * @param {Recipient} recipient Information needed for creating a new recipient record
+     * @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} [fromAccountId] The account ID of the sender. Required if re-validating the updated recipient.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    updateRecipientRequestOpts(requestParameters: MoneyMovementApiUpdateRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * @summary Update recipient
+     * @param {string} recipientId The unique identifier of the recipient to update.
+     * @param {Recipient} recipient Information needed for creating a new recipient record
+     * @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} [fromAccountId] The account ID of the sender. Required if re-validating the updated recipient.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MoneyMovementApiInterface
+     */
+    updateRecipientRaw(requestParameters: MoneyMovementApiUpdateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * Update recipient
+     */
+    updateRecipient(requestParameters: MoneyMovementApiUpdateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+}
+/**
+ *
+ */
+export declare class MoneyMovementApi extends runtime.BaseAPI implements MoneyMovementApiInterface {
+    /**
+     * Creates request options for createRecipient without sending the request
+     */
+    createRecipientRequestOpts(requestParameters: MoneyMovementApiCreateRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * Create recipient
+     */
+    createRecipientRaw(requestParameters: MoneyMovementApiCreateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * Create recipient
+     */
+    createRecipient(requestParameters: MoneyMovementApiCreateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for createTransfer without sending the request
+     */
+    createTransferRequestOpts(requestParameters: MoneyMovementApiCreateTransferRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create transfer
+     */
+    createTransferRaw(requestParameters: MoneyMovementApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Transfer>>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create transfer
+     */
+    createTransfer(requestParameters?: MoneyMovementApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Transfer>;
+    /**
+     * Creates request options for deleteRecipient without sending the request
+     */
+    deleteRecipientRequestOpts(requestParameters: MoneyMovementApiDeleteRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * Delete recipient
+     */
+    deleteRecipientRaw(requestParameters: MoneyMovementApiDeleteRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * Delete recipient
+     */
+    deleteRecipient(requestParameters: MoneyMovementApiDeleteRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for getRecipient without sending the request
+     */
+    getRecipientRequestOpts(requestParameters: MoneyMovementApiGetRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * Get recipient by ID
+     */
+    getRecipientRaw(requestParameters: MoneyMovementApiGetRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * Get recipient by ID
+     */
+    getRecipient(requestParameters: MoneyMovementApiGetRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for listRecipients without sending the request
+     */
+    listRecipientsRequestOpts(requestParameters: MoneyMovementApiListRecipientsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * List recipients
+     */
+    listRecipientsRaw(requestParameters: MoneyMovementApiListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * List recipients
+     */
+    listRecipients(requestParameters?: MoneyMovementApiListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+    /**
+     * Creates request options for updateRecipient without sending the request
+     */
+    updateRecipientRequestOpts(requestParameters: MoneyMovementApiUpdateRecipientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * Update recipient
+     */
+    updateRecipientRaw(requestParameters: MoneyMovementApiUpdateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recipients>>;
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * Update recipient
+     */
+    updateRecipient(requestParameters: MoneyMovementApiUpdateRecipientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recipients>;
+}

package/dist/generated/src/apis/MoneyMovementApi.js

@@ -0,0 +1,317 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { RecipientToJSON, RecipientsFromJSON, TransferFromJSON, TransferToJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class MoneyMovementApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createRecipient without sending the request
+     */
+    async createRecipientRequestOpts(requestParameters) {
+        if (requestParameters['recipient'] == null) {
+            throw new runtime.RequiredError('recipient', 'Required parameter "recipient" was null or undefined when calling createRecipient().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['validate'] != null) {
+            queryParameters['validate'] = requestParameters['validate'];
+        }
+        if (requestParameters['fromAccountId'] != null) {
+            queryParameters['fromAccountId'] = requestParameters['fromAccountId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-recipients/v1/recipients`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RecipientToJSON(requestParameters['recipient']),
+        };
+    }
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * Create recipient
+     */
+    async createRecipientRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createRecipientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecipientsFromJSON(jsonValue));
+    }
+    /**
+     * Creates a new recipient record and optionally validates the provided information. Use this  endpoint to add new payees that can receive transfers.  **Validation:** Set `validate=true` query parameter to validate the recipient exists at the institution  before saving. This performs a \"lucky transfer\" test to verify the account.
+     * Create recipient
+     */
+    async createRecipient(requestParameters, initOverrides) {
+        const response = await this.createRecipientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createTransfer without sending the request
+     */
+    async createTransferRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-transfers/v1/transfers`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TransferToJSON(requestParameters['transferRequest']),
+        };
+    }
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create transfer
+     */
+    async createTransferRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createTransferRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => TransferFromJSON(jsonValue));
+    }
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create transfer
+     */
+    async createTransfer(requestParameters = {}, initOverrides) {
+        const response = await this.createTransferRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for deleteRecipient without sending the request
+     */
+    async deleteRecipientRequestOpts(requestParameters) {
+        if (requestParameters['recipientId'] == null) {
+            throw new runtime.RequiredError('recipientId', 'Required parameter "recipientId" was null or undefined when calling deleteRecipient().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-recipients/v1/recipients/{recipientId}`;
+        urlPath = urlPath.replace(`{${"recipientId"}}`, encodeURIComponent(String(requestParameters['recipientId'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * Delete recipient
+     */
+    async deleteRecipientRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.deleteRecipientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecipientsFromJSON(jsonValue));
+    }
+    /**
+     * Removes a recipient from the user\'s list of saved payees. This action cannot be undone.  **Important:** - The recipient will be permanently removed from the user\'s account - Any scheduled transfers to this recipient may fail after deletion - The user must re-create the recipient if they want to send transfers in the future
+     * Delete recipient
+     */
+    async deleteRecipient(requestParameters, initOverrides) {
+        const response = await this.deleteRecipientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getRecipient without sending the request
+     */
+    async getRecipientRequestOpts(requestParameters) {
+        if (requestParameters['recipientId'] == null) {
+            throw new runtime.RequiredError('recipientId', 'Required parameter "recipientId" was null or undefined when calling getRecipient().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-recipients/v1/recipients/{recipientId}`;
+        urlPath = urlPath.replace(`{${"recipientId"}}`, encodeURIComponent(String(requestParameters['recipientId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * Get recipient by ID
+     */
+    async getRecipientRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getRecipientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecipientsFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves the details of a specific recipient using their unique identifier. Use this  endpoint to display recipient details before initiating a transfer.
+     * Get recipient by ID
+     */
+    async getRecipient(requestParameters, initOverrides) {
+        const response = await this.getRecipientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for listRecipients without sending the request
+     */
+    async listRecipientsRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-recipients/v1/recipients`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * List recipients
+     */
+    async listRecipientsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listRecipientsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecipientsFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves all recipients associated with the authenticated user\'s account. Recipients are  saved payees that can receive transfers from the user.
+     * List recipients
+     */
+    async listRecipients(requestParameters = {}, initOverrides) {
+        const response = await this.listRecipientsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for updateRecipient without sending the request
+     */
+    async updateRecipientRequestOpts(requestParameters) {
+        if (requestParameters['recipientId'] == null) {
+            throw new runtime.RequiredError('recipientId', 'Required parameter "recipientId" was null or undefined when calling updateRecipient().');
+        }
+        if (requestParameters['recipient'] == null) {
+            throw new runtime.RequiredError('recipient', 'Required parameter "recipient" was null or undefined when calling updateRecipient().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['fromAccountId'] != null) {
+            queryParameters['fromAccountId'] = requestParameters['fromAccountId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-recipients/v1/recipients/{recipientId}`;
+        urlPath = urlPath.replace(`{${"recipientId"}}`, encodeURIComponent(String(requestParameters['recipientId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RecipientToJSON(requestParameters['recipient']),
+        };
+    }
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * Update recipient
+     */
+    async updateRecipientRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateRecipientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecipientsFromJSON(jsonValue));
+    }
+    /**
+     * Updates an existing recipient\'s information. After updating, the recipient record may need  to be re-validated depending on which fields were changed.  **Important:** If the account number or passcode is changed, consider re-validating the recipient before  initiating transfers to ensure the updated information is correct.
+     * Update recipient
+     */
+    async updateRecipient(requestParameters, initOverrides) {
+        const response = await this.updateRecipientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}