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

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

@@ -0,0 +1,218 @@
+/**
+ * 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 { AccountStatus } from './AccountStatus.js';
+import type { Money } from './Money.js';
+import type { Actions } from './Actions.js';
+import type { AccountCategory } from './AccountCategory.js';
+import type { Term } from './Term.js';
+import type { AccountType } from './AccountType.js';
+/**
+ *
+ * @export
+ * @interface Account
+ */
+export interface Account {
+    /**
+     * Unique Account Identifier (encrypted key identifier)
+     * @type {string}
+     * @memberof Account
+     */
+    id?: string;
+    /**
+     * Description of account
+     * @type {string}
+     * @memberof Account
+     */
+    description?: string;
+    /**
+     * Unique user identifier
+     * @type {string}
+     * @memberof Account
+     */
+    institutionUserId?: string;
+    /**
+     * Financial Institution id this account is associated with
+     * @type {string}
+     * @memberof Account
+     */
+    institutionId?: string;
+    /**
+     * Last 4 digits of the account number.
+     * @type {string}
+     * @memberof Account
+     */
+    accountNumber?: string;
+    /**
+     * Account nickname
+     * @type {string}
+     * @memberof Account
+     */
+    nickName?: string;
+    /**
+     *
+     * @type {AccountType}
+     * @memberof Account
+     */
+    type?: AccountType;
+    /**
+     *
+     * @type {AccountCategory}
+     * @memberof Account
+     */
+    category?: AccountCategory;
+    /**
+     * Primary account holder name (OR) Cross member/customer name from host
+     * @type {string}
+     * @memberof Account
+     */
+    primaryHolderName?: string;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    currentBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    availableBalance?: Money;
+    /**
+     *
+     * @type {AccountStatus}
+     * @memberof Account
+     */
+    status?: AccountStatus;
+    /**
+     *
+     * @type {Actions}
+     * @memberof Account
+     */
+    allowedActions?: Actions;
+    /**
+     * Routing number of the account.
+     * @type {string}
+     * @memberof Account
+     */
+    routingNumber?: string;
+    /**
+     * Interest rate.
+     * @type {number}
+     * @memberof Account
+     */
+    interestRate?: number;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    interestYearToDate?: Money;
+    /**
+     * MICR number for this account, returned only if known.
+     * @type {string}
+     * @memberof Account
+     */
+    micrNumber?: string;
+    /**
+     * Maturity date
+     * @type {Date}
+     * @memberof Account
+     */
+    maturityDate?: Date;
+    /**
+     *
+     * @type {Term}
+     * @memberof Account
+     */
+    term?: Term;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    escrowBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    currentPrincipalBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    nextPaymentAmount?: Money;
+    /**
+     * Next payment date
+     * @type {Date}
+     * @memberof Account
+     */
+    nextPaymentDate?: Date;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    payOffAmount?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    minimumPayment?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    lineOfCreditLimit?: Money;
+    /**
+     * Loan origination date
+     * @type {object}
+     * @memberof Account
+     */
+    loanOriginationDate?: object;
+    /**
+     * Past due date for principal
+     * @type {object}
+     * @memberof Account
+     */
+    pastPrincipalDueDate?: object;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    lastPrincipalPaymentAmount?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account
+     */
+    originalLoanAmount?: Money;
+    /**
+     * Institution customer ID associated with this account (populated for business banking users)
+     * @type {string}
+     * @memberof Account
+     */
+    institutionCustomerId?: string;
+}
+/**
+ * Check if a given object implements the Account interface.
+ */
+export declare function instanceOfAccount(value: object): value is Account;
+export declare function AccountFromJSON(json: any): Account;
+export declare function AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): Account;
+export declare function AccountToJSON(json: any): Account;
+export declare function AccountToJSONTyped(value?: Account | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,107 @@
+/* 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 { AccountStatusFromJSON, AccountStatusToJSON, } from './AccountStatus.js';
+import { MoneyFromJSON, MoneyToJSON, } from './Money.js';
+import { ActionsFromJSON, ActionsToJSON, } from './Actions.js';
+import { AccountCategoryFromJSON, AccountCategoryToJSON, } from './AccountCategory.js';
+import { TermFromJSON, TermToJSON, } from './Term.js';
+import { AccountTypeFromJSON, AccountTypeToJSON, } from './AccountType.js';
+/**
+ * Check if a given object implements the Account interface.
+ */
+export function instanceOfAccount(value) {
+    return true;
+}
+export function AccountFromJSON(json) {
+    return AccountFromJSONTyped(json, false);
+}
+export function AccountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'institutionUserId': json['institutionUserId'] == null ? undefined : json['institutionUserId'],
+        'institutionId': json['institutionId'] == null ? undefined : json['institutionId'],
+        'accountNumber': json['accountNumber'] == null ? undefined : json['accountNumber'],
+        'nickName': json['nickName'] == null ? undefined : json['nickName'],
+        'type': json['type'] == null ? undefined : AccountTypeFromJSON(json['type']),
+        'category': json['category'] == null ? undefined : AccountCategoryFromJSON(json['category']),
+        'primaryHolderName': json['primaryHolderName'] == null ? undefined : json['primaryHolderName'],
+        'currentBalance': json['currentBalance'] == null ? undefined : MoneyFromJSON(json['currentBalance']),
+        'availableBalance': json['availableBalance'] == null ? undefined : MoneyFromJSON(json['availableBalance']),
+        'status': json['status'] == null ? undefined : AccountStatusFromJSON(json['status']),
+        'allowedActions': json['allowedActions'] == null ? undefined : ActionsFromJSON(json['allowedActions']),
+        'routingNumber': json['routingNumber'] == null ? undefined : json['routingNumber'],
+        'interestRate': json['interestRate'] == null ? undefined : json['interestRate'],
+        'interestYearToDate': json['interestYearToDate'] == null ? undefined : MoneyFromJSON(json['interestYearToDate']),
+        'micrNumber': json['micrNumber'] == null ? undefined : json['micrNumber'],
+        'maturityDate': json['maturityDate'] == null ? undefined : (new Date(json['maturityDate'])),
+        'term': json['term'] == null ? undefined : TermFromJSON(json['term']),
+        'escrowBalance': json['escrowBalance'] == null ? undefined : MoneyFromJSON(json['escrowBalance']),
+        'currentPrincipalBalance': json['currentPrincipalBalance'] == null ? undefined : MoneyFromJSON(json['currentPrincipalBalance']),
+        'nextPaymentAmount': json['nextPaymentAmount'] == null ? undefined : MoneyFromJSON(json['nextPaymentAmount']),
+        'nextPaymentDate': json['nextPaymentDate'] == null ? undefined : (new Date(json['nextPaymentDate'])),
+        'payOffAmount': json['payOffAmount'] == null ? undefined : MoneyFromJSON(json['payOffAmount']),
+        'minimumPayment': json['minimumPayment'] == null ? undefined : MoneyFromJSON(json['minimumPayment']),
+        'lineOfCreditLimit': json['lineOfCreditLimit'] == null ? undefined : MoneyFromJSON(json['lineOfCreditLimit']),
+        'loanOriginationDate': json['loanOriginationDate'] == null ? undefined : json['loanOriginationDate'],
+        'pastPrincipalDueDate': json['pastPrincipalDueDate'] == null ? undefined : json['pastPrincipalDueDate'],
+        'lastPrincipalPaymentAmount': json['lastPrincipalPaymentAmount'] == null ? undefined : MoneyFromJSON(json['lastPrincipalPaymentAmount']),
+        'originalLoanAmount': json['originalLoanAmount'] == null ? undefined : MoneyFromJSON(json['originalLoanAmount']),
+        'institutionCustomerId': json['institutionCustomerId'] == null ? undefined : json['institutionCustomerId'],
+    };
+}
+export function AccountToJSON(json) {
+    return AccountToJSONTyped(json, false);
+}
+export function AccountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'description': value['description'],
+        'institutionUserId': value['institutionUserId'],
+        'institutionId': value['institutionId'],
+        'accountNumber': value['accountNumber'],
+        'nickName': value['nickName'],
+        'type': AccountTypeToJSON(value['type']),
+        'category': AccountCategoryToJSON(value['category']),
+        'primaryHolderName': value['primaryHolderName'],
+        'currentBalance': MoneyToJSON(value['currentBalance']),
+        'availableBalance': MoneyToJSON(value['availableBalance']),
+        'status': AccountStatusToJSON(value['status']),
+        'allowedActions': ActionsToJSON(value['allowedActions']),
+        'routingNumber': value['routingNumber'],
+        'interestRate': value['interestRate'],
+        'interestYearToDate': MoneyToJSON(value['interestYearToDate']),
+        'micrNumber': value['micrNumber'],
+        'maturityDate': value['maturityDate'] == null ? value['maturityDate'] : value['maturityDate'].toISOString().substring(0, 10),
+        'term': TermToJSON(value['term']),
+        'escrowBalance': MoneyToJSON(value['escrowBalance']),
+        'currentPrincipalBalance': MoneyToJSON(value['currentPrincipalBalance']),
+        'nextPaymentAmount': MoneyToJSON(value['nextPaymentAmount']),
+        'nextPaymentDate': value['nextPaymentDate'] == null ? value['nextPaymentDate'] : value['nextPaymentDate'].toISOString().substring(0, 10),
+        'payOffAmount': MoneyToJSON(value['payOffAmount']),
+        'minimumPayment': MoneyToJSON(value['minimumPayment']),
+        'lineOfCreditLimit': MoneyToJSON(value['lineOfCreditLimit']),
+        'loanOriginationDate': value['loanOriginationDate'],
+        'pastPrincipalDueDate': value['pastPrincipalDueDate'],
+        'lastPrincipalPaymentAmount': MoneyToJSON(value['lastPrincipalPaymentAmount']),
+        'originalLoanAmount': MoneyToJSON(value['originalLoanAmount']),
+        'institutionCustomerId': value['institutionCustomerId'],
+    };
+}

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

@@ -0,0 +1,206 @@
+/**
+ * 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 { AccountStatus } from './AccountStatus.js';
+import type { Money } from './Money.js';
+import type { Actions1 } from './Actions1.js';
+import type { AccountType1 } from './AccountType1.js';
+import type { AccountCategory } from './AccountCategory.js';
+import type { Term } from './Term.js';
+/**
+ *
+ * @export
+ * @interface Account1
+ */
+export interface Account1 {
+    /**
+     * Unique Account Identifier (encrypted key identifier)
+     * @type {string}
+     * @memberof Account1
+     */
+    id?: string;
+    /**
+     * Description of account
+     * @type {string}
+     * @memberof Account1
+     */
+    description?: string;
+    /**
+     * Unique user identifier
+     * @type {string}
+     * @memberof Account1
+     */
+    institutionUserId?: string;
+    /**
+     * Financial Institution id this account is associated with
+     * @type {string}
+     * @memberof Account1
+     */
+    institutionId?: string;
+    /**
+     * Last 4 digits of the account number.
+     * @type {string}
+     * @memberof Account1
+     */
+    accountNumber?: string;
+    /**
+     * Account nickname
+     * @type {string}
+     * @memberof Account1
+     */
+    nickName?: string;
+    /**
+     *
+     * @type {AccountType1}
+     * @memberof Account1
+     */
+    type?: AccountType1;
+    /**
+     *
+     * @type {AccountCategory}
+     * @memberof Account1
+     */
+    category?: AccountCategory;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    currentBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    availableBalance?: Money;
+    /**
+     *
+     * @type {AccountStatus}
+     * @memberof Account1
+     */
+    status?: AccountStatus;
+    /**
+     *
+     * @type {Actions1}
+     * @memberof Account1
+     */
+    allowedActions?: Actions1;
+    /**
+     * Routing number of the account.
+     * @type {string}
+     * @memberof Account1
+     */
+    routingNumber?: string;
+    /**
+     * Interest rate.
+     * @type {number}
+     * @memberof Account1
+     */
+    interestRate?: number;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    interestYearToDate?: Money;
+    /**
+     * MICR number for this account, returned only if known.
+     * @type {string}
+     * @memberof Account1
+     */
+    micrNumber?: string;
+    /**
+     * Maturity date
+     * @type {Date}
+     * @memberof Account1
+     */
+    maturityDate?: Date;
+    /**
+     *
+     * @type {Term}
+     * @memberof Account1
+     */
+    term?: Term;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    escrowBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    currentPrincipalBalance?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    nextPaymentAmount?: Money;
+    /**
+     * Next payment date
+     * @type {Date}
+     * @memberof Account1
+     */
+    nextPaymentDate?: Date;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    payOffAmount?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    minimumPayment?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    lineOfCreditLimit?: Money;
+    /**
+     * Loan origination date
+     * @type {any}
+     * @memberof Account1
+     */
+    loanOriginationDate?: any | null;
+    /**
+     * Past due date for principal
+     * @type {any}
+     * @memberof Account1
+     */
+    pastPrincipalDueDate?: any | null;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    lastPrincipalPaymentAmount?: Money;
+    /**
+     *
+     * @type {Money}
+     * @memberof Account1
+     */
+    originalLoanAmount?: Money;
+}
+/**
+ * Check if a given object implements the Account1 interface.
+ */
+export declare function instanceOfAccount1(value: object): value is Account1;
+export declare function Account1FromJSON(json: any): Account1;
+export declare function Account1FromJSONTyped(json: any, ignoreDiscriminator: boolean): Account1;
+export declare function Account1ToJSON(json: any): Account1;
+export declare function Account1ToJSONTyped(value?: Account1 | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,103 @@
+/* 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 { AccountStatusFromJSON, AccountStatusToJSON, } from './AccountStatus.js';
+import { MoneyFromJSON, MoneyToJSON, } from './Money.js';
+import { Actions1FromJSON, Actions1ToJSON, } from './Actions1.js';
+import { AccountType1FromJSON, AccountType1ToJSON, } from './AccountType1.js';
+import { AccountCategoryFromJSON, AccountCategoryToJSON, } from './AccountCategory.js';
+import { TermFromJSON, TermToJSON, } from './Term.js';
+/**
+ * Check if a given object implements the Account1 interface.
+ */
+export function instanceOfAccount1(value) {
+    return true;
+}
+export function Account1FromJSON(json) {
+    return Account1FromJSONTyped(json, false);
+}
+export function Account1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'institutionUserId': json['institutionUserId'] == null ? undefined : json['institutionUserId'],
+        'institutionId': json['institutionId'] == null ? undefined : json['institutionId'],
+        'accountNumber': json['accountNumber'] == null ? undefined : json['accountNumber'],
+        'nickName': json['nickName'] == null ? undefined : json['nickName'],
+        'type': json['type'] == null ? undefined : AccountType1FromJSON(json['type']),
+        'category': json['category'] == null ? undefined : AccountCategoryFromJSON(json['category']),
+        'currentBalance': json['currentBalance'] == null ? undefined : MoneyFromJSON(json['currentBalance']),
+        'availableBalance': json['availableBalance'] == null ? undefined : MoneyFromJSON(json['availableBalance']),
+        'status': json['status'] == null ? undefined : AccountStatusFromJSON(json['status']),
+        'allowedActions': json['allowedActions'] == null ? undefined : Actions1FromJSON(json['allowedActions']),
+        'routingNumber': json['routingNumber'] == null ? undefined : json['routingNumber'],
+        'interestRate': json['interestRate'] == null ? undefined : json['interestRate'],
+        'interestYearToDate': json['interestYearToDate'] == null ? undefined : MoneyFromJSON(json['interestYearToDate']),
+        'micrNumber': json['micrNumber'] == null ? undefined : json['micrNumber'],
+        'maturityDate': json['maturityDate'] == null ? undefined : (new Date(json['maturityDate'])),
+        'term': json['term'] == null ? undefined : TermFromJSON(json['term']),
+        'escrowBalance': json['escrowBalance'] == null ? undefined : MoneyFromJSON(json['escrowBalance']),
+        'currentPrincipalBalance': json['currentPrincipalBalance'] == null ? undefined : MoneyFromJSON(json['currentPrincipalBalance']),
+        'nextPaymentAmount': json['nextPaymentAmount'] == null ? undefined : MoneyFromJSON(json['nextPaymentAmount']),
+        'nextPaymentDate': json['nextPaymentDate'] == null ? undefined : (new Date(json['nextPaymentDate'])),
+        'payOffAmount': json['payOffAmount'] == null ? undefined : MoneyFromJSON(json['payOffAmount']),
+        'minimumPayment': json['minimumPayment'] == null ? undefined : MoneyFromJSON(json['minimumPayment']),
+        'lineOfCreditLimit': json['lineOfCreditLimit'] == null ? undefined : MoneyFromJSON(json['lineOfCreditLimit']),
+        'loanOriginationDate': json['loanOriginationDate'] == null ? undefined : json['loanOriginationDate'],
+        'pastPrincipalDueDate': json['pastPrincipalDueDate'] == null ? undefined : json['pastPrincipalDueDate'],
+        'lastPrincipalPaymentAmount': json['lastPrincipalPaymentAmount'] == null ? undefined : MoneyFromJSON(json['lastPrincipalPaymentAmount']),
+        'originalLoanAmount': json['originalLoanAmount'] == null ? undefined : MoneyFromJSON(json['originalLoanAmount']),
+    };
+}
+export function Account1ToJSON(json) {
+    return Account1ToJSONTyped(json, false);
+}
+export function Account1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'description': value['description'],
+        'institutionUserId': value['institutionUserId'],
+        'institutionId': value['institutionId'],
+        'accountNumber': value['accountNumber'],
+        'nickName': value['nickName'],
+        'type': AccountType1ToJSON(value['type']),
+        'category': AccountCategoryToJSON(value['category']),
+        'currentBalance': MoneyToJSON(value['currentBalance']),
+        'availableBalance': MoneyToJSON(value['availableBalance']),
+        'status': AccountStatusToJSON(value['status']),
+        'allowedActions': Actions1ToJSON(value['allowedActions']),
+        'routingNumber': value['routingNumber'],
+        'interestRate': value['interestRate'],
+        'interestYearToDate': MoneyToJSON(value['interestYearToDate']),
+        'micrNumber': value['micrNumber'],
+        'maturityDate': value['maturityDate'] == null ? value['maturityDate'] : value['maturityDate'].toISOString().substring(0, 10),
+        'term': TermToJSON(value['term']),
+        'escrowBalance': MoneyToJSON(value['escrowBalance']),
+        'currentPrincipalBalance': MoneyToJSON(value['currentPrincipalBalance']),
+        'nextPaymentAmount': MoneyToJSON(value['nextPaymentAmount']),
+        'nextPaymentDate': value['nextPaymentDate'] == null ? value['nextPaymentDate'] : value['nextPaymentDate'].toISOString().substring(0, 10),
+        'payOffAmount': MoneyToJSON(value['payOffAmount']),
+        'minimumPayment': MoneyToJSON(value['minimumPayment']),
+        'lineOfCreditLimit': MoneyToJSON(value['lineOfCreditLimit']),
+        'loanOriginationDate': value['loanOriginationDate'],
+        'pastPrincipalDueDate': value['pastPrincipalDueDate'],
+        'lastPrincipalPaymentAmount': MoneyToJSON(value['lastPrincipalPaymentAmount']),
+        'originalLoanAmount': MoneyToJSON(value['originalLoanAmount']),
+    };
+}