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

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

@@ -0,0 +1,717 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { OwnershipType } from './OwnershipType.js';
+import type { FIAccountType } from './FIAccountType.js';
+import type { TransferRestriction } from './TransferRestriction.js';
+import type { AssociatedMembers } from './AssociatedMembers.js';
+import type { Account1AlternateUserIdentifier } from './Account1AlternateUserIdentifier.js';
+import type { Account1PrimaryHolderAlternateId } from './Account1PrimaryHolderAlternateId.js';
+import type { Account1PrimaryHolderId } from './Account1PrimaryHolderId.js';
+import type { Account1TaxPriorYearToDate } from './Account1TaxPriorYearToDate.js';
+import type { Account1OverdraftAccountNum } from './Account1OverdraftAccountNum.js';
+import type { Account1InterestYearToDate } from './Account1InterestYearToDate.js';
+import type { Account1BillPayId } from './Account1BillPayId.js';
+import type { Account1LastDepositAmount } from './Account1LastDepositAmount.js';
+import type { AccountStatus1 } from './AccountStatus1.js';
+import type { PaymentRuleType } from './PaymentRuleType.js';
+import type { Account1Id } from './Account1Id.js';
+import type { Account1LastInterestPaymentAmount } from './Account1LastInterestPaymentAmount.js';
+import type { Account1OverdraftAvailableAmount } from './Account1OverdraftAvailableAmount.js';
+import type { Account1TotalFundsAvailable } from './Account1TotalFundsAvailable.js';
+import type { AccountCategory1 } from './AccountCategory1.js';
+import type { Account1FiId } from './Account1FiId.js';
+import type { TermType1 } from './TermType1.js';
+import type { Account1FiCustomerId } from './Account1FiCustomerId.js';
+import type { Account1InterestPriorYearToDate } from './Account1InterestPriorYearToDate.js';
+import type { Account1AccountNumber } from './Account1AccountNumber.js';
+import type { Roles } from './Roles.js';
+import type { HostPromotions } from './HostPromotions.js';
+import type { Account1DefaultAccountId } from './Account1DefaultAccountId.js';
+import type { Account1OverdraftLimit } from './Account1OverdraftLimit.js';
+import type { DIAccountType2 } from './DIAccountType2.js';
+import type { Account1LastDividendAmount } from './Account1LastDividendAmount.js';
+import type { Entitlements } from './Entitlements.js';
+import type { RegDLimits } from './RegDLimits.js';
+import type { AccountStatuses } from './AccountStatuses.js';
+import type { Account1TaxYearToDate } from './Account1TaxYearToDate.js';
+import type { DisplayFlag } from './DisplayFlag.js';
+import type { Balance } from './Balance.js';
+/**
+ *
+ * @export
+ * @interface LoanAccount
+ */
+export interface LoanAccount {
+    /**
+     * Indicates whether the account is hidden from the user’s view.
+     * @type {boolean}
+     * @memberof LoanAccount
+     */
+    accountHidden: boolean;
+    /**
+     *
+     * @type {Account1AccountNumber}
+     * @memberof LoanAccount
+     */
+    accountNumber: Account1AccountNumber;
+    /**
+     *
+     * @type {AccountStatus1}
+     * @memberof LoanAccount
+     */
+    accountStatus: AccountStatus1;
+    /**
+     * Numeric representation of the account status.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    accountStatusInt?: number;
+    /**
+     *
+     * @type {AccountStatuses}
+     * @memberof LoanAccount
+     */
+    accountStatuses: AccountStatuses;
+    /**
+     *
+     * @type {DIAccountType2}
+     * @memberof LoanAccount
+     */
+    accountType: DIAccountType2;
+    /**
+     * Number of Automated Clearing House (ACH) transactions associated with the account.
+     *
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    achCount?: number;
+    /**
+     *
+     * @type {Account1AlternateUserIdentifier}
+     * @memberof LoanAccount
+     */
+    alternateUserIdentifier?: Account1AlternateUserIdentifier;
+    /**
+     * Identifier for the relationship manager associated with the account, when applicable.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    rmKey?: string;
+    /**
+     *
+     * @type {AssociatedMembers}
+     * @memberof LoanAccount
+     */
+    associatedMembers?: AssociatedMembers;
+    /**
+     * Date and time when the account data was most recently updated by the host system.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    asOfDate?: string;
+    /**
+     *
+     * @type {Balance}
+     * @memberof LoanAccount
+     */
+    balance: Balance;
+    /**
+     *
+     * @type {Entitlements}
+     * @memberof LoanAccount
+     */
+    bbEntitlements?: Entitlements;
+    /**
+     * Account identifier used for bill payment services.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    billPayAccountNumber?: string;
+    /**
+     *
+     * @type {Account1BillPayId}
+     * @memberof LoanAccount
+     */
+    billPayId?: Account1BillPayId;
+    /**
+     *
+     * @type {AccountCategory1}
+     * @memberof LoanAccount
+     */
+    category: AccountCategory1;
+    /**
+     * Account identifier formatted for use by Customer Central systems.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    ccAccountId?: string;
+    /**
+     * Bill pay account number formatted for OFX Direct Connect integrations. The value is
+     * formatted and masked according to configuration.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    dcBillPayAccountNumber?: string;
+    /**
+     * Account number formatted for OFX Direct Connect integrations. The value uses Direct
+     * Connect–specific masking and formatting rules, configured separately from standard
+     * export account number formats.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    dcExportAccountNumber?: string;
+    /**
+     *
+     * @type {Account1DefaultAccountId}
+     * @memberof LoanAccount
+     */
+    defaultAccountId?: Account1DefaultAccountId;
+    /**
+     * Readable description or name of the account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    description: string;
+    /**
+     * Normalized account type value derived from Candescent, excluding user‑defined account
+     * types.
+     *
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    diAccountType?: number;
+    /**
+     * Account number shown to the user for reference.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    displayAccountNumber: string;
+    /**
+     * Masked card number shown to the user for reference.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    displayCardNumber?: string;
+    /**
+     * Routing number shown to the user for reference, when applicable.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    displayRoutingNumber?: string;
+    /**
+     *
+     * @type {DisplayFlag}
+     * @memberof LoanAccount
+     */
+    displayFlag: DisplayFlag;
+    /**
+     * Masked member number shown to identify the primary associated member.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    displayPrimaryMemberNumber?: string;
+    /**
+     * Indicates whether the account is enabled based on platform configuration.
+     * @type {boolean}
+     * @memberof LoanAccount
+     */
+    enabled: boolean;
+    /**
+     * Account number formatted for external data exports. Suitable for use in financial software
+     * like Quicken or QuickBooks.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    exportAccountNumber?: string;
+    /**
+     * Identifier of an external broker associated with the account, when applicable.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    externalBroker?: string;
+    /**
+     *
+     * @type {FIAccountType}
+     * @memberof LoanAccount
+     */
+    fiAccountType: FIAccountType;
+    /**
+     *
+     * @type {Account1FiCustomerId}
+     * @memberof LoanAccount
+     */
+    fiCustomerId: Account1FiCustomerId;
+    /**
+     *
+     * @type {Account1FiId}
+     * @memberof LoanAccount
+     */
+    fiId: Account1FiId;
+    /**
+     * Account type code as defined by the host system.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    hostAccountType?: string;
+    /**
+     *
+     * @type {Account1Id}
+     * @memberof LoanAccount
+     */
+    id: Account1Id;
+    /**
+     *
+     * @type {Account1InterestPriorYearToDate}
+     * @memberof LoanAccount
+     */
+    interestPriorYearToDate?: Account1InterestPriorYearToDate;
+    /**
+     * Interest rate currently applied to the account.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    interestRate?: number;
+    /**
+     *
+     * @type {Account1InterestYearToDate}
+     * @memberof LoanAccount
+     */
+    interestYearToDate?: Account1InterestYearToDate;
+    /**
+     * Interface identifier for the account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    interfaceId?: string;
+    /**
+     * Indicates whether the account supports both real‑time and batch data updates.
+     * @type {boolean}
+     * @memberof LoanAccount
+     */
+    isHybrid?: boolean;
+    /**
+     *
+     * @type {Account1LastDepositAmount}
+     * @memberof LoanAccount
+     */
+    lastDepositAmount?: Account1LastDepositAmount;
+    /**
+     *
+     * @type {Account1LastDividendAmount}
+     * @memberof LoanAccount
+     */
+    lastDividendAmount?: Account1LastDividendAmount;
+    /**
+     *
+     * @type {Account1LastInterestPaymentAmount}
+     * @memberof LoanAccount
+     */
+    lastInterestPaymentAmount?: Account1LastInterestPaymentAmount;
+    /**
+     * Date of the most recent interest payment.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    lastInterestPaymentDate?: string;
+    /**
+     * Start date of the most recent statement cycle.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    lastStatementCycleDate?: string;
+    /**
+     * End date of the most recent statement cycle.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    lastStatementThruDate?: string;
+    /**
+     * Member number associated with the account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    memberNumber: string;
+    /**
+     * Magnetic Ink Character Recognition (MICR) number associated with the account, when
+     * applicable.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    micrNumber?: string;
+    /**
+     * User‑defined nickname for the account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    nickName?: string;
+    /**
+     * Interest rate applied when the account is non‑qualified.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    nonQualifiedRate?: number;
+    /**
+     *
+     * @type {Account1OverdraftAccountNum}
+     * @memberof LoanAccount
+     */
+    overdraftAccountNum?: Account1OverdraftAccountNum;
+    /**
+     * Account number of the overdraft funding source provided as a simple string value.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    overdraftAccountNumber?: string;
+    /**
+     *
+     * @type {Account1OverdraftAvailableAmount}
+     * @memberof LoanAccount
+     */
+    overdraftAvailableAmount?: Account1OverdraftAvailableAmount;
+    /**
+     *
+     * @type {Account1OverdraftLimit}
+     * @memberof LoanAccount
+     */
+    overdraftLimit?: Account1OverdraftLimit;
+    /**
+     *
+     * @type {OwnershipType}
+     * @memberof LoanAccount
+     */
+    ownershipType: OwnershipType;
+    /**
+     * Number of point of sale (POS) transactions associated with the account.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    posCount?: number;
+    /**
+     *
+     * @type {Account1PrimaryHolderId}
+     * @memberof LoanAccount
+     */
+    primaryHolderId?: Account1PrimaryHolderId;
+    /**
+     *
+     * @type {Account1PrimaryHolderAlternateId}
+     * @memberof LoanAccount
+     */
+    primaryHolderAlternateId?: Account1PrimaryHolderAlternateId;
+    /**
+     * Name of the primary account holder.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    primaryHolderName?: string;
+    /**
+     *
+     * @type {RegDLimits}
+     * @memberof LoanAccount
+     */
+    regDLimits?: RegDLimits;
+    /**
+     * Number of reward transactions or accruals, when applicable.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    rewardsCount?: number;
+    /**
+     * Bank routing number used to identify the financial institution for the account.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    routingNumber?: string;
+    /**
+     *
+     * @type {Account1TaxPriorYearToDate}
+     * @memberof LoanAccount
+     */
+    taxPriorYearToDate?: Account1TaxPriorYearToDate;
+    /**
+     *
+     * @type {Account1TaxYearToDate}
+     * @memberof LoanAccount
+     */
+    taxYearToDate?: Account1TaxYearToDate;
+    /**
+     * Balance threshold description for tier 1 of a qualified rewards account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    tier1BalanceDesc?: string;
+    /**
+     * Interest rate applied to balances qualifying for tier 1 rewards.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    tier1QualifiedRate?: number;
+    /**
+     * Balance threshold description for tier 2 of a qualified rewards account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    tier2BalanceDesc?: string;
+    /**
+     * Interest rate applied to balances qualifying for tier 2 rewards.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    tier2QualifiedRate?: number;
+    /**
+     *
+     * @type {Account1TotalFundsAvailable}
+     * @memberof LoanAccount
+     */
+    totalFundsAvailable?: Account1TotalFundsAvailable;
+    /**
+     * Product code associated with the account as defined by an external third‑party vendor.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    tpvProductCode?: string;
+    /**
+     * External third‑party vendor reference identifier associated with the account.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    tpvReference?: string;
+    /**
+     *
+     * @type {TransferRestriction}
+     * @memberof LoanAccount
+     */
+    transferRestriction?: TransferRestriction;
+    /**
+     *
+     * @type {Roles}
+     * @memberof LoanAccount
+     */
+    roles?: Roles;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    nextPaymentAmount?: object;
+    /**
+     * Date on which the next scheduled payment for the account is due.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    nextPaymentDate?: string;
+    /**
+     * Identifier assigned to the loan note by the financial institution.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    loanNoteNumber?: string;
+    /**
+     * Alternate or additional note identifier associated with the loan.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    noteNumber?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    payOffAmount?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    calculatedPayOffAmount?: object;
+    /**
+     * Date through which the payoff amount is valid.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    payOffDate?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    minimumPayment?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    lineOfCreditLimit?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    escrowInterest?: object;
+    /**
+     * Due date for escrow‑related tax payments.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    escrowTaxDueDate?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    escrowYearToDate?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    escrowPriorYearToDate?: object;
+    /**
+     * Date when the account reaches the end of its term.
+     * @type {Date}
+     * @memberof LoanAccount
+     */
+    maturityDate?: Date;
+    /**
+     * Date on which the loan was originally issued or originated, representing the effective
+     * date of the loan agreement.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    loanOriginationDate?: string;
+    /**
+     * Numeric length of the account term in the unit given by termType.
+     * @type {number}
+     * @memberof LoanAccount
+     */
+    term?: number;
+    /**
+     *
+     * @type {TermType1}
+     * @memberof LoanAccount
+     */
+    termType?: TermType1;
+    /**
+     * Date the principal portion of a required payment was due and became overdue for
+     * payment on the account.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    pastPrincipalDueDate?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    lateChargesDue?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    lastPrincipalPaymentAmount?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    principalInterest15YearTermAmount?: object;
+    /**
+     *
+     * @type {PaymentRuleType}
+     * @memberof LoanAccount
+     */
+    paymentRule?: PaymentRuleType;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    originalLoanAmount?: object;
+    /**
+     * Date the loan was issued or funded.
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    issueDate?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    delinquencyAmount?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    pastDueInterestAmount?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    pastDuePrincipal?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    accruedInterest?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    cashAdvanceLimit?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof LoanAccount
+     */
+    availableCashAdvance?: object;
+    /**
+     * Identifier used for Automated Clearing House (ACH) transactions associated with the
+     * loan.
+     *
+     * @type {string}
+     * @memberof LoanAccount
+     */
+    achId?: string;
+    /**
+     *
+     * @type {HostPromotions}
+     * @memberof LoanAccount
+     */
+    hostPromotions?: HostPromotions;
+}
+/**
+ * Check if a given object implements the LoanAccount interface.
+ */
+export declare function instanceOfLoanAccount(value: object): value is LoanAccount;
+export declare function LoanAccountFromJSON(json: any): LoanAccount;
+export declare function LoanAccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): LoanAccount;
+export declare function LoanAccountToJSON(json: any): LoanAccount;
+export declare function LoanAccountToJSONTyped(value?: LoanAccount | null, ignoreDiscriminator?: boolean): any;