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

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

@@ -0,0 +1,48 @@
+/**
+ * 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 { EntitledFeature } from './EntitledFeature.js';
+import type { AccountEntitledFeature } from './AccountEntitledFeature.js';
+/**
+ * Represents the entitlements and associated limits for a business. Contains feature-level entitlements with transaction limits and account-level entitlements organized by business TINs.
+ *
+ * @export
+ * @interface BusinessEntitlementsLimits
+ */
+export interface BusinessEntitlementsLimits {
+    /**
+     *
+     * @type {AccountEntitledFeature}
+     * @memberof BusinessEntitlementsLimits
+     */
+    accountEntitledFeature?: AccountEntitledFeature;
+    /**
+     * List of entitled features with their associated transaction limits for the business
+     *
+     * @type {Array<EntitledFeature>}
+     * @memberof BusinessEntitlementsLimits
+     */
+    entitledFeatures: Array<EntitledFeature>;
+    /**
+     * List of SEC codes available for ACH transactions
+     * @type {Array<string>}
+     * @memberof BusinessEntitlementsLimits
+     */
+    secCodes?: Array<string>;
+}
+/**
+ * Check if a given object implements the BusinessEntitlementsLimits interface.
+ */
+export declare function instanceOfBusinessEntitlementsLimits(value: object): value is BusinessEntitlementsLimits;
+export declare function BusinessEntitlementsLimitsFromJSON(json: any): BusinessEntitlementsLimits;
+export declare function BusinessEntitlementsLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BusinessEntitlementsLimits;
+export declare function BusinessEntitlementsLimitsToJSON(json: any): BusinessEntitlementsLimits;
+export declare function BusinessEntitlementsLimitsToJSONTyped(value?: BusinessEntitlementsLimits | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,49 @@
+/* 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 { EntitledFeatureFromJSON, EntitledFeatureToJSON, } from './EntitledFeature.js';
+import { AccountEntitledFeatureFromJSON, AccountEntitledFeatureToJSON, } from './AccountEntitledFeature.js';
+/**
+ * Check if a given object implements the BusinessEntitlementsLimits interface.
+ */
+export function instanceOfBusinessEntitlementsLimits(value) {
+    if (!('entitledFeatures' in value) || value['entitledFeatures'] === undefined)
+        return false;
+    return true;
+}
+export function BusinessEntitlementsLimitsFromJSON(json) {
+    return BusinessEntitlementsLimitsFromJSONTyped(json, false);
+}
+export function BusinessEntitlementsLimitsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accountEntitledFeature': json['accountEntitledFeature'] == null ? undefined : AccountEntitledFeatureFromJSON(json['accountEntitledFeature']),
+        'entitledFeatures': (json['entitledFeatures'].map(EntitledFeatureFromJSON)),
+        'secCodes': json['secCodes'] == null ? undefined : json['secCodes'],
+    };
+}
+export function BusinessEntitlementsLimitsToJSON(json) {
+    return BusinessEntitlementsLimitsToJSONTyped(json, false);
+}
+export function BusinessEntitlementsLimitsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'accountEntitledFeature': AccountEntitledFeatureToJSON(value['accountEntitledFeature']),
+        'entitledFeatures': (value['entitledFeatures'].map(EntitledFeatureToJSON)),
+        'secCodes': value['secCodes'],
+    };
+}

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

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+/**
+ * Configuration settings for business banking registration, including available online features and additional services that can be selected during the registration process
+ *
+ * @export
+ * @interface BusinessRegistrationConfig
+ */
+export interface BusinessRegistrationConfig {
+    /**
+     * List of additional services available for selection during registration. These are supplementary services beyond core online banking features.
+     *
+     * @type {Array<string>}
+     * @memberof BusinessRegistrationConfig
+     */
+    additionalServices?: Array<string>;
+    /**
+     * List of online banking features available for selection during registration. Common features include ACH, Wire Transfer, Bill Pay, Positive Pay, etc.
+     *
+     * @type {Array<string>}
+     * @memberof BusinessRegistrationConfig
+     */
+    onlineFeatures: Array<string>;
+}
+/**
+ * Check if a given object implements the BusinessRegistrationConfig interface.
+ */
+export declare function instanceOfBusinessRegistrationConfig(value: object): value is BusinessRegistrationConfig;
+export declare function BusinessRegistrationConfigFromJSON(json: any): BusinessRegistrationConfig;
+export declare function BusinessRegistrationConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): BusinessRegistrationConfig;
+export declare function BusinessRegistrationConfigToJSON(json: any): BusinessRegistrationConfig;
+export declare function BusinessRegistrationConfigToJSONTyped(value?: BusinessRegistrationConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/BusinessRegistrationConfig.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 BusinessRegistrationConfig interface.
+ */
+export function instanceOfBusinessRegistrationConfig(value) {
+    if (!('onlineFeatures' in value) || value['onlineFeatures'] === undefined)
+        return false;
+    return true;
+}
+export function BusinessRegistrationConfigFromJSON(json) {
+    return BusinessRegistrationConfigFromJSONTyped(json, false);
+}
+export function BusinessRegistrationConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'additionalServices': json['additionalServices'] == null ? undefined : json['additionalServices'],
+        'onlineFeatures': json['onlineFeatures'],
+    };
+}
+export function BusinessRegistrationConfigToJSON(json) {
+    return BusinessRegistrationConfigToJSONTyped(json, false);
+}
+export function BusinessRegistrationConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'additionalServices': value['additionalServices'],
+        'onlineFeatures': value['onlineFeatures'],
+    };
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+/**
+ * Tax Identification Number (TIN) information for a business banking registration including TIN number, name, member number, and primary indicator
+ *
+ * @export
+ * @interface BusinessTinInfo
+ */
+export interface BusinessTinInfo {
+    /**
+     * Host system password for authentication (encrypted)
+     * @type {string}
+     * @memberof BusinessTinInfo
+     */
+    hostPassword?: string;
+    /**
+     * Member number associated with this TIN at the financial institution
+     * @type {string}
+     * @memberof BusinessTinInfo
+     */
+    memberNumber?: string;
+    /**
+     * Indicates if this is the primary TIN for the business
+     * @type {boolean}
+     * @memberof BusinessTinInfo
+     */
+    primary?: boolean;
+    /**
+     * Name associated with the TIN (business name or DBA)
+     * @type {string}
+     * @memberof BusinessTinInfo
+     */
+    tinName: string;
+    /**
+     * Tax Identification Number (9-digit EIN or SSN)
+     * @type {string}
+     * @memberof BusinessTinInfo
+     */
+    tinNumber: string;
+}
+/**
+ * Check if a given object implements the BusinessTinInfo interface.
+ */
+export declare function instanceOfBusinessTinInfo(value: object): value is BusinessTinInfo;
+export declare function BusinessTinInfoFromJSON(json: any): BusinessTinInfo;
+export declare function BusinessTinInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): BusinessTinInfo;
+export declare function BusinessTinInfoToJSON(json: any): BusinessTinInfo;
+export declare function BusinessTinInfoToJSONTyped(value?: BusinessTinInfo | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,53 @@
+/* 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 BusinessTinInfo interface.
+ */
+export function instanceOfBusinessTinInfo(value) {
+    if (!('tinName' in value) || value['tinName'] === undefined)
+        return false;
+    if (!('tinNumber' in value) || value['tinNumber'] === undefined)
+        return false;
+    return true;
+}
+export function BusinessTinInfoFromJSON(json) {
+    return BusinessTinInfoFromJSONTyped(json, false);
+}
+export function BusinessTinInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'hostPassword': json['hostPassword'] == null ? undefined : json['hostPassword'],
+        'memberNumber': json['memberNumber'] == null ? undefined : json['memberNumber'],
+        'primary': json['primary'] == null ? undefined : json['primary'],
+        'tinName': json['tinName'],
+        'tinNumber': json['tinNumber'],
+    };
+}
+export function BusinessTinInfoToJSON(json) {
+    return BusinessTinInfoToJSONTyped(json, false);
+}
+export function BusinessTinInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'hostPassword': value['hostPassword'],
+        'memberNumber': value['memberNumber'],
+        'primary': value['primary'],
+        'tinName': value['tinName'],
+        'tinNumber': value['tinNumber'],
+    };
+}

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

@@ -0,0 +1,94 @@
+/**
+ * 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 { ContactMethod1 } from './ContactMethod1.js';
+/**
+ * Business user details including personal information, role, status, and contact methods
+ *
+ * @export
+ * @interface BusinessUser
+ */
+export interface BusinessUser {
+    /**
+     * List of contact methods associated with the user (phone, email, SMS, etc.)
+     *
+     * @type {Array<ContactMethod1>}
+     * @memberof BusinessUser
+     */
+    contactMethods?: Array<ContactMethod1>;
+    /**
+     * Primary email address of the business user
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    email: string;
+    /**
+     * First name of the business user
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    firstName: string;
+    /**
+     * Last name of the business user
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    lastName: string;
+    /**
+     * Login identifier used for authentication. Typically the user's email address.
+     *
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    loginId?: string;
+    /**
+     * Middle name of the business user
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    middleName?: string;
+    /**
+     * Role of the user within the business organization
+     * @type {BusinessUserRoleEnum}
+     * @memberof BusinessUser
+     */
+    role: BusinessUserRoleEnum;
+    /**
+     * Current status of the business user account
+     * @type {string}
+     * @memberof BusinessUser
+     */
+    status: string;
+    /**
+     * Indicates if there are pending updates for this user that require approval
+     *
+     * @type {boolean}
+     * @memberof BusinessUser
+     */
+    updatePending?: boolean;
+}
+/**
+ * @export
+ */
+export declare const BusinessUserRoleEnum: {
+    readonly PRIMARY_ADMIN: "PRIMARY_ADMIN";
+    readonly SECONDARY_ADMIN: "SECONDARY_ADMIN";
+    readonly BUSINESS_USER: "BUSINESS_USER";
+};
+export type BusinessUserRoleEnum = typeof BusinessUserRoleEnum[keyof typeof BusinessUserRoleEnum];
+/**
+ * Check if a given object implements the BusinessUser interface.
+ */
+export declare function instanceOfBusinessUser(value: object): value is BusinessUser;
+export declare function BusinessUserFromJSON(json: any): BusinessUser;
+export declare function BusinessUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): BusinessUser;
+export declare function BusinessUserToJSON(json: any): BusinessUser;
+export declare function BusinessUserToJSONTyped(value?: BusinessUser | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,76 @@
+/* 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 { ContactMethod1FromJSON, ContactMethod1ToJSON, } from './ContactMethod1.js';
+/**
+ * @export
+ */
+export const BusinessUserRoleEnum = {
+    PRIMARY_ADMIN: 'PRIMARY_ADMIN',
+    SECONDARY_ADMIN: 'SECONDARY_ADMIN',
+    BUSINESS_USER: 'BUSINESS_USER'
+};
+/**
+ * Check if a given object implements the BusinessUser interface.
+ */
+export function instanceOfBusinessUser(value) {
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function BusinessUserFromJSON(json) {
+    return BusinessUserFromJSONTyped(json, false);
+}
+export function BusinessUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'contactMethods': json['contactMethods'] == null ? undefined : (json['contactMethods'].map(ContactMethod1FromJSON)),
+        'email': json['email'],
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'loginId': json['loginId'] == null ? undefined : json['loginId'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'role': json['role'],
+        'status': json['status'],
+        'updatePending': json['updatePending'] == null ? undefined : json['updatePending'],
+    };
+}
+export function BusinessUserToJSON(json) {
+    return BusinessUserToJSONTyped(json, false);
+}
+export function BusinessUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'contactMethods': value['contactMethods'] == null ? undefined : (value['contactMethods'].map(ContactMethod1ToJSON)),
+        'email': value['email'],
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'loginId': value['loginId'],
+        'middleName': value['middleName'],
+        'role': value['role'],
+        'status': value['status'],
+        'updatePending': value['updatePending'],
+    };
+}

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

@@ -0,0 +1,87 @@
+/**
+ * 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 { TimeZone } from './TimeZone.js';
+/**
+ *
+ * @export
+ * @interface Calendar
+ */
+export interface Calendar {
+    /**
+     *
+     * @type {string}
+     * @memberof Calendar
+     */
+    calendarType?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Calendar
+     */
+    firstDayOfWeek?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Calendar
+     */
+    lenient?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Calendar
+     */
+    minimalDaysInFirstWeek?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof Calendar
+     */
+    time?: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof Calendar
+     */
+    timeInMillis?: number;
+    /**
+     *
+     * @type {TimeZone}
+     * @memberof Calendar
+     */
+    timeZone?: TimeZone;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Calendar
+     */
+    weekDateSupported?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Calendar
+     */
+    weekYear?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Calendar
+     */
+    weeksInWeekYear?: number;
+}
+/**
+ * Check if a given object implements the Calendar interface.
+ */
+export declare function instanceOfCalendar(value: object): value is Calendar;
+export declare function CalendarFromJSON(json: any): Calendar;
+export declare function CalendarFromJSONTyped(json: any, ignoreDiscriminator: boolean): Calendar;
+export declare function CalendarToJSON(json: any): Calendar;
+export declare function CalendarToJSONTyped(value?: Calendar | null, ignoreDiscriminator?: boolean): any;