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

package/dist/generated/src/models/AccountStatus1.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,107 +10,29 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Represents the status of an account, reflecting its current state.
  * @export
- * @interface AccountStatus1
- */
-export interface AccountStatus1 {
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    open?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    closed?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    negativeBalance?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    delinquent?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    inCollection?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    overLimit?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    writtenOff?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    creditBalance?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    paymentCoupon?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    retirementPlan?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    retPlanOwnedByDeceased?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    approved?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    notApproved?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    deleted?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountStatus1
-     */
-    verified?: boolean;
-}
-/**
- * Check if a given object implements the AccountStatus1 interface.
  */
-export declare function instanceOfAccountStatus1(value: object): value is AccountStatus1;
+export declare const AccountStatus1: {
+    readonly OPEN: "OPEN";
+    readonly CLOSED: "CLOSED";
+    readonly NEGATIVE_BALANCE: "NEGATIVE_BALANCE";
+    readonly DELINQUENT: "DELINQUENT";
+    readonly IN_COLLECTION: "IN_COLLECTION";
+    readonly OVER_LIMIT: "OVER_LIMIT";
+    readonly WRITTEN_OFF: "WRITTEN_OFF";
+    readonly HAS_CREDIT_BAL: "HAS_CREDIT_BAL";
+    readonly PAYMENT_COUPON: "PAYMENT_COUPON";
+    readonly RET_PLAN: "RET_PLAN";
+    readonly RET_PLAN_OWNED_BY_DECEASED: "RET_PLAN_OWNED_BY_DECEASED";
+    readonly APPROVED: "APPROVED";
+    readonly NOT_APPROVED: "NOT_APPROVED";
+    readonly DELETED: "DELETED";
+    readonly VERIFIED: "VERIFIED";
+};
+export type AccountStatus1 = typeof AccountStatus1[keyof typeof AccountStatus1];
+export declare function instanceOfAccountStatus1(value: any): boolean;
 export declare function AccountStatus1FromJSON(json: any): AccountStatus1;
 export declare function AccountStatus1FromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountStatus1;
-export declare function AccountStatus1ToJSON(json: any): AccountStatus1;
-export declare function AccountStatus1ToJSONTyped(value?: AccountStatus1 | null, ignoreDiscriminator?: boolean): any;
+export declare function AccountStatus1ToJSON(value?: AccountStatus1 | null): any;
+export declare function AccountStatus1ToJSONTyped(value: any, ignoreDiscriminator: boolean): AccountStatus1;

package/dist/generated/src/models/AccountStatus1.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).
@@ -12,58 +12,46 @@
  * Do not edit the class manually.
  */
 /**
- * Check if a given object implements the AccountStatus1 interface.
+ * Represents the status of an account, reflecting its current state.
+ * @export
  */
+export const AccountStatus1 = {
+    OPEN: 'OPEN',
+    CLOSED: 'CLOSED',
+    NEGATIVE_BALANCE: 'NEGATIVE_BALANCE',
+    DELINQUENT: 'DELINQUENT',
+    IN_COLLECTION: 'IN_COLLECTION',
+    OVER_LIMIT: 'OVER_LIMIT',
+    WRITTEN_OFF: 'WRITTEN_OFF',
+    HAS_CREDIT_BAL: 'HAS_CREDIT_BAL',
+    PAYMENT_COUPON: 'PAYMENT_COUPON',
+    RET_PLAN: 'RET_PLAN',
+    RET_PLAN_OWNED_BY_DECEASED: 'RET_PLAN_OWNED_BY_DECEASED',
+    APPROVED: 'APPROVED',
+    NOT_APPROVED: 'NOT_APPROVED',
+    DELETED: 'DELETED',
+    VERIFIED: 'VERIFIED'
+};
 export function instanceOfAccountStatus1(value) {
-    return true;
+    for (const key in AccountStatus1) {
+        if (Object.prototype.hasOwnProperty.call(AccountStatus1, key)) {
+            if (AccountStatus1[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
 }
 export function AccountStatus1FromJSON(json) {
     return AccountStatus1FromJSONTyped(json, false);
 }
 export function AccountStatus1FromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'open': json['open'] == null ? undefined : json['open'],
-        'closed': json['closed'] == null ? undefined : json['closed'],
-        'negativeBalance': json['negativeBalance'] == null ? undefined : json['negativeBalance'],
-        'delinquent': json['delinquent'] == null ? undefined : json['delinquent'],
-        'inCollection': json['inCollection'] == null ? undefined : json['inCollection'],
-        'overLimit': json['overLimit'] == null ? undefined : json['overLimit'],
-        'writtenOff': json['writtenOff'] == null ? undefined : json['writtenOff'],
-        'creditBalance': json['creditBalance'] == null ? undefined : json['creditBalance'],
-        'paymentCoupon': json['paymentCoupon'] == null ? undefined : json['paymentCoupon'],
-        'retirementPlan': json['retirementPlan'] == null ? undefined : json['retirementPlan'],
-        'retPlanOwnedByDeceased': json['retPlanOwnedByDeceased'] == null ? undefined : json['retPlanOwnedByDeceased'],
-        'approved': json['approved'] == null ? undefined : json['approved'],
-        'notApproved': json['notApproved'] == null ? undefined : json['notApproved'],
-        'deleted': json['deleted'] == null ? undefined : json['deleted'],
-        'verified': json['verified'] == null ? undefined : json['verified'],
-    };
+    return json;
 }
-export function AccountStatus1ToJSON(json) {
-    return AccountStatus1ToJSONTyped(json, false);
+export function AccountStatus1ToJSON(value) {
+    return value;
 }
-export function AccountStatus1ToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'open': value['open'],
-        'closed': value['closed'],
-        'negativeBalance': value['negativeBalance'],
-        'delinquent': value['delinquent'],
-        'inCollection': value['inCollection'],
-        'overLimit': value['overLimit'],
-        'writtenOff': value['writtenOff'],
-        'creditBalance': value['creditBalance'],
-        'paymentCoupon': value['paymentCoupon'],
-        'retirementPlan': value['retirementPlan'],
-        'retPlanOwnedByDeceased': value['retPlanOwnedByDeceased'],
-        'approved': value['approved'],
-        'notApproved': value['notApproved'],
-        'deleted': value['deleted'],
-        'verified': value['verified'],
-    };
+export function AccountStatus1ToJSONTyped(value, ignoreDiscriminator) {
+    return value;
 }
+//# sourceMappingURL=AccountStatus1.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountStatus1.js","sourceRoot":"","sources":["../../../../generated/src/models/AccountStatus1.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,gBAAgB,EAAE,kBAAkB;IACpC,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,UAAU;IACpB,0BAA0B,EAAE,4BAA4B;IACxD,QAAQ,EAAE,UAAU;IACpB,YAAY,EAAE,cAAc;IAC5B,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACd,CAAC;AAIX,MAAM,UAAU,wBAAwB,CAAC,KAAU;IAC/C,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QAC/B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,EAAE,CAAC;YAC5D,IAAI,cAAc,CAAC,GAAkC,CAAC,KAAK,KAAK,EAAE,CAAC;gBAC/D,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAS;IAC5C,OAAO,2BAA2B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,IAAS,EAAE,mBAA4B;IAC/E,OAAO,IAAsB,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAA6B;IAC9D,OAAO,KAAY,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAU,EAAE,mBAA4B;IAC9E,OAAO,KAAuB,CAAC;AACnC,CAAC"}

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

@@ -0,0 +1,127 @@
+/**
+ * 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.
+ */
+/**
+ * Set of status indicators describing the current state and conditions of the account.
+ *
+ * @export
+ * @interface AccountStatus2
+ */
+export interface AccountStatus2 {
+    /**
+     * Indicates whether the account is currently open and active.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    open: boolean;
+    /**
+     * Indicates whether the account has been closed.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    closed: boolean;
+    /**
+     * Indicates whether the account currently has a negative balance.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    negativeBalance: boolean;
+    /**
+     * Indicates whether the account is delinquent due to missed or late payments.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    delinquent: boolean;
+    /**
+     * Indicates whether the account has been placed in collections.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    inCollection: boolean;
+    /**
+     * Indicates whether the account balance has exceeded an applicable credit or overdraft
+     * limit.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    overLimit: boolean;
+    /**
+     * Indicates whether the account balance has been written off by the financial institution.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    writtenOff: boolean;
+    /**
+     * Indicates whether the account has a positive credit balance, representing a credit or
+     * refundable amount owed to the account holder.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    creditBalance: boolean;
+    /**
+     * Indicates whether payment coupons are associated with the account.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    paymentCoupon: boolean;
+    /**
+     * Indicates whether the account is associated with a retirement plan.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    retirementPlan: boolean;
+    /**
+     * Indicates whether the account is owned by a deceased person.
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    retPlanOwnedByDeceased: boolean;
+    /**
+     * Indicates whether the account has been approved by the financial institution.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    approved?: boolean;
+    /**
+     * Indicates whether the account has not been approved by the financial institution.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    notApproved?: boolean;
+    /**
+     * Indicates whether the account has been marked as deleted or deactivated in the system.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    deleted?: boolean;
+    /**
+     * Indicates whether the account has been verified by the financial institution.
+     *
+     * @type {boolean}
+     * @memberof AccountStatus2
+     */
+    verified?: boolean;
+}
+/**
+ * Check if a given object implements the AccountStatus2 interface.
+ */
+export declare function instanceOfAccountStatus2(value: object): value is AccountStatus2;
+export declare function AccountStatus2FromJSON(json: any): AccountStatus2;
+export declare function AccountStatus2FromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountStatus2;
+export declare function AccountStatus2ToJSON(json: any): AccountStatus2;
+export declare function AccountStatus2ToJSONTyped(value?: AccountStatus2 | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/AccountStatus2.js

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[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.
+ */
+/**
+ * Check if a given object implements the AccountStatus2 interface.
+ */
+export function instanceOfAccountStatus2(value) {
+    if (!('open' in value) || value['open'] === undefined)
+        return false;
+    if (!('closed' in value) || value['closed'] === undefined)
+        return false;
+    if (!('negativeBalance' in value) || value['negativeBalance'] === undefined)
+        return false;
+    if (!('delinquent' in value) || value['delinquent'] === undefined)
+        return false;
+    if (!('inCollection' in value) || value['inCollection'] === undefined)
+        return false;
+    if (!('overLimit' in value) || value['overLimit'] === undefined)
+        return false;
+    if (!('writtenOff' in value) || value['writtenOff'] === undefined)
+        return false;
+    if (!('creditBalance' in value) || value['creditBalance'] === undefined)
+        return false;
+    if (!('paymentCoupon' in value) || value['paymentCoupon'] === undefined)
+        return false;
+    if (!('retirementPlan' in value) || value['retirementPlan'] === undefined)
+        return false;
+    if (!('retPlanOwnedByDeceased' in value) || value['retPlanOwnedByDeceased'] === undefined)
+        return false;
+    return true;
+}
+export function AccountStatus2FromJSON(json) {
+    return AccountStatus2FromJSONTyped(json, false);
+}
+export function AccountStatus2FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'open': json['open'],
+        'closed': json['closed'],
+        'negativeBalance': json['negativeBalance'],
+        'delinquent': json['delinquent'],
+        'inCollection': json['inCollection'],
+        'overLimit': json['overLimit'],
+        'writtenOff': json['writtenOff'],
+        'creditBalance': json['creditBalance'],
+        'paymentCoupon': json['paymentCoupon'],
+        'retirementPlan': json['retirementPlan'],
+        'retPlanOwnedByDeceased': json['retPlanOwnedByDeceased'],
+        'approved': json['approved'] == null ? undefined : json['approved'],
+        'notApproved': json['notApproved'] == null ? undefined : json['notApproved'],
+        'deleted': json['deleted'] == null ? undefined : json['deleted'],
+        'verified': json['verified'] == null ? undefined : json['verified'],
+    };
+}
+export function AccountStatus2ToJSON(json) {
+    return AccountStatus2ToJSONTyped(json, false);
+}
+export function AccountStatus2ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'open': value['open'],
+        'closed': value['closed'],
+        'negativeBalance': value['negativeBalance'],
+        'delinquent': value['delinquent'],
+        'inCollection': value['inCollection'],
+        'overLimit': value['overLimit'],
+        'writtenOff': value['writtenOff'],
+        'creditBalance': value['creditBalance'],
+        'paymentCoupon': value['paymentCoupon'],
+        'retirementPlan': value['retirementPlan'],
+        'retPlanOwnedByDeceased': value['retPlanOwnedByDeceased'],
+        'approved': value['approved'],
+        'notApproved': value['notApproved'],
+        'deleted': value['deleted'],
+        'verified': value['verified'],
+    };
+}
+//# sourceMappingURL=AccountStatus2.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountStatus2.js","sourceRoot":"","sources":["../../../../generated/src/models/AccountStatus2.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAgHH;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAa;IAClD,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpE,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,CAAC,iBAAiB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC1F,IAAI,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChF,IAAI,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpF,IAAI,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC9E,IAAI,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChF,IAAI,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtF,IAAI,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtF,IAAI,CAAC,CAAC,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxF,IAAI,CAAC,CAAC,wBAAwB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxG,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAS;IAC5C,OAAO,2BAA2B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,IAAS,EAAE,mBAA4B;IAC/E,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QACpB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC;QAC1C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAChC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC;QACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;QAC9B,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAChC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QACtC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QACtC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC;QACxC,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC;QACxD,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QAChE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;KACtE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAS;IAC1C,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAA6B,EAAE,sBAA+B,KAAK;IACzG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;QAC3C,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;QACrC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,wBAAwB,EAAE,KAAK,CAAC,wBAAwB,CAAC;QACzD,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;QAC3B,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;KAChC,CAAC;AACN,CAAC"}