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

package/dist/generated/src/models/AccountStatuses.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).
@@ -10,97 +10,100 @@
  * Do not edit the class manually.
  */
 /**
+ * Collection of boolean flags that represent the current operational, financial, and lifecycle
+ * states of an account.
  *
  * @export
  * @interface AccountStatuses
  */
 export interface AccountStatuses {
     /**
-     *
+     * Indicates whether the account has been approved for use.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     approved?: boolean;
     /**
-     *
+     * Indicates whether the account is closed.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     closed?: boolean;
     /**
-     *
+     * Indicates whether the account currently has a credit balance.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     creditBalance?: boolean;
     /**
-     *
+     * Indicates whether the account has been marked as deleted.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     deleted?: boolean;
     /**
-     *
+     * Indicates whether the account is delinquent due to missed or late payments.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     delinquent?: boolean;
     /**
-     *
+     * Indicates whether the account has been sent to collections.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     inCollection?: boolean;
     /**
-     *
+     * Indicates whether the account balance is currently negative.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     negativeBalance?: boolean;
     /**
-     *
+     * Indicates whether the account has not been approved.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     notApproved?: boolean;
     /**
-     *
+     * Indicates whether the account is currently open and active.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     open?: boolean;
     /**
-     *
+     * Indicates whether the account has exceeded its allowed credit or usage limit.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     overLimit?: boolean;
     /**
-     *
+     * Indicates whether a payment coupon is associated with the account.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     paymentCoupon?: boolean;
     /**
+     * Indicates whether the account is a retirement plan owned by a deceased individual.
      *
      * @type {boolean}
      * @memberof AccountStatuses
      */
     retPlanOwnedByDeceased?: boolean;
     /**
-     *
+     * Indicates whether the account is a retirement plan account.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     retirementPlan?: boolean;
     /**
-     *
+     * Indicates whether the account has been verified.
      * @type {boolean}
      * @memberof AccountStatuses
      */
     verified?: boolean;
     /**
-     *
+     * Indicates whether the account balance has been written off.
      * @type {boolean}
      * @memberof AccountStatuses
      */

package/dist/generated/src/models/AccountStatuses.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).
@@ -67,3 +67,4 @@ export function AccountStatusesToJSONTyped(value, ignoreDiscriminator = false) {
         'writtenOff': value['writtenOff'],
     };
 }
+//# sourceMappingURL=AccountStatuses.js.map

package/dist/generated/src/models/AccountStatuses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountStatuses.js","sourceRoot":"","sources":["../../../../generated/src/models/AccountStatuses.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAwGH;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACnD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAS;IAC7C,OAAO,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,IAAS,EAAE,mBAA4B;IAChF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC7D,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAClF,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QAChE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QACzE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;QAC/E,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACxF,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;QACtE,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAClF,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC;QAC7G,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;KAC5E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAS;IAC3C,OAAO,0BAA0B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAA8B,EAAE,sBAA+B,KAAK;IAC3G,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;QAC3B,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;QACrC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;QAC3C,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,wBAAwB,EAAE,KAAK,CAAC,wBAAwB,CAAC;QACzD,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;KACpC,CAAC;AACN,CAAC"}

package/dist/generated/src/models/AccountTransaction.d.ts

@@ -1,172 +1,277 @@
 /**
  * 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).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { Money1 } from './Money1.js';
+import type { AccountTransactionAmountToInterest } from './AccountTransactionAmountToInterest.js';
+import type { AccountTransactionAmount } from './AccountTransactionAmount.js';
+import type { AccountTransactionAmountToPrincipal } from './AccountTransactionAmountToPrincipal.js';
+import type { AccountTransactionLedgerBalance } from './AccountTransactionLedgerBalance.js';
+import type { AccountTransactionAmountToEscrow } from './AccountTransactionAmountToEscrow.js';
+import type { AccountTransactionFee } from './AccountTransactionFee.js';
 /**
+ * Represents a transaction associated with an account within the aggregated response. Each
+ * transaction includes details such as identifiers, transaction type, and amount-related
+ * attributes.
  *
  * @export
  * @interface AccountTransaction
  */
 export interface AccountTransaction {
     /**
-     * accountId of the transaction
+     * Identifier of the account to which the transaction belongs.
      * @type {string}
      * @memberof AccountTransaction
      */
-    accountId?: string;
+    accountId: string;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionAmount}
      * @memberof AccountTransaction
      */
-    amount?: Money1;
+    amount: AccountTransactionAmount;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionAmountToEscrow}
      * @memberof AccountTransaction
      */
-    amountToEscrow?: Money1;
+    amountToEscrow?: AccountTransactionAmountToEscrow;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionAmountToInterest}
      * @memberof AccountTransaction
      */
-    amountToInterest?: Money1;
+    amountToInterest?: AccountTransactionAmountToInterest;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionAmountToPrincipal}
      * @memberof AccountTransaction
      */
-    amountToPrincipal?: Money1;
+    amountToPrincipal?: AccountTransactionAmountToPrincipal;
     /**
-     * transaction image
+     * Service-generated identifier for the associated image, derived from transaction
+     * attributes and host image data. Used as the client-facing key when requesting images.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     checkImageIdentifier?: string;
     /**
-     * transaction image
+     * Host-provided locator identifying the image on the core system. May be present even when
+     * other image fields are not populated.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     checkImageLocator?: string;
     /**
-     * checkNumber
+     * Check or share draft number associated with this transaction, when applicable.
+     *
      * @type {number}
      * @memberof AccountTransaction
      */
     checkNumber?: number;
     /**
-     * checkNumber in string format
+     * String representation of the check or share draft number associated with this
+     * transaction, when applicable.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     checkNumberStr?: string;
     /**
-     * is transaction credited
+     * Indicates whether the transaction is a credit (`true`) or a debit (`false`) to the
+     * account.
+     *
      * @type {boolean}
      * @memberof AccountTransaction
      */
-    creditTransaction?: boolean;
+    creditTransaction: boolean;
     /**
-     * transaction image
-     * @type {string}
+     * Specifies the category of the banking image, identifying whether the image represents a
+     * check, deposit slip, statement, credit card statement, or other document.
+     *
+     * @type {AccountTransactionDepositSlipIdentifierEnum}
      * @memberof AccountTransaction
      */
-    depositSlipIdentifier?: string;
+    depositSlipIdentifier?: AccountTransactionDepositSlipIdentifierEnum;
     /**
-     * transaction description
+     * Longer, detailed description of the transaction provided by the source system.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     description?: string;
     /**
-     * effective date of transaction
-     * @type {string}
+     * Date on which the transaction effects are applied to the account balance, which may
+     * differ from the transaction date for pending or backdated items.
+     *
+     * @type {Date}
      * @memberof AccountTransaction
      */
-    effectiveDate?: string;
+    effectiveDate?: Date;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionFee}
      * @memberof AccountTransaction
      */
-    fee?: Money1;
+    fee?: AccountTransactionFee;
     /**
-     * institution id
+     * Identifier of the financial institution to which the account belongs.
      * @type {string}
      * @memberof AccountTransaction
      */
-    fiId?: string;
+    fiId: string;
     /**
-     * transaction id
+     * A unique identifier for the transaction.
      * @type {string}
      * @memberof AccountTransaction
      */
-    id?: string;
+    id: string;
     /**
      *
-     * @type {Money1}
+     * @type {AccountTransactionLedgerBalance}
      * @memberof AccountTransaction
      */
-    ledgerBalance?: Money1;
+    ledgerBalance?: AccountTransactionLedgerBalance;
     /**
-     * memo
+     * Short, optional memo text associated with the transaction provided by the source system
+     * or the customer.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     memo?: string;
     /**
-     * micr number
+     * Magnetic Ink Character Recognition (MICR) number associated with the transaction,
+     * typically derived from check processing.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     micr?: string;
     /**
+     * Indicates whether the transaction is pending and has not yet been fully posted to the
+     * account.
      *
      * @type {boolean}
      * @memberof AccountTransaction
      */
-    isPending?: boolean;
+    pending: boolean;
     /**
+     * Indicates whether the transaction is eligible for export through supported export or
+     * reporting features (for example OFX download).
      *
      * @type {boolean}
      * @memberof AccountTransaction
      */
-    persistentTnum?: boolean;
+    persistentTnum: boolean;
     /**
-     * transaction date
-     * @type {string}
+     * Date on which the transaction activity occurred, as reported by the source system.
+     *
+     * @type {Date}
      * @memberof AccountTransaction
      */
-    transactionDate?: string;
+    transactionDate?: Date;
     /**
-     * host transaction id
+     * Unique transaction identifier assigned by the host system for this transaction.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     transactionId?: string;
     /**
-     * transaction number
+     * Host or institution-assigned transaction number from the upstream system with format
+     * defined by the source system.
+     *
      * @type {string}
      * @memberof AccountTransaction
      */
     transactionNumber?: string;
     /**
-     * transaction type
-     * @type {string}
+     * Identifies the category of a financial transaction, such as a deposit, withdrawal,
+     * transfer, payment, fee, interest posting, adjustment, or refund.
+     *
+     * @type {AccountTransactionTransactionTypeEnum}
      * @memberof AccountTransaction
      */
-    transactionType?: string;
+    transactionType: AccountTransactionTransactionTypeEnum;
 }
+/**
+ * @export
+ */
+export declare const AccountTransactionDepositSlipIdentifierEnum: {
+    readonly UNKNOWN: "UNKNOWN";
+    readonly CHECK: "CHECK";
+    readonly DEPOSIT_SLIP: "DEPOSIT_SLIP";
+    readonly STATEMENT: "STATEMENT";
+    readonly CC_STATEMENT: "CC_STATEMENT";
+    readonly DOCUMENT: "DOCUMENT";
+    readonly DEPOSIT_CHECK: "DEPOSIT_CHECK";
+};
+export type AccountTransactionDepositSlipIdentifierEnum = typeof AccountTransactionDepositSlipIdentifierEnum[keyof typeof AccountTransactionDepositSlipIdentifierEnum];
+/**
+ * @export
+ */
+export declare const AccountTransactionTransactionTypeEnum: {
+    readonly WITHDRAWAL: "WITHDRAWAL";
+    readonly CHECK: "CHECK";
+    readonly SAVINGS_WITHDRAWAL_PASSBOOK: "SAVINGS_WITHDRAWAL_PASSBOOK";
+    readonly SAVINGS_WITHDRAWAL_OTHER: "SAVINGS_WITHDRAWAL_OTHER";
+    readonly TELEPHONE_TRANSFER_DEBIT: "TELEPHONE_TRANSFER_DEBIT";
+    readonly TRANSFER_DEBIT: "TRANSFER_DEBIT";
+    readonly ADVANCE: "ADVANCE";
+    readonly AUTOMATIC_DEBIT: "AUTOMATIC_DEBIT";
+    readonly ATM_WITHDRAWAL: "ATM_WITHDRAWAL";
+    readonly ELECTRONIC_TRANSFER_DEBIT: "ELECTRONIC_TRANSFER_DEBIT";
+    readonly POS_PURCHASE: "POS_PURCHASE";
+    readonly BILL_PAYMENT: "BILL_PAYMENT";
+    readonly ACH_CHECK: "ACH_CHECK";
+    readonly SERVICE_CHARGE: "SERVICE_CHARGE";
+    readonly CHECK_BOOK_CHARGE: "CHECK_BOOK_CHARGE";
+    readonly ATM_FEE: "ATM_FEE";
+    readonly POS_PURCHASE_FEE: "POS_PURCHASE_FEE";
+    readonly STOP_PAYMENT_FEE: "STOP_PAYMENT_FEE";
+    readonly INTEREST_CHARGE_NORMAL: "INTEREST_CHARGE_NORMAL";
+    readonly INSUFFICIENT_FUNDS_CHARGE: "INSUFFICIENT_FUNDS_CHARGE";
+    readonly RETURNED_CHECK_FEE: "RETURNED_CHECK_FEE";
+    readonly OVERDRAFT_FEE: "OVERDRAFT_FEE";
+    readonly EARLY_WITHDRAWAL_FEE: "EARLY_WITHDRAWAL_FEE";
+    readonly LEDGER_ADJUSTMENT_DEBIT: "LEDGER_ADJUSTMENT_DEBIT";
+    readonly MISCELLANEOUS_DEBIT: "MISCELLANEOUS_DEBIT";
+    readonly RETAIL_PURCHASE: "RETAIL_PURCHASE";
+    readonly MAIL_ORDER_OR_TELEPHONE_PURCHASE: "MAIL_ORDER_OR_TELEPHONE_PURCHASE";
+    readonly CASH_ADVANCE: "CASH_ADVANCE";
+    readonly ANNUAL_FEE: "ANNUAL_FEE";
+    readonly LATE_PAYMENT_FEE: "LATE_PAYMENT_FEE";
+    readonly INTEREST_CHARGE: "INTEREST_CHARGE";
+    readonly DEBIT_ADJUSTMENT: "DEBIT_ADJUSTMENT";
+    readonly DEPOSIT: "DEPOSIT";
+    readonly TELEPHONE_TRANSFER_CREDIT: "TELEPHONE_TRANSFER_CREDIT";
+    readonly TRANSFER_CREDIT: "TRANSFER_CREDIT";
+    readonly PAYMENT: "PAYMENT";
+    readonly DIVIDEND: "DIVIDEND";
+    readonly DIRECT_DEPOSIT: "DIRECT_DEPOSIT";
+    readonly ATM_DEPOSIT: "ATM_DEPOSIT";
+    readonly ELECTRONIC_TRANSFER_CREDIT: "ELECTRONIC_TRANSFER_CREDIT";
+    readonly POS_CREDIT: "POS_CREDIT";
+    readonly BILL_PAYMENT_CREDIT: "BILL_PAYMENT_CREDIT";
+    readonly ACH_CREDIT: "ACH_CREDIT";
+    readonly INTEREST_POSTING: "INTEREST_POSTING";
+    readonly LEDGER_ADJUSTMENT_CREDIT: "LEDGER_ADJUSTMENT_CREDIT";
+    readonly MISCELLANEOUS_CREDIT: "MISCELLANEOUS_CREDIT";
+    readonly RETURN_OF_GOODS: "RETURN_OF_GOODS";
+    readonly REFUND: "REFUND";
+    readonly PAYMENT_CREDIT_CARD: "PAYMENT_CREDIT_CARD";
+    readonly CREDIT_ADJUSTMENT: "CREDIT_ADJUSTMENT";
+};
+export type AccountTransactionTransactionTypeEnum = typeof AccountTransactionTransactionTypeEnum[keyof typeof AccountTransactionTransactionTypeEnum];
 /**
  * Check if a given object implements the AccountTransaction interface.
  */