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

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

@@ -0,0 +1,636 @@
+/**
+ * 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 { AccountRefreshStatus } from './AccountRefreshStatus.js';
+import type { FIAccountType } from './FIAccountType.js';
+import type { RegDLimits1 } from './RegDLimits1.js';
+import type { AccountId } from './AccountId.js';
+import type { Money2 } from './Money2.js';
+import type { Calendar } from './Calendar.js';
+import type { Balance1 } from './Balance1.js';
+import type { AccountNumber } from './AccountNumber.js';
+import type { IdType } from './IdType.js';
+import type { AccountTransactions } from './AccountTransactions.js';
+import type { Entitlements } from './Entitlements.js';
+import type { AccountStatuses } from './AccountStatuses.js';
+import type { DisplayFlag } from './DisplayFlag.js';
+/**
+ *
+ * @export
+ * @interface Account3
+ */
+export interface Account3 {
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    accountHidden?: boolean;
+    /**
+     *
+     * @type {AccountNumber}
+     * @memberof Account3
+     */
+    accountNumber?: AccountNumber;
+    /**
+     *
+     * @type {Account3AccountStatusEnum}
+     * @memberof Account3
+     */
+    accountStatus?: Account3AccountStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    accountStatusInt?: number;
+    /**
+     *
+     * @type {AccountStatuses}
+     * @memberof Account3
+     */
+    accountStatuses?: AccountStatuses;
+    /**
+     *
+     * @type {AccountTransactions}
+     * @memberof Account3
+     */
+    accountTransactions?: AccountTransactions;
+    /**
+     *
+     * @type {Account3AccountTypeEnum}
+     * @memberof Account3
+     */
+    accountType?: Account3AccountTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    accountTypeAlias?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    achCount?: number;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof Account3
+     */
+    asOfDate?: Calendar;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof Account3
+     */
+    asOfDateTime?: Calendar;
+    /**
+     *
+     * @type {Balance1}
+     * @memberof Account3
+     */
+    balance?: Balance1;
+    /**
+     *
+     * @type {Entitlements}
+     * @memberof Account3
+     */
+    bbEntitlements?: Entitlements;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    billPayAccountNumber?: string;
+    /**
+     *
+     * @type {AccountId}
+     * @memberof Account3
+     */
+    billPayId?: AccountId;
+    /**
+     *
+     * @type {Account3CategoryEnum}
+     * @memberof Account3
+     */
+    category?: Account3CategoryEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    ccAccountId?: string;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    currentYearEligibleContribution?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    currentYearMaxContribution?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    description?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    diAccountType?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    displayAccountNumber?: string;
+    /**
+     *
+     * @type {DisplayFlag}
+     * @memberof Account3
+     */
+    displayFlag?: DisplayFlag;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    displayPrimaryMemberNumber?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    enabled?: boolean;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    escrowPriorYearToDate?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    escrowYearToDate?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    exportAccountNumber?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    externalBroker?: string;
+    /**
+     *
+     * @type {FIAccountType}
+     * @memberof Account3
+     */
+    fiAccountType?: FIAccountType;
+    /**
+     *
+     * @type {FICustomerId}
+     * @memberof Account3
+     */
+    fiCustomerId?: FICustomerId;
+    /**
+     *
+     * @type {IdType}
+     * @memberof Account3
+     */
+    fiId?: IdType;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    fiIdHash?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    fiName?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    fwAccountType?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    historyAllowed?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    hostAccountType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    hostMetaData?: string;
+    /**
+     *
+     * @type {AccountId}
+     * @memberof Account3
+     */
+    id?: AccountId;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    interestPriorYearToDate?: Money2;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    interestRate?: number;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    interestYearToDate?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    interfaceId?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    isBillPaySupported?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    isExternalFI?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    isHybrid?: boolean;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    lastDepositAmount?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    lastDividendAmount?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    lastInterestPaymentAmount?: Money2;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof Account3
+     */
+    lastInterestPaymentDate?: Calendar;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof Account3
+     */
+    lastStatementCycleDate?: Calendar;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof Account3
+     */
+    lastStatementThruDate?: Calendar;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    lastYearEligibleContribution?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    lastYearMaxContribution?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    memberNumber?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    micrNumber?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    nickName?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    nonQualifiedRate?: number;
+    /**
+     *
+     * @type {AccountNumber}
+     * @memberof Account3
+     */
+    overdraftAccountNum?: AccountNumber;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    overdraftAccountNumber?: string;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    overdraftAvailableAmount?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    overdraftLimit?: Money2;
+    /**
+     *
+     * @type {Account3OwnershipTypeEnum}
+     * @memberof Account3
+     */
+    ownershipType?: Account3OwnershipTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    plasticCardPin?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    plasticCardSecurityDigits?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    posCount?: number;
+    /**
+     *
+     * @type {FICustomerId}
+     * @memberof Account3
+     */
+    primaryHolderId?: FICustomerId;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    primaryHolderName?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    quickBalanceEnabled?: boolean;
+    /**
+     *
+     * @type {AccountRefreshStatus}
+     * @memberof Account3
+     */
+    refreshStatus?: AccountRefreshStatus;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    refreshfromcc?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    refreshwaitseconds?: number;
+    /**
+     *
+     * @type {RegDLimits1}
+     * @memberof Account3
+     */
+    regDLimits?: RegDLimits1;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    rewardsCount?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    routingNumber?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Account3
+     */
+    smsBankingDefaultAccount?: boolean;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    taxPriorYearToDate?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    taxYearToDate?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    tier1BalanceDesc?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    tier1QualifiedRate?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    tier2BalanceDesc?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account3
+     */
+    tier2QualifiedRate?: number;
+    /**
+     *
+     * @type {Money2}
+     * @memberof Account3
+     */
+    totalFundsAvailable?: Money2;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    tpvReference?: string;
+    /**
+     *
+     * @type {Account3TransferRestrictionEnum}
+     * @memberof Account3
+     */
+    transferRestriction?: Account3TransferRestrictionEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Account3
+     */
+    usrHidden?: string;
+}
+/**
+ * @export
+ */
+export declare const Account3AccountStatusEnum: {
+    readonly OPEN: "OPEN";
+    readonly CLOSED: "CLOSED";
+    readonly NEGATIVE_BALANCE: "NEGATIVE_BALANCE";
+    readonly DELINQUENT: "DELINQUENT";
+    readonly IN_COLLECTION: "IN_COLLECTION";
+    readonly OVER_LIMIT: "OVER_LIMIT";
+    readonly WRITTEN_OFF: "WRITTEN_OFF";
+    readonly HAS_CREDIT_BAL: "HAS_CREDIT_BAL";
+    readonly PAYMENT_COUPON: "PAYMENT_COUPON";
+    readonly RET_PLAN: "RET_PLAN";
+    readonly RET_PLAN_OWNED_BY_DECEASED: "RET_PLAN_OWNED_BY_DECEASED";
+    readonly APPROVED: "APPROVED";
+    readonly NOT_APPROVED: "NOT_APPROVED";
+    readonly DELETED: "DELETED";
+    readonly VERIFIED: "VERIFIED";
+};
+export type Account3AccountStatusEnum = typeof Account3AccountStatusEnum[keyof typeof Account3AccountStatusEnum];
+/**
+ * @export
+ */
+export declare const Account3AccountTypeEnum: {
+    readonly SAVINGS: "SAVINGS";
+    readonly CHECKING: "CHECKING";
+    readonly MONEY_MARKET: "MONEY_MARKET";
+    readonly BROKERAGE: "BROKERAGE";
+    readonly LINE_OF_CREDIT_LOAN: "LINE_OF_CREDIT_LOAN";
+    readonly TCL_CREDIT_LINE: "TCL_CREDIT_LINE";
+    readonly UNKNOWN: "UNKNOWN";
+    readonly KEOGH: "KEOGH";
+    readonly RETIREMENT_401_K: "RETIREMENT_401_K";
+    readonly CERT_OF_DEPOSIT: "CERT_OF_DEPOSIT";
+    readonly CSI_CERT_OF_DEPOSIT: "CSI_CERT_OF_DEPOSIT";
+    readonly CREDIT_CARD_LOAN: "CREDIT_CARD_LOAN";
+    readonly INSTALLMENT_LOAN: "INSTALLMENT_LOAN";
+    readonly CONSUMER_LOAN: "CONSUMER_LOAN";
+    readonly COMMERCIAL_LOAN: "COMMERCIAL_LOAN";
+    readonly MORTGAGE_LOAN: "MORTGAGE_LOAN";
+    readonly RESIDENTIAL_MORTGAGE_LOAN: "RESIDENTIAL_MORTGAGE_LOAN";
+    readonly COMMERCIAL_REFI_LOAN: "COMMERCIAL_REFI_LOAN";
+    readonly HOME_EQUITY_LOAN: "HOME_EQUITY_LOAN";
+    readonly GENERAL_LEDGER_ACCOUNT: "GENERAL_LEDGER_ACCOUNT";
+    readonly GENERAL_LEDGER_CODE: "GENERAL_LEDGER_CODE";
+    readonly TCL_MASTER: "TCL_MASTER";
+    readonly TCL_NOTE: "TCL_NOTE";
+    readonly RETIREMENT_IRA: "RETIREMENT_IRA";
+};
+export type Account3AccountTypeEnum = typeof Account3AccountTypeEnum[keyof typeof Account3AccountTypeEnum];
+/**
+ * @export
+ */
+export declare const Account3CategoryEnum: {
+    readonly DEPOSIT: "DEPOSIT";
+    readonly LOAN: "LOAN";
+    readonly INVESTMENT: "INVESTMENT";
+    readonly TIERED_LOAN: "TIERED_LOAN";
+    readonly CROSS_USER_ACCOUNT: "CROSS_USER_ACCOUNT";
+};
+export type Account3CategoryEnum = typeof Account3CategoryEnum[keyof typeof Account3CategoryEnum];
+/**
+ * @export
+ */
+export declare const Account3OwnershipTypeEnum: {
+    readonly PRIMARY: "PRIMARY";
+    readonly JOINT: "JOINT";
+    readonly CROSS: "CROSS";
+};
+export type Account3OwnershipTypeEnum = typeof Account3OwnershipTypeEnum[keyof typeof Account3OwnershipTypeEnum];
+/**
+ * @export
+ */
+export declare const Account3TransferRestrictionEnum: {
+    readonly EXCLUDE_ALL: "EXCLUDE_ALL";
+    readonly EXCLUDE_AS_FROM: "EXCLUDE_AS_FROM";
+    readonly EXCLUDE_AS_TO: "EXCLUDE_AS_TO";
+};
+export type Account3TransferRestrictionEnum = typeof Account3TransferRestrictionEnum[keyof typeof Account3TransferRestrictionEnum];
+/**
+ * Check if a given object implements the Account3 interface.
+ */
+export declare function instanceOfAccount3(value: object): value is Account3;
+export declare function Account3FromJSON(json: any): Account3;
+export declare function Account3FromJSONTyped(json: any, ignoreDiscriminator: boolean): Account3;
+export declare function Account3ToJSON(json: any): Account3;
+export declare function Account3ToJSONTyped(value?: Account3 | null, ignoreDiscriminator?: boolean): any;