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

package/dist/generated/src/apis/{AlertDeliveryApi.d.ts → HistoryAndEventsApi.d.ts}

@@ -1,8 +1,8 @@
 /**
  * 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/)**.
+ * 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,12 +11,12 @@
  */
 import * as runtime from '../runtime.js';
 import type { AlertHistoryContentResource, AlertHistorySummaryResources, Event } from '../models/index.js';
-export interface AlertDeliveryApiGetHistoryContentRequest {
+export interface HistoryAndEventsApiGetHistoryContentRequest {
     alertHistoryId?: string;
     eventId?: string;
     id?: number;
 }
-export interface AlertDeliveryApiListHistoryRequest {
+export interface HistoryAndEventsApiListHistoryRequest {
     accountIds?: Array<string>;
     alertTypeNames?: Array<string>;
     emailStatus?: ListHistoryEmailStatusEnum;
@@ -31,44 +31,44 @@ export interface AlertDeliveryApiListHistoryRequest {
     loginId?: string;
     institutionCustomerId?: string;
 }
-export interface AlertDeliveryApiPublishEventsRequest {
+export interface HistoryAndEventsApiPublishEventsRequest {
     event: Event;
     institutionCustomerId?: string;
     hostUserId?: string;
     loginId?: string;
 }
 /**
- * AlertDeliveryApi - interface
+ * HistoryAndEventsApi - interface
  *
  * @export
- * @interface AlertDeliveryApiInterface
+ * @interface HistoryAndEventsApiInterface
  */
-export interface AlertDeliveryApiInterface {
+export interface HistoryAndEventsApiInterface {
     /**
      * Creates request options for getHistoryContent without sending the request
      * @param {string} [alertHistoryId] alertHistoryId
      * @param {string} [eventId] eventId
      * @param {number} [id] id
      * @throws {RequiredError}
-     * @memberof AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    getHistoryContentRequestOpts(requestParameters: AlertDeliveryApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
+    getHistoryContentRequestOpts(requestParameters: HistoryAndEventsApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * @summary Get alert history content
+     * @summary Get Alert History
      * @param {string} [alertHistoryId] alertHistoryId
      * @param {string} [eventId] eventId
      * @param {number} [id] id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    getHistoryContentRaw(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
+    getHistoryContentRaw(requestParameters: HistoryAndEventsApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * Get alert history content
+     * Get Alert History
      */
-    getHistoryContent(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
+    getHistoryContent(requestParameters: HistoryAndEventsApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
     /**
      * Creates request options for listHistory without sending the request
      * @param {Array<string>} [accountIds] accountIds
@@ -85,12 +85,12 @@ export interface AlertDeliveryApiInterface {
      * @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] institutionCustomerId
      * @throws {RequiredError}
-     * @memberof AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    listHistoryRequestOpts(requestParameters: AlertDeliveryApiListHistoryRequest): Promise<runtime.RequestOpts>;
+    listHistoryRequestOpts(requestParameters: HistoryAndEventsApiListHistoryRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * @summary List alert history
+     * @summary List Alert History
      * @param {Array<string>} [accountIds] accountIds
      * @param {Array<string>} [alertTypeNames] alertTypeNames
      * @param {Array<'SUCCESS' | 'FAILURE' | 'IN_PROCESS'>} [emailStatus] emailStatus
@@ -106,14 +106,14 @@ export interface AlertDeliveryApiInterface {
      * @param {string} [institutionCustomerId] institutionCustomerId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    listHistoryRaw(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
+    listHistoryRaw(requestParameters: HistoryAndEventsApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * List alert history
+     * List Alert History
      */
-    listHistory(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
+    listHistory(requestParameters: HistoryAndEventsApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
     /**
      * Creates request options for publishEvents without sending the request
      * @param {Event} event event
@@ -121,73 +121,73 @@ export interface AlertDeliveryApiInterface {
      * @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 AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    publishEventsRequestOpts(requestParameters: AlertDeliveryApiPublishEventsRequest): Promise<runtime.RequestOpts>;
+    publishEventsRequestOpts(requestParameters: HistoryAndEventsApiPublishEventsRequest): Promise<runtime.RequestOpts>;
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * @summary Publish alert event
+     * @summary Publish Alert Event
      * @param {Event} event event
      * @param {string} [institutionCustomerId] institutionCustomerId
      * @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 AlertDeliveryApiInterface
+     * @memberof HistoryAndEventsApiInterface
      */
-    publishEventsRaw(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    publishEventsRaw(requestParameters: HistoryAndEventsApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * Publish alert event
+     * Publish Alert Event
      */
-    publishEvents(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    publishEvents(requestParameters: HistoryAndEventsApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
 /**
  *
  */
-export declare class AlertDeliveryApi extends runtime.BaseAPI implements AlertDeliveryApiInterface {
+export declare class HistoryAndEventsApi extends runtime.BaseAPI implements HistoryAndEventsApiInterface {
     /**
      * Creates request options for getHistoryContent without sending the request
      */
-    getHistoryContentRequestOpts(requestParameters: AlertDeliveryApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
+    getHistoryContentRequestOpts(requestParameters: HistoryAndEventsApiGetHistoryContentRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * Get alert history content
+     * Get Alert History
      */
-    getHistoryContentRaw(requestParameters: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
+    getHistoryContentRaw(requestParameters: HistoryAndEventsApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistoryContentResource>>;
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * Get alert history content
+     * Get Alert History
      */
-    getHistoryContent(requestParameters?: AlertDeliveryApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
+    getHistoryContent(requestParameters?: HistoryAndEventsApiGetHistoryContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistoryContentResource>;
     /**
      * Creates request options for listHistory without sending the request
      */
-    listHistoryRequestOpts(requestParameters: AlertDeliveryApiListHistoryRequest): Promise<runtime.RequestOpts>;
+    listHistoryRequestOpts(requestParameters: HistoryAndEventsApiListHistoryRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * List alert history
+     * List Alert History
      */
-    listHistoryRaw(requestParameters: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
+    listHistoryRaw(requestParameters: HistoryAndEventsApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertHistorySummaryResources>>;
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * List alert history
+     * List Alert History
      */
-    listHistory(requestParameters?: AlertDeliveryApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
+    listHistory(requestParameters?: HistoryAndEventsApiListHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertHistorySummaryResources>;
     /**
      * Creates request options for publishEvents without sending the request
      */
-    publishEventsRequestOpts(requestParameters: AlertDeliveryApiPublishEventsRequest): Promise<runtime.RequestOpts>;
+    publishEventsRequestOpts(requestParameters: HistoryAndEventsApiPublishEventsRequest): Promise<runtime.RequestOpts>;
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * Publish alert event
+     * Publish Alert Event
      */
-    publishEventsRaw(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    publishEventsRaw(requestParameters: HistoryAndEventsApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * Publish alert event
+     * Publish Alert Event
      */
-    publishEvents(requestParameters: AlertDeliveryApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    publishEvents(requestParameters: HistoryAndEventsApiPublishEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
 /**
  * @export

package/dist/generated/src/apis/{AlertDeliveryApi.js → HistoryAndEventsApi.js}

@@ -2,9 +2,9 @@
 /* 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/)**.
+ * 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@ import { AlertHistoryContentResourceFromJSON, AlertHistorySummaryResourcesFromJS
 /**
  *
  */
-export class AlertDeliveryApi extends runtime.BaseAPI {
+export class HistoryAndEventsApi extends runtime.BaseAPI {
     /**
      * Creates request options for getHistoryContent without sending the request
      */
@@ -39,7 +39,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-delivery/v1/alert-history-content`;
+        let urlPath = `/v1/alert-history-content`;
         return {
             path: urlPath,
             method: 'GET',
@@ -49,7 +49,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * Get alert history content
+     * Get Alert History
      */
     async getHistoryContentRaw(requestParameters, initOverrides) {
         const requestOptions = await this.getHistoryContentRequestOpts(requestParameters);
@@ -58,7 +58,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve specific alert history records using content ID, history summary ID, or event ID.
-     * Get alert history content
+     * Get Alert History
      */
     async getHistoryContent(requestParameters = {}, initOverrides) {
         const response = await this.getHistoryContentRaw(requestParameters, initOverrides);
@@ -116,7 +116,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-delivery/v1/alert-history`;
+        let urlPath = `/v1/alert-history`;
         return {
             path: urlPath,
             method: 'GET',
@@ -126,7 +126,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * List alert history
+     * List Alert History
      */
     async listHistoryRaw(requestParameters, initOverrides) {
         const requestOptions = await this.listHistoryRequestOpts(requestParameters);
@@ -135,7 +135,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve alert history data using various filter parameters. You can filter by account IDs, date range, alert types, and other criteria.
-     * List alert history
+     * List Alert History
      */
     async listHistory(requestParameters = {}, initOverrides) {
         const response = await this.listHistoryRaw(requestParameters, initOverrides);
@@ -167,7 +167,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-events/v1/realtime-events`;
+        let urlPath = `/v1/realtime-events`;
         return {
             path: urlPath,
             method: 'POST',
@@ -178,7 +178,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * Publish alert event
+     * Publish Alert Event
      */
     async publishEventsRaw(requestParameters, initOverrides) {
         const requestOptions = await this.publishEventsRequestOpts(requestParameters);
@@ -187,7 +187,7 @@ export class AlertDeliveryApi extends runtime.BaseAPI {
     }
     /**
      * Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.  **Event Domain Types:** - **AccountEvent**: Account-related alerts (balance changes, low balance, etc.) - **TransactionEvent**: Transaction-related alerts (large transactions, payment exceeding limit, etc.) - **NotificationEvent**: Messages from external parties (such as Visa) that pass through to the customer without additional processing - **UserEvent**: User-related events (login, password change, etc.)  **Processing Flow:** 1. Event is received and validated 2. Alert type and user preferences are matched 3. Template is applied with event data 4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)
-     * Publish alert event
+     * Publish Alert Event
      */
     async publishEvents(requestParameters, initOverrides) {
         await this.publishEventsRaw(requestParameters, initOverrides);
@@ -217,3 +217,4 @@ export const ListHistorySmsStatusEnum = {
     FAILURE: 'FAILURE',
     IN_PROCESS: 'IN_PROCESS'
 };
+//# sourceMappingURL=HistoryAndEventsApi.js.map

package/dist/generated/src/apis/HistoryAndEventsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HistoryAndEventsApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/HistoryAndEventsApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAQzC,OAAO,EACH,mCAAmC,EAEnC,oCAAoC,EAOpC,WAAW,GACd,MAAM,oBAAoB,CAAC;AAkJ5B;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,OAAO,CAAC,OAAO;IAEpD;;OAEG;IACH,KAAK,CAAC,4BAA4B,CAAC,iBAA8D;QAC7F,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,IAAI,EAAE,CAAC;YAC9C,eAAe,CAAC,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,eAAe,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,2BAA2B,CAAC;QAE1C,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA8D,EAAE,aAA0D;QACjJ,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;QAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,mCAAmC,CAAC,SAAS,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,oBAAiE,EAAE,EAAE,aAA0D;QACnJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAAwD;QACjF,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,IAAI,EAAE,CAAC;YAC9C,eAAe,CAAC,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,iBAAiB,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC;YAC3C,eAAe,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,eAAe,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,eAAe,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,eAAe,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,eAAe,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,eAAe,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,gBAAgB,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,mBAAmB,CAAC;QAElC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAwD,EAAE,aAA0D;QACrI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,oCAAoC,CAAC,SAAS,CAAC,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,oBAA2D,EAAE,EAAE,aAA0D;QACvI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAA0D;QACrF,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,OAAO,EACP,gFAAgF,CACnF,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,gBAAgB,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,qBAAqB,CAAC;QAEpC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SAChD,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,iBAA0D,EAAE,aAA0D;QACzI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,iBAA0D,EAAE,aAA0D;QACtI,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;CAEJ;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACtC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;CAClB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACrC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;CAClB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACpC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;CAClB,CAAC"}

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

@@ -0,0 +1,156 @@
+/**
+ * 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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 { BankingImage, BankingImages, ImageType } from '../models/index.js';
+export interface ImagesApiGetBankingImageByIdRequest {
+    bankingImageId: string;
+    accountId: string;
+    imageType: ImageType;
+    hostUserId?: string;
+    loginId?: string;
+    institutionCustomerId?: string;
+    transactionDate?: Date;
+    imageIdentifier?: string;
+    statementDate?: Date;
+}
+export interface ImagesApiListBankingImagesRequest {
+    accountId: string;
+    imageType: ImageType;
+    hostUserId?: string;
+    loginId?: string;
+    institutionCustomerId?: string;
+    transactionDate?: Date;
+    imageIdentifier?: string;
+    transactionImageNumber?: string;
+    statementStartDate?: Date;
+    statementEndDate?: Date;
+    statementPreview?: boolean;
+}
+/**
+ * ImagesApi - interface
+ *
+ * @export
+ * @interface ImagesApiInterface
+ */
+export interface ImagesApiInterface {
+    /**
+     * Creates request options for getBankingImageById without sending the request
+     * @param {string} bankingImageId Unique identifier of the banking image to be retrieved.
+     * @param {string} accountId Unique identifier of the account associated with the requested banking images.
+     * @param {ImageType} imageType Identifies the category of banking document images to return. Allowed values are those of &#x60;ImageType&#x60;. Required companion query parameters depend on the selected image type.
+     * @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] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [transactionDate] Posted date (&#x60;YYYY-MM-DD&#x60;) of the **transaction** for which check, deposit slip, or deposit check images are requested.  **Required** when &#x60;imageType&#x60; is &#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, or &#x60;DEPOSIT_CHECK&#x60;. The value must be present and parseable. The service retrieves host transactions for the specified account on the given calendar date and resolves the image using &#x60;transactionImageNumber&#x60; and/or &#x60;imageIdentifier&#x60;, depending on the image type and institution configuration.  The service validates the date against the institution’s configured image retention and expiration policies.  When identifier‑based check matching is enabled, this date is still used to scope the host transaction lookup.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [imageIdentifier] Host‑side identifier for a **transaction image** (check or deposit slip) used to locate the underlying transaction on the host system. When provided, the service compares this value against the transaction image identifier in host transaction data during image resolution.  **Required** when &#x60;imageType&#x60; is &#x60;DEPOSIT_SLIP&#x60; or &#x60;DEPOSIT_CHECK&#x60;. If the institution enables deposit check image identifier matching and this parameter is provided, the service resolves the image using this identifier. Otherwise, the service falls back to matching based on &#x60;transactionDate&#x60; and &#x60;transactionImageNumber&#x60; as defined for deposit check image retrieval.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementDate] Applicable when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  Identifies the **statement calendar date** (&#x60;YYYY-MM-DD&#x60;) to send to the downstream FICDS statement image service when retrieving a single statement or document. When **omitted**, the downstream request may also omit &#x60;statementDate&#x60;, allowing the host to resolve the document using the statement identifier alone.  If this parameter is **present**, it must be non‑blank and parseable as a date; otherwise the request fails (&#x60;BIS_00022&#x60; for empty values, &#x60;BIS_00003&#x60; for invalid or unparseable dates).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @throws {RequiredError}
+     * @memberof ImagesApiInterface
+     */
+    getBankingImageByIdRequestOpts(requestParameters: ImagesApiGetBankingImageByIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves and returns a specific scanned banking document image—such as a check, deposit slip, statement, or other supported document—using the provided image identifier. The response includes the image data and related metadata required to view, download, or print the document.  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip image for auditing or record‑keeping purposes - Download and view statements or documents in PDF format  **Behavior and capabilities:** - The image is returned only if the authenticated user is entitled to access it. - The response contains the full image data along with descriptive metadata. - A single banking image may include multiple image representations, such as multiple pages   or different document views. - The image format returned depends on the type of banking document requested.  **Response Format:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images are returned as base64‑encoded TIFF data. - CC_STATEMENT, DOCUMENT, and STATEMENT images are returned as base64‑encoded PDF data. - The imageInfoItems.imageInfo array may contain one or more image representations, such as   multiple pages or front and back views.
+     * @summary Get Banking Image by ID
+     * @param {string} bankingImageId Unique identifier of the banking image to be retrieved.
+     * @param {string} accountId Unique identifier of the account associated with the requested banking images.
+     * @param {ImageType} imageType Identifies the category of banking document images to return. Allowed values are those of &#x60;ImageType&#x60;. Required companion query parameters depend on the selected image type.
+     * @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] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [transactionDate] Posted date (&#x60;YYYY-MM-DD&#x60;) of the **transaction** for which check, deposit slip, or deposit check images are requested.  **Required** when &#x60;imageType&#x60; is &#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, or &#x60;DEPOSIT_CHECK&#x60;. The value must be present and parseable. The service retrieves host transactions for the specified account on the given calendar date and resolves the image using &#x60;transactionImageNumber&#x60; and/or &#x60;imageIdentifier&#x60;, depending on the image type and institution configuration.  The service validates the date against the institution’s configured image retention and expiration policies.  When identifier‑based check matching is enabled, this date is still used to scope the host transaction lookup.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [imageIdentifier] Host‑side identifier for a **transaction image** (check or deposit slip) used to locate the underlying transaction on the host system. When provided, the service compares this value against the transaction image identifier in host transaction data during image resolution.  **Required** when &#x60;imageType&#x60; is &#x60;DEPOSIT_SLIP&#x60; or &#x60;DEPOSIT_CHECK&#x60;. If the institution enables deposit check image identifier matching and this parameter is provided, the service resolves the image using this identifier. Otherwise, the service falls back to matching based on &#x60;transactionDate&#x60; and &#x60;transactionImageNumber&#x60; as defined for deposit check image retrieval.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementDate] Applicable when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  Identifies the **statement calendar date** (&#x60;YYYY-MM-DD&#x60;) to send to the downstream FICDS statement image service when retrieving a single statement or document. When **omitted**, the downstream request may also omit &#x60;statementDate&#x60;, allowing the host to resolve the document using the statement identifier alone.  If this parameter is **present**, it must be non‑blank and parseable as a date; otherwise the request fails (&#x60;BIS_00022&#x60; for empty values, &#x60;BIS_00003&#x60; for invalid or unparseable dates).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImagesApiInterface
+     */
+    getBankingImageByIdRaw(requestParameters: ImagesApiGetBankingImageByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImage>>;
+    /**
+     * Retrieves and returns a specific scanned banking document image—such as a check, deposit slip, statement, or other supported document—using the provided image identifier. The response includes the image data and related metadata required to view, download, or print the document.  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip image for auditing or record‑keeping purposes - Download and view statements or documents in PDF format  **Behavior and capabilities:** - The image is returned only if the authenticated user is entitled to access it. - The response contains the full image data along with descriptive metadata. - A single banking image may include multiple image representations, such as multiple pages   or different document views. - The image format returned depends on the type of banking document requested.  **Response Format:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images are returned as base64‑encoded TIFF data. - CC_STATEMENT, DOCUMENT, and STATEMENT images are returned as base64‑encoded PDF data. - The imageInfoItems.imageInfo array may contain one or more image representations, such as   multiple pages or front and back views.
+     * Get Banking Image by ID
+     */
+    getBankingImageById(requestParameters: ImagesApiGetBankingImageByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImage>;
+    /**
+     * Creates request options for listBankingImages without sending the request
+     * @param {string} accountId Unique identifier of the account associated with the requested banking images.
+     * @param {ImageType} imageType Identifies the category of banking document images to return. Allowed values are those of &#x60;ImageType&#x60;. Required companion query parameters depend on the selected image type.
+     * @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] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [transactionDate] Posted date (&#x60;YYYY-MM-DD&#x60;) of the **transaction** for which check, deposit slip, or deposit check images are requested.  **Required** when &#x60;imageType&#x60; is &#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, or &#x60;DEPOSIT_CHECK&#x60;. The value must be present and parseable. The service retrieves host transactions for the specified account on the given calendar date and resolves the image using &#x60;transactionImageNumber&#x60; and/or &#x60;imageIdentifier&#x60;, depending on the image type and institution configuration.  The service validates the date against the institution’s configured image retention and expiration policies.  When identifier‑based check matching is enabled, this date is still used to scope the host transaction lookup.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [imageIdentifier] Host‑side identifier for a **transaction image** (check or deposit slip) used to locate the underlying transaction on the host system. When provided, the service compares this value against the transaction image identifier in host transaction data during image resolution.  **Required** when &#x60;imageType&#x60; is &#x60;DEPOSIT_SLIP&#x60; or &#x60;DEPOSIT_CHECK&#x60;. If the institution enables deposit check image identifier matching and this parameter is provided, the service resolves the image using this identifier. Otherwise, the service falls back to matching based on &#x60;transactionDate&#x60; and &#x60;transactionImageNumber&#x60; as defined for deposit check image retrieval.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [transactionImageNumber] The check number or deposit slip reference associated with the host transaction. Together with &#x60;transactionDate&#x60;, this value is used to select the corresponding transaction from the host transaction results **unless** identifier‑based matching is enabled for the institution and &#x60;imageIdentifier&#x60; is used to resolve the transaction instead.  When &#x60;imageType&#x60; is &#x60;CHECK&#x60; and this parameter is provided, the value must contain **numeric digits only**. Non‑numeric values result in a validation error (&#x60;BIS_00009&#x60;).  For standard check retrieval without identifier‑based matching, this parameter is required together with &#x60;transactionDate&#x60;.  For &#x60;DEPOSIT_SLIP&#x60; and &#x60;DEPOSIT_CHECK&#x60;, &#x60;imageIdentifier&#x60; is required; this parameter may still be forwarded to downstream image retrieval systems where applicable.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementStartDate] Inclusive **start** date (&#x60;YYYY-MM-DD&#x60;) of the statement or document date range when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  **Required together with &#x60;statementEndDate&#x60;** for these image types. Both dates must be non‑blank and parseable (&#x60;BIS_00018&#x60; if either is missing or empty). The start date must be on or before &#x60;statementEndDate&#x60; (&#x60;BIS_00019&#x60; if not).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementEndDate] Inclusive **end** date (&#x60;YYYY-MM-DD&#x60;) of the statement or document date range when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  **Required together with &#x60;statementStartDate&#x60;** for these image types. Both dates must be non‑blank and parseable (&#x60;BIS_00018&#x60; if either is missing or empty). The end date must be on or after &#x60;statementStartDate&#x60; (&#x60;BIS_00019&#x60; if not).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {boolean} [statementPreview] Optional flag applicable when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;. If this parameter is **omitted**, no preview flag is passed to the downstream statement image service.  When set to **true**, the service includes the downstream query parameter &#x60;Preview&#x3D;true&#x60; on the FICDS statement image request, enabling **statement list preview** behavior for integrations that require it. When set to **false**, the preview flag is not added.  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @throws {RequiredError}
+     * @memberof ImagesApiInterface
+     */
+    listBankingImagesRequestOpts(requestParameters: ImagesApiListBankingImagesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a list of available scanned banking document images based on the provided query parameters, such as account, image type, and date criteria. The response includes image identifiers and associated metadata that can be used to view, download, or print individual images using the image retrieval endpoint.  **Use this endpoint to:** - Display a list of available banking images for a customer or account - Retrieve image metadata for transaction history or statement views - Obtain image IDs needed to retrieve individual images  **Behavior and capabilities:** - Results are returned only for images the authenticated user is entitled to access. - The response includes metadata and identifiers, not image data. - Image availability and returned fields may vary based on entitlements and account   configuration. - Images are filtered based on document type and applicable date criteria.  **Supported Image Types:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images require the `transactionDate` query   parameter. - CC_STATEMENT, DOCUMENT, and STATEMENT images require **both** `statementStartDate` and   `statementEndDate` (inclusive range, `YYYY-MM-DD`).
+     * @summary List Banking Images
+     * @param {string} accountId Unique identifier of the account associated with the requested banking images.
+     * @param {ImageType} imageType Identifies the category of banking document images to return. Allowed values are those of &#x60;ImageType&#x60;. Required companion query parameters depend on the selected image type.
+     * @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] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [transactionDate] Posted date (&#x60;YYYY-MM-DD&#x60;) of the **transaction** for which check, deposit slip, or deposit check images are requested.  **Required** when &#x60;imageType&#x60; is &#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, or &#x60;DEPOSIT_CHECK&#x60;. The value must be present and parseable. The service retrieves host transactions for the specified account on the given calendar date and resolves the image using &#x60;transactionImageNumber&#x60; and/or &#x60;imageIdentifier&#x60;, depending on the image type and institution configuration.  The service validates the date against the institution’s configured image retention and expiration policies.  When identifier‑based check matching is enabled, this date is still used to scope the host transaction lookup.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [imageIdentifier] Host‑side identifier for a **transaction image** (check or deposit slip) used to locate the underlying transaction on the host system. When provided, the service compares this value against the transaction image identifier in host transaction data during image resolution.  **Required** when &#x60;imageType&#x60; is &#x60;DEPOSIT_SLIP&#x60; or &#x60;DEPOSIT_CHECK&#x60;. If the institution enables deposit check image identifier matching and this parameter is provided, the service resolves the image using this identifier. Otherwise, the service falls back to matching based on &#x60;transactionDate&#x60; and &#x60;transactionImageNumber&#x60; as defined for deposit check image retrieval.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {string} [transactionImageNumber] The check number or deposit slip reference associated with the host transaction. Together with &#x60;transactionDate&#x60;, this value is used to select the corresponding transaction from the host transaction results **unless** identifier‑based matching is enabled for the institution and &#x60;imageIdentifier&#x60; is used to resolve the transaction instead.  When &#x60;imageType&#x60; is &#x60;CHECK&#x60; and this parameter is provided, the value must contain **numeric digits only**. Non‑numeric values result in a validation error (&#x60;BIS_00009&#x60;).  For standard check retrieval without identifier‑based matching, this parameter is required together with &#x60;transactionDate&#x60;.  For &#x60;DEPOSIT_SLIP&#x60; and &#x60;DEPOSIT_CHECK&#x60;, &#x60;imageIdentifier&#x60; is required; this parameter may still be forwarded to downstream image retrieval systems where applicable.  **Not applicable** to statement‑based image types (&#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, &#x60;DOCUMENT&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementStartDate] Inclusive **start** date (&#x60;YYYY-MM-DD&#x60;) of the statement or document date range when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  **Required together with &#x60;statementEndDate&#x60;** for these image types. Both dates must be non‑blank and parseable (&#x60;BIS_00018&#x60; if either is missing or empty). The start date must be on or before &#x60;statementEndDate&#x60; (&#x60;BIS_00019&#x60; if not).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {Date} [statementEndDate] Inclusive **end** date (&#x60;YYYY-MM-DD&#x60;) of the statement or document date range when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;.  **Required together with &#x60;statementStartDate&#x60;** for these image types. Both dates must be non‑blank and parseable (&#x60;BIS_00018&#x60; if either is missing or empty). The end date must be on or after &#x60;statementStartDate&#x60; (&#x60;BIS_00019&#x60; if not).  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {boolean} [statementPreview] Optional flag applicable when &#x60;imageType&#x60; is &#x60;STATEMENT&#x60;, &#x60;CC_STATEMENT&#x60;, or &#x60;DOCUMENT&#x60;. If this parameter is **omitted**, no preview flag is passed to the downstream statement image service.  When set to **true**, the service includes the downstream query parameter &#x60;Preview&#x3D;true&#x60; on the FICDS statement image request, enabling **statement list preview** behavior for integrations that require it. When set to **false**, the preview flag is not added.  **Not applicable** to transaction‑based image types (&#x60;CHECK&#x60;, &#x60;DEPOSIT_SLIP&#x60;, &#x60;DEPOSIT_CHECK&#x60;); omit this parameter for those requests.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImagesApiInterface
+     */
+    listBankingImagesRaw(requestParameters: ImagesApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImages>>;
+    /**
+     * Returns a list of available scanned banking document images based on the provided query parameters, such as account, image type, and date criteria. The response includes image identifiers and associated metadata that can be used to view, download, or print individual images using the image retrieval endpoint.  **Use this endpoint to:** - Display a list of available banking images for a customer or account - Retrieve image metadata for transaction history or statement views - Obtain image IDs needed to retrieve individual images  **Behavior and capabilities:** - Results are returned only for images the authenticated user is entitled to access. - The response includes metadata and identifiers, not image data. - Image availability and returned fields may vary based on entitlements and account   configuration. - Images are filtered based on document type and applicable date criteria.  **Supported Image Types:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images require the `transactionDate` query   parameter. - CC_STATEMENT, DOCUMENT, and STATEMENT images require **both** `statementStartDate` and   `statementEndDate` (inclusive range, `YYYY-MM-DD`).
+     * List Banking Images
+     */
+    listBankingImages(requestParameters: ImagesApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImages | null | undefined>;
+}
+/**
+ *
+ */
+export declare class ImagesApi extends runtime.BaseAPI implements ImagesApiInterface {
+    /**
+     * Creates request options for getBankingImageById without sending the request
+     */
+    getBankingImageByIdRequestOpts(requestParameters: ImagesApiGetBankingImageByIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves and returns a specific scanned banking document image—such as a check, deposit slip, statement, or other supported document—using the provided image identifier. The response includes the image data and related metadata required to view, download, or print the document.  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip image for auditing or record‑keeping purposes - Download and view statements or documents in PDF format  **Behavior and capabilities:** - The image is returned only if the authenticated user is entitled to access it. - The response contains the full image data along with descriptive metadata. - A single banking image may include multiple image representations, such as multiple pages   or different document views. - The image format returned depends on the type of banking document requested.  **Response Format:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images are returned as base64‑encoded TIFF data. - CC_STATEMENT, DOCUMENT, and STATEMENT images are returned as base64‑encoded PDF data. - The imageInfoItems.imageInfo array may contain one or more image representations, such as   multiple pages or front and back views.
+     * Get Banking Image by ID
+     */
+    getBankingImageByIdRaw(requestParameters: ImagesApiGetBankingImageByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImage>>;
+    /**
+     * Retrieves and returns a specific scanned banking document image—such as a check, deposit slip, statement, or other supported document—using the provided image identifier. The response includes the image data and related metadata required to view, download, or print the document.  **Use this endpoint to:** - Display a specific check image for transaction verification - Retrieve a deposit slip image for auditing or record‑keeping purposes - Download and view statements or documents in PDF format  **Behavior and capabilities:** - The image is returned only if the authenticated user is entitled to access it. - The response contains the full image data along with descriptive metadata. - A single banking image may include multiple image representations, such as multiple pages   or different document views. - The image format returned depends on the type of banking document requested.  **Response Format:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images are returned as base64‑encoded TIFF data. - CC_STATEMENT, DOCUMENT, and STATEMENT images are returned as base64‑encoded PDF data. - The imageInfoItems.imageInfo array may contain one or more image representations, such as   multiple pages or front and back views.
+     * Get Banking Image by ID
+     */
+    getBankingImageById(requestParameters: ImagesApiGetBankingImageByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImage>;
+    /**
+     * Creates request options for listBankingImages without sending the request
+     */
+    listBankingImagesRequestOpts(requestParameters: ImagesApiListBankingImagesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a list of available scanned banking document images based on the provided query parameters, such as account, image type, and date criteria. The response includes image identifiers and associated metadata that can be used to view, download, or print individual images using the image retrieval endpoint.  **Use this endpoint to:** - Display a list of available banking images for a customer or account - Retrieve image metadata for transaction history or statement views - Obtain image IDs needed to retrieve individual images  **Behavior and capabilities:** - Results are returned only for images the authenticated user is entitled to access. - The response includes metadata and identifiers, not image data. - Image availability and returned fields may vary based on entitlements and account   configuration. - Images are filtered based on document type and applicable date criteria.  **Supported Image Types:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images require the `transactionDate` query   parameter. - CC_STATEMENT, DOCUMENT, and STATEMENT images require **both** `statementStartDate` and   `statementEndDate` (inclusive range, `YYYY-MM-DD`).
+     * List Banking Images
+     */
+    listBankingImagesRaw(requestParameters: ImagesApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BankingImages>>;
+    /**
+     * Returns a list of available scanned banking document images based on the provided query parameters, such as account, image type, and date criteria. The response includes image identifiers and associated metadata that can be used to view, download, or print individual images using the image retrieval endpoint.  **Use this endpoint to:** - Display a list of available banking images for a customer or account - Retrieve image metadata for transaction history or statement views - Obtain image IDs needed to retrieve individual images  **Behavior and capabilities:** - Results are returned only for images the authenticated user is entitled to access. - The response includes metadata and identifiers, not image data. - Image availability and returned fields may vary based on entitlements and account   configuration. - Images are filtered based on document type and applicable date criteria.  **Supported Image Types:** - CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images require the `transactionDate` query   parameter. - CC_STATEMENT, DOCUMENT, and STATEMENT images require **both** `statementStartDate` and   `statementEndDate` (inclusive range, `YYYY-MM-DD`).
+     * List Banking Images
+     */
+    listBankingImages(requestParameters: ImagesApiListBankingImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BankingImages | null | undefined>;
+}