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

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

@@ -0,0 +1,80 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EventDetails
+ */
+export interface EventDetails {
+    /**
+     *
+     * @type {object}
+     * @memberof EventDetails
+     */
+    additionalInfo?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof EventDetails
+     */
+    eventId?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof EventDetails
+     */
+    eventNoticed?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof EventDetails
+     */
+    eventOccured?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof EventDetails
+     */
+    eventSource?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof EventDetails
+     */
+    eventTags?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof EventDetails
+     */
+    eventType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventDetails
+     */
+    institutionCustomerId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventDetails
+     */
+    institutionId?: string;
+}
+/**
+ * Check if a given object implements the EventDetails interface.
+ */
+export declare function instanceOfEventDetails(value: object): value is EventDetails;
+export declare function EventDetailsFromJSON(json: any): EventDetails;
+export declare function EventDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventDetails;
+export declare function EventDetailsToJSON(json: any): EventDetails;
+export declare function EventDetailsToJSONTyped(value?: EventDetails | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the EventDetails interface.
+ */
+export function instanceOfEventDetails(value) {
+    return true;
+}
+export function EventDetailsFromJSON(json) {
+    return EventDetailsFromJSONTyped(json, false);
+}
+export function EventDetailsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'additionalInfo': json['additionalInfo'] == null ? undefined : json['additionalInfo'],
+        'eventId': json['eventId'] == null ? undefined : json['eventId'],
+        'eventNoticed': json['eventNoticed'] == null ? undefined : (new Date(json['eventNoticed'])),
+        'eventOccured': json['eventOccured'] == null ? undefined : (new Date(json['eventOccured'])),
+        'eventSource': json['eventSource'] == null ? undefined : json['eventSource'],
+        'eventTags': json['eventTags'] == null ? undefined : json['eventTags'],
+        'eventType': json['eventType'] == null ? undefined : json['eventType'],
+        'institutionCustomerId': json['institutionCustomerId'] == null ? undefined : json['institutionCustomerId'],
+        'institutionId': json['institutionId'] == null ? undefined : json['institutionId'],
+    };
+}
+export function EventDetailsToJSON(json) {
+    return EventDetailsToJSONTyped(json, false);
+}
+export function EventDetailsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'additionalInfo': value['additionalInfo'],
+        'eventId': value['eventId'],
+        'eventNoticed': value['eventNoticed'] == null ? value['eventNoticed'] : value['eventNoticed'].toISOString(),
+        'eventOccured': value['eventOccured'] == null ? value['eventOccured'] : value['eventOccured'].toISOString(),
+        'eventSource': value['eventSource'],
+        'eventTags': value['eventTags'],
+        'eventType': value['eventType'],
+        'institutionCustomerId': value['institutionCustomerId'],
+        'institutionId': value['institutionId'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Event1 } from './Event1.js';
+/**
+ *
+ * @export
+ * @interface Events
+ */
+export interface Events {
+    /**
+     * Event
+     * @type {Array<Event1>}
+     * @memberof Events
+     */
+    event?: Array<Event1>;
+}
+/**
+ * Check if a given object implements the Events interface.
+ */
+export declare function instanceOfEvents(value: object): value is Events;
+export declare function EventsFromJSON(json: any): Events;
+export declare function EventsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Events;
+export declare function EventsToJSON(json: any): Events;
+export declare function EventsToJSONTyped(value?: Events | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Event1FromJSON, Event1ToJSON, } from './Event1.js';
+/**
+ * Check if a given object implements the Events interface.
+ */
+export function instanceOfEvents(value) {
+    return true;
+}
+export function EventsFromJSON(json) {
+    return EventsFromJSONTyped(json, false);
+}
+export function EventsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'event': json['Event'] == null ? undefined : (json['Event'].map(Event1FromJSON)),
+    };
+}
+export function EventsToJSON(json) {
+    return EventsToJSONTyped(json, false);
+}
+export function EventsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'Event': value['event'] == null ? undefined : (value['event'].map(Event1ToJSON)),
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FIAccountType
+ */
+export interface FIAccountType {
+    /**
+     *
+     * @type {string}
+     * @memberof FIAccountType
+     */
+    description?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FIAccountType
+     */
+    rawType?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof FIAccountType
+     */
+    type?: number;
+}
+/**
+ * Check if a given object implements the FIAccountType interface.
+ */
+export declare function instanceOfFIAccountType(value: object): value is FIAccountType;
+export declare function FIAccountTypeFromJSON(json: any): FIAccountType;
+export declare function FIAccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FIAccountType;
+export declare function FIAccountTypeToJSON(json: any): FIAccountType;
+export declare function FIAccountTypeToJSONTyped(value?: FIAccountType | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the FIAccountType interface.
+ */
+export function instanceOfFIAccountType(value) {
+    return true;
+}
+export function FIAccountTypeFromJSON(json) {
+    return FIAccountTypeFromJSONTyped(json, false);
+}
+export function FIAccountTypeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'description': json['description'] == null ? undefined : json['description'],
+        'rawType': json['rawType'] == null ? undefined : json['rawType'],
+        'type': json['type'] == null ? undefined : json['type'],
+    };
+}
+export function FIAccountTypeToJSON(json) {
+    return FIAccountTypeToJSONTyped(json, false);
+}
+export function FIAccountTypeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'description': value['description'],
+        'rawType': value['rawType'],
+        'type': value['type'],
+    };
+}

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

@@ -0,0 +1,167 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { FICustomerId } from './FICustomerId.js';
+import type { Credential } from './Credential.js';
+import type { MfaCookie } from './MfaCookie.js';
+import type { ProductUserInfo } from './ProductUserInfo.js';
+import type { ChallengeQuestionInfo } from './ChallengeQuestionInfo.js';
+import type { ProductAppUserInfos } from './ProductAppUserInfos.js';
+import type { Person } from './Person.js';
+import type { ChannelInfos } from './ChannelInfos.js';
+import type { IdType } from './IdType.js';
+/**
+ *
+ * @export
+ * @interface FICustomer
+ */
+export interface FICustomer {
+    /**
+     *
+     * @type {Credential}
+     * @memberof FICustomer
+     */
+    billPayCredential?: Credential;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FICustomer
+     */
+    billPayEnabled?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    billPayRegStatus?: string;
+    /**
+     *
+     * @type {ChallengeQuestionInfo}
+     * @memberof FICustomer
+     */
+    challengeQuestionInfo?: ChallengeQuestionInfo;
+    /**
+     *
+     * @type {ChannelInfos}
+     * @memberof FICustomer
+     */
+    channelInfos?: ChannelInfos;
+    /**
+     *
+     * @type {IdType}
+     * @memberof FICustomer
+     */
+    fiId?: IdType;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    historyRange?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    historySortOrder?: string;
+    /**
+     *
+     * @type {Credential}
+     * @memberof FICustomer
+     */
+    hostCredential?: Credential;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    ibStartupPage?: string;
+    /**
+     *
+     * @type {FICustomerId}
+     * @memberof FICustomer
+     */
+    id?: FICustomerId;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    lastMobileLoginDateTime?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    lastSRTDateTime?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    memberHoldDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    memberHoldDesc?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    memberNumber?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    memberRegistrationDate?: string;
+    /**
+     *
+     * @type {Array<MfaCookie>}
+     * @memberof FICustomer
+     */
+    mfaCookies?: Array<MfaCookie>;
+    /**
+     *
+     * @type {string}
+     * @memberof FICustomer
+     */
+    name?: string;
+    /**
+     *
+     * @type {Person}
+     * @memberof FICustomer
+     */
+    person?: Person;
+    /**
+     *
+     * @type {ProductAppUserInfos}
+     * @memberof FICustomer
+     */
+    productAppUserInfos?: ProductAppUserInfos;
+    /**
+     *
+     * @type {ProductUserInfo}
+     * @memberof FICustomer
+     */
+    productUserInfo?: ProductUserInfo;
+}
+/**
+ * Check if a given object implements the FICustomer interface.
+ */
+export declare function instanceOfFICustomer(value: object): value is FICustomer;
+export declare function FICustomerFromJSON(json: any): FICustomer;
+export declare function FICustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean): FICustomer;
+export declare function FICustomerToJSON(json: any): FICustomer;
+export declare function FICustomerToJSONTyped(value?: FICustomer | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/FICustomer.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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FICustomerIdFromJSON, FICustomerIdToJSON, } from './FICustomerId.js';
+import { CredentialFromJSON, CredentialToJSON, } from './Credential.js';
+import { MfaCookieFromJSON, MfaCookieToJSON, } from './MfaCookie.js';
+import { ProductUserInfoFromJSON, ProductUserInfoToJSON, } from './ProductUserInfo.js';
+import { ChallengeQuestionInfoFromJSON, ChallengeQuestionInfoToJSON, } from './ChallengeQuestionInfo.js';
+import { ProductAppUserInfosFromJSON, ProductAppUserInfosToJSON, } from './ProductAppUserInfos.js';
+import { PersonFromJSON, PersonToJSON, } from './Person.js';
+import { ChannelInfosFromJSON, ChannelInfosToJSON, } from './ChannelInfos.js';
+import { IdTypeFromJSON, IdTypeToJSON, } from './IdType.js';
+/**
+ * Check if a given object implements the FICustomer interface.
+ */
+export function instanceOfFICustomer(value) {
+    return true;
+}
+export function FICustomerFromJSON(json) {
+    return FICustomerFromJSONTyped(json, false);
+}
+export function FICustomerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'billPayCredential': json['billPayCredential'] == null ? undefined : CredentialFromJSON(json['billPayCredential']),
+        'billPayEnabled': json['billPayEnabled'] == null ? undefined : json['billPayEnabled'],
+        'billPayRegStatus': json['billPayRegStatus'] == null ? undefined : json['billPayRegStatus'],
+        'challengeQuestionInfo': json['challengeQuestionInfo'] == null ? undefined : ChallengeQuestionInfoFromJSON(json['challengeQuestionInfo']),
+        'channelInfos': json['channelInfos'] == null ? undefined : ChannelInfosFromJSON(json['channelInfos']),
+        'fiId': json['fiId'] == null ? undefined : IdTypeFromJSON(json['fiId']),
+        'historyRange': json['historyRange'] == null ? undefined : json['historyRange'],
+        'historySortOrder': json['historySortOrder'] == null ? undefined : json['historySortOrder'],
+        'hostCredential': json['hostCredential'] == null ? undefined : CredentialFromJSON(json['hostCredential']),
+        'ibStartupPage': json['ibStartupPage'] == null ? undefined : json['ibStartupPage'],
+        'id': json['id'] == null ? undefined : FICustomerIdFromJSON(json['id']),
+        'lastMobileLoginDateTime': json['lastMobileLoginDateTime'] == null ? undefined : json['lastMobileLoginDateTime'],
+        'lastSRTDateTime': json['lastSRTDateTime'] == null ? undefined : json['lastSRTDateTime'],
+        'memberHoldDate': json['memberHoldDate'] == null ? undefined : json['memberHoldDate'],
+        'memberHoldDesc': json['memberHoldDesc'] == null ? undefined : json['memberHoldDesc'],
+        'memberNumber': json['memberNumber'] == null ? undefined : json['memberNumber'],
+        'memberRegistrationDate': json['memberRegistrationDate'] == null ? undefined : json['memberRegistrationDate'],
+        'mfaCookies': json['mfaCookies'] == null ? undefined : (json['mfaCookies'].map(MfaCookieFromJSON)),
+        'name': json['name'] == null ? undefined : json['name'],
+        'person': json['person'] == null ? undefined : PersonFromJSON(json['person']),
+        'productAppUserInfos': json['productAppUserInfos'] == null ? undefined : ProductAppUserInfosFromJSON(json['productAppUserInfos']),
+        'productUserInfo': json['productUserInfo'] == null ? undefined : ProductUserInfoFromJSON(json['productUserInfo']),
+    };
+}
+export function FICustomerToJSON(json) {
+    return FICustomerToJSONTyped(json, false);
+}
+export function FICustomerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'billPayCredential': CredentialToJSON(value['billPayCredential']),
+        'billPayEnabled': value['billPayEnabled'],
+        'billPayRegStatus': value['billPayRegStatus'],
+        'challengeQuestionInfo': ChallengeQuestionInfoToJSON(value['challengeQuestionInfo']),
+        'channelInfos': ChannelInfosToJSON(value['channelInfos']),
+        'fiId': IdTypeToJSON(value['fiId']),
+        'historyRange': value['historyRange'],
+        'historySortOrder': value['historySortOrder'],
+        'hostCredential': CredentialToJSON(value['hostCredential']),
+        'ibStartupPage': value['ibStartupPage'],
+        'id': FICustomerIdToJSON(value['id']),
+        'lastMobileLoginDateTime': value['lastMobileLoginDateTime'],
+        'lastSRTDateTime': value['lastSRTDateTime'],
+        'memberHoldDate': value['memberHoldDate'],
+        'memberHoldDesc': value['memberHoldDesc'],
+        'memberNumber': value['memberNumber'],
+        'memberRegistrationDate': value['memberRegistrationDate'],
+        'mfaCookies': value['mfaCookies'] == null ? undefined : (value['mfaCookies'].map(MfaCookieToJSON)),
+        'name': value['name'],
+        'person': PersonToJSON(value['person']),
+        'productAppUserInfos': ProductAppUserInfosToJSON(value['productAppUserInfos']),
+        'productUserInfo': ProductUserInfoToJSON(value['productUserInfo']),
+    };
+}