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

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

@@ -1,300 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Candescent DI API
- * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { FICustomerIdFromJSON, FICustomerIdToJSON, } from './FICustomerId.js';
-import { AccountRefreshStatusFromJSON, AccountRefreshStatusToJSON, } from './AccountRefreshStatus.js';
-import { FIAccountTypeFromJSON, FIAccountTypeToJSON, } from './FIAccountType.js';
-import { RegDLimits1FromJSON, RegDLimits1ToJSON, } from './RegDLimits1.js';
-import { AccountIdFromJSON, AccountIdToJSON, } from './AccountId.js';
-import { Money2FromJSON, Money2ToJSON, } from './Money2.js';
-import { CalendarFromJSON, CalendarToJSON, } from './Calendar.js';
-import { Balance1FromJSON, Balance1ToJSON, } from './Balance1.js';
-import { AccountNumberFromJSON, AccountNumberToJSON, } from './AccountNumber.js';
-import { IdTypeFromJSON, IdTypeToJSON, } from './IdType.js';
-import { AccountTransactionsFromJSON, AccountTransactionsToJSON, } from './AccountTransactions.js';
-import { EntitlementsFromJSON, EntitlementsToJSON, } from './Entitlements.js';
-import { AccountStatusesFromJSON, AccountStatusesToJSON, } from './AccountStatuses.js';
-import { DisplayFlagFromJSON, DisplayFlagToJSON, } from './DisplayFlag.js';
-/**
- * @export
- */
-export const Account3AccountStatusEnum = {
-    OPEN: 'OPEN',
-    CLOSED: 'CLOSED',
-    NEGATIVE_BALANCE: 'NEGATIVE_BALANCE',
-    DELINQUENT: 'DELINQUENT',
-    IN_COLLECTION: 'IN_COLLECTION',
-    OVER_LIMIT: 'OVER_LIMIT',
-    WRITTEN_OFF: 'WRITTEN_OFF',
-    HAS_CREDIT_BAL: 'HAS_CREDIT_BAL',
-    PAYMENT_COUPON: 'PAYMENT_COUPON',
-    RET_PLAN: 'RET_PLAN',
-    RET_PLAN_OWNED_BY_DECEASED: 'RET_PLAN_OWNED_BY_DECEASED',
-    APPROVED: 'APPROVED',
-    NOT_APPROVED: 'NOT_APPROVED',
-    DELETED: 'DELETED',
-    VERIFIED: 'VERIFIED'
-};
-/**
- * @export
- */
-export const Account3AccountTypeEnum = {
-    SAVINGS: 'SAVINGS',
-    CHECKING: 'CHECKING',
-    MONEY_MARKET: 'MONEY_MARKET',
-    BROKERAGE: 'BROKERAGE',
-    LINE_OF_CREDIT_LOAN: 'LINE_OF_CREDIT_LOAN',
-    TCL_CREDIT_LINE: 'TCL_CREDIT_LINE',
-    UNKNOWN: 'UNKNOWN',
-    KEOGH: 'KEOGH',
-    RETIREMENT_401_K: 'RETIREMENT_401_K',
-    CERT_OF_DEPOSIT: 'CERT_OF_DEPOSIT',
-    CSI_CERT_OF_DEPOSIT: 'CSI_CERT_OF_DEPOSIT',
-    CREDIT_CARD_LOAN: 'CREDIT_CARD_LOAN',
-    INSTALLMENT_LOAN: 'INSTALLMENT_LOAN',
-    CONSUMER_LOAN: 'CONSUMER_LOAN',
-    COMMERCIAL_LOAN: 'COMMERCIAL_LOAN',
-    MORTGAGE_LOAN: 'MORTGAGE_LOAN',
-    RESIDENTIAL_MORTGAGE_LOAN: 'RESIDENTIAL_MORTGAGE_LOAN',
-    COMMERCIAL_REFI_LOAN: 'COMMERCIAL_REFI_LOAN',
-    HOME_EQUITY_LOAN: 'HOME_EQUITY_LOAN',
-    GENERAL_LEDGER_ACCOUNT: 'GENERAL_LEDGER_ACCOUNT',
-    GENERAL_LEDGER_CODE: 'GENERAL_LEDGER_CODE',
-    TCL_MASTER: 'TCL_MASTER',
-    TCL_NOTE: 'TCL_NOTE',
-    RETIREMENT_IRA: 'RETIREMENT_IRA'
-};
-/**
- * @export
- */
-export const Account3CategoryEnum = {
-    DEPOSIT: 'DEPOSIT',
-    LOAN: 'LOAN',
-    INVESTMENT: 'INVESTMENT',
-    TIERED_LOAN: 'TIERED_LOAN',
-    CROSS_USER_ACCOUNT: 'CROSS_USER_ACCOUNT'
-};
-/**
- * @export
- */
-export const Account3OwnershipTypeEnum = {
-    PRIMARY: 'PRIMARY',
-    JOINT: 'JOINT',
-    CROSS: 'CROSS'
-};
-/**
- * @export
- */
-export const Account3TransferRestrictionEnum = {
-    EXCLUDE_ALL: 'EXCLUDE_ALL',
-    EXCLUDE_AS_FROM: 'EXCLUDE_AS_FROM',
-    EXCLUDE_AS_TO: 'EXCLUDE_AS_TO'
-};
-/**
- * Check if a given object implements the Account3 interface.
- */
-export function instanceOfAccount3(value) {
-    return true;
-}
-export function Account3FromJSON(json) {
-    return Account3FromJSONTyped(json, false);
-}
-export function Account3FromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'accountHidden': json['accountHidden'] == null ? undefined : json['accountHidden'],
-        'accountNumber': json['accountNumber'] == null ? undefined : AccountNumberFromJSON(json['accountNumber']),
-        'accountStatus': json['accountStatus'] == null ? undefined : json['accountStatus'],
-        'accountStatusInt': json['accountStatusInt'] == null ? undefined : json['accountStatusInt'],
-        'accountStatuses': json['accountStatuses'] == null ? undefined : AccountStatusesFromJSON(json['accountStatuses']),
-        'accountTransactions': json['accountTransactions'] == null ? undefined : AccountTransactionsFromJSON(json['accountTransactions']),
-        'accountType': json['accountType'] == null ? undefined : json['accountType'],
-        'accountTypeAlias': json['accountTypeAlias'] == null ? undefined : json['accountTypeAlias'],
-        'achCount': json['achCount'] == null ? undefined : json['achCount'],
-        'asOfDate': json['asOfDate'] == null ? undefined : CalendarFromJSON(json['asOfDate']),
-        'asOfDateTime': json['asOfDateTime'] == null ? undefined : CalendarFromJSON(json['asOfDateTime']),
-        'balance': json['balance'] == null ? undefined : Balance1FromJSON(json['balance']),
-        'bbEntitlements': json['bbEntitlements'] == null ? undefined : EntitlementsFromJSON(json['bbEntitlements']),
-        'billPayAccountNumber': json['billPayAccountNumber'] == null ? undefined : json['billPayAccountNumber'],
-        'billPayId': json['billPayId'] == null ? undefined : AccountIdFromJSON(json['billPayId']),
-        'category': json['category'] == null ? undefined : json['category'],
-        'ccAccountId': json['ccAccountId'] == null ? undefined : json['ccAccountId'],
-        'currentYearEligibleContribution': json['currentYearEligibleContribution'] == null ? undefined : Money2FromJSON(json['currentYearEligibleContribution']),
-        'currentYearMaxContribution': json['currentYearMaxContribution'] == null ? undefined : Money2FromJSON(json['currentYearMaxContribution']),
-        'description': json['description'] == null ? undefined : json['description'],
-        'diAccountType': json['diAccountType'] == null ? undefined : json['diAccountType'],
-        'displayAccountNumber': json['displayAccountNumber'] == null ? undefined : json['displayAccountNumber'],
-        'displayFlag': json['displayFlag'] == null ? undefined : DisplayFlagFromJSON(json['displayFlag']),
-        'displayPrimaryMemberNumber': json['displayPrimaryMemberNumber'] == null ? undefined : json['displayPrimaryMemberNumber'],
-        'enabled': json['enabled'] == null ? undefined : json['enabled'],
-        'escrowPriorYearToDate': json['escrowPriorYearToDate'] == null ? undefined : Money2FromJSON(json['escrowPriorYearToDate']),
-        'escrowYearToDate': json['escrowYearToDate'] == null ? undefined : Money2FromJSON(json['escrowYearToDate']),
-        'exportAccountNumber': json['exportAccountNumber'] == null ? undefined : json['exportAccountNumber'],
-        'externalBroker': json['externalBroker'] == null ? undefined : json['externalBroker'],
-        'fiAccountType': json['fiAccountType'] == null ? undefined : FIAccountTypeFromJSON(json['fiAccountType']),
-        'fiCustomerId': json['fiCustomerId'] == null ? undefined : FICustomerIdFromJSON(json['fiCustomerId']),
-        'fiId': json['fiId'] == null ? undefined : IdTypeFromJSON(json['fiId']),
-        'fiIdHash': json['fiIdHash'] == null ? undefined : json['fiIdHash'],
-        'fiName': json['fiName'] == null ? undefined : json['fiName'],
-        'fwAccountType': json['fwAccountType'] == null ? undefined : json['fwAccountType'],
-        'historyAllowed': json['historyAllowed'] == null ? undefined : json['historyAllowed'],
-        'hostAccountType': json['hostAccountType'] == null ? undefined : json['hostAccountType'],
-        'hostMetaData': json['hostMetaData'] == null ? undefined : json['hostMetaData'],
-        'id': json['id'] == null ? undefined : AccountIdFromJSON(json['id']),
-        'interestPriorYearToDate': json['interestPriorYearToDate'] == null ? undefined : Money2FromJSON(json['interestPriorYearToDate']),
-        'interestRate': json['interestRate'] == null ? undefined : json['interestRate'],
-        'interestYearToDate': json['interestYearToDate'] == null ? undefined : Money2FromJSON(json['interestYearToDate']),
-        'interfaceId': json['interfaceId'] == null ? undefined : json['interfaceId'],
-        'isBillPaySupported': json['isBillPaySupported'] == null ? undefined : json['isBillPaySupported'],
-        'isExternalFI': json['isExternalFI'] == null ? undefined : json['isExternalFI'],
-        'isHybrid': json['isHybrid'] == null ? undefined : json['isHybrid'],
-        'lastDepositAmount': json['lastDepositAmount'] == null ? undefined : Money2FromJSON(json['lastDepositAmount']),
-        'lastDividendAmount': json['lastDividendAmount'] == null ? undefined : Money2FromJSON(json['lastDividendAmount']),
-        'lastInterestPaymentAmount': json['lastInterestPaymentAmount'] == null ? undefined : Money2FromJSON(json['lastInterestPaymentAmount']),
-        'lastInterestPaymentDate': json['lastInterestPaymentDate'] == null ? undefined : CalendarFromJSON(json['lastInterestPaymentDate']),
-        'lastStatementCycleDate': json['lastStatementCycleDate'] == null ? undefined : CalendarFromJSON(json['lastStatementCycleDate']),
-        'lastStatementThruDate': json['lastStatementThruDate'] == null ? undefined : CalendarFromJSON(json['lastStatementThruDate']),
-        'lastYearEligibleContribution': json['lastYearEligibleContribution'] == null ? undefined : Money2FromJSON(json['lastYearEligibleContribution']),
-        'lastYearMaxContribution': json['lastYearMaxContribution'] == null ? undefined : Money2FromJSON(json['lastYearMaxContribution']),
-        'memberNumber': json['memberNumber'] == null ? undefined : json['memberNumber'],
-        'micrNumber': json['micrNumber'] == null ? undefined : json['micrNumber'],
-        'nickName': json['nickName'] == null ? undefined : json['nickName'],
-        'nonQualifiedRate': json['nonQualifiedRate'] == null ? undefined : json['nonQualifiedRate'],
-        'overdraftAccountNum': json['overdraftAccountNum'] == null ? undefined : AccountNumberFromJSON(json['overdraftAccountNum']),
-        'overdraftAccountNumber': json['overdraftAccountNumber'] == null ? undefined : json['overdraftAccountNumber'],
-        'overdraftAvailableAmount': json['overdraftAvailableAmount'] == null ? undefined : Money2FromJSON(json['overdraftAvailableAmount']),
-        'overdraftLimit': json['overdraftLimit'] == null ? undefined : Money2FromJSON(json['overdraftLimit']),
-        'ownershipType': json['ownershipType'] == null ? undefined : json['ownershipType'],
-        'plasticCardPin': json['plasticCardPin'] == null ? undefined : json['plasticCardPin'],
-        'plasticCardSecurityDigits': json['plasticCardSecurityDigits'] == null ? undefined : json['plasticCardSecurityDigits'],
-        'posCount': json['posCount'] == null ? undefined : json['posCount'],
-        'primaryHolderId': json['primaryHolderId'] == null ? undefined : FICustomerIdFromJSON(json['primaryHolderId']),
-        'primaryHolderName': json['primaryHolderName'] == null ? undefined : json['primaryHolderName'],
-        'quickBalanceEnabled': json['quickBalanceEnabled'] == null ? undefined : json['quickBalanceEnabled'],
-        'refreshStatus': json['refreshStatus'] == null ? undefined : AccountRefreshStatusFromJSON(json['refreshStatus']),
-        'refreshfromcc': json['refreshfromcc'] == null ? undefined : json['refreshfromcc'],
-        'refreshwaitseconds': json['refreshwaitseconds'] == null ? undefined : json['refreshwaitseconds'],
-        'regDLimits': json['regDLimits'] == null ? undefined : RegDLimits1FromJSON(json['regDLimits']),
-        'rewardsCount': json['rewardsCount'] == null ? undefined : json['rewardsCount'],
-        'routingNumber': json['routingNumber'] == null ? undefined : json['routingNumber'],
-        'smsBankingDefaultAccount': json['smsBankingDefaultAccount'] == null ? undefined : json['smsBankingDefaultAccount'],
-        'taxPriorYearToDate': json['taxPriorYearToDate'] == null ? undefined : Money2FromJSON(json['taxPriorYearToDate']),
-        'taxYearToDate': json['taxYearToDate'] == null ? undefined : Money2FromJSON(json['taxYearToDate']),
-        'tier1BalanceDesc': json['tier1BalanceDesc'] == null ? undefined : json['tier1BalanceDesc'],
-        'tier1QualifiedRate': json['tier1QualifiedRate'] == null ? undefined : json['tier1QualifiedRate'],
-        'tier2BalanceDesc': json['tier2BalanceDesc'] == null ? undefined : json['tier2BalanceDesc'],
-        'tier2QualifiedRate': json['tier2QualifiedRate'] == null ? undefined : json['tier2QualifiedRate'],
-        'totalFundsAvailable': json['totalFundsAvailable'] == null ? undefined : Money2FromJSON(json['totalFundsAvailable']),
-        'tpvReference': json['tpvReference'] == null ? undefined : json['tpvReference'],
-        'transferRestriction': json['transferRestriction'] == null ? undefined : json['transferRestriction'],
-        'usrHidden': json['usrHidden'] == null ? undefined : json['usrHidden'],
-    };
-}
-export function Account3ToJSON(json) {
-    return Account3ToJSONTyped(json, false);
-}
-export function Account3ToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'accountHidden': value['accountHidden'],
-        'accountNumber': AccountNumberToJSON(value['accountNumber']),
-        'accountStatus': value['accountStatus'],
-        'accountStatusInt': value['accountStatusInt'],
-        'accountStatuses': AccountStatusesToJSON(value['accountStatuses']),
-        'accountTransactions': AccountTransactionsToJSON(value['accountTransactions']),
-        'accountType': value['accountType'],
-        'accountTypeAlias': value['accountTypeAlias'],
-        'achCount': value['achCount'],
-        'asOfDate': CalendarToJSON(value['asOfDate']),
-        'asOfDateTime': CalendarToJSON(value['asOfDateTime']),
-        'balance': Balance1ToJSON(value['balance']),
-        'bbEntitlements': EntitlementsToJSON(value['bbEntitlements']),
-        'billPayAccountNumber': value['billPayAccountNumber'],
-        'billPayId': AccountIdToJSON(value['billPayId']),
-        'category': value['category'],
-        'ccAccountId': value['ccAccountId'],
-        'currentYearEligibleContribution': Money2ToJSON(value['currentYearEligibleContribution']),
-        'currentYearMaxContribution': Money2ToJSON(value['currentYearMaxContribution']),
-        'description': value['description'],
-        'diAccountType': value['diAccountType'],
-        'displayAccountNumber': value['displayAccountNumber'],
-        'displayFlag': DisplayFlagToJSON(value['displayFlag']),
-        'displayPrimaryMemberNumber': value['displayPrimaryMemberNumber'],
-        'enabled': value['enabled'],
-        'escrowPriorYearToDate': Money2ToJSON(value['escrowPriorYearToDate']),
-        'escrowYearToDate': Money2ToJSON(value['escrowYearToDate']),
-        'exportAccountNumber': value['exportAccountNumber'],
-        'externalBroker': value['externalBroker'],
-        'fiAccountType': FIAccountTypeToJSON(value['fiAccountType']),
-        'fiCustomerId': FICustomerIdToJSON(value['fiCustomerId']),
-        'fiId': IdTypeToJSON(value['fiId']),
-        'fiIdHash': value['fiIdHash'],
-        'fiName': value['fiName'],
-        'fwAccountType': value['fwAccountType'],
-        'historyAllowed': value['historyAllowed'],
-        'hostAccountType': value['hostAccountType'],
-        'hostMetaData': value['hostMetaData'],
-        'id': AccountIdToJSON(value['id']),
-        'interestPriorYearToDate': Money2ToJSON(value['interestPriorYearToDate']),
-        'interestRate': value['interestRate'],
-        'interestYearToDate': Money2ToJSON(value['interestYearToDate']),
-        'interfaceId': value['interfaceId'],
-        'isBillPaySupported': value['isBillPaySupported'],
-        'isExternalFI': value['isExternalFI'],
-        'isHybrid': value['isHybrid'],
-        'lastDepositAmount': Money2ToJSON(value['lastDepositAmount']),
-        'lastDividendAmount': Money2ToJSON(value['lastDividendAmount']),
-        'lastInterestPaymentAmount': Money2ToJSON(value['lastInterestPaymentAmount']),
-        'lastInterestPaymentDate': CalendarToJSON(value['lastInterestPaymentDate']),
-        'lastStatementCycleDate': CalendarToJSON(value['lastStatementCycleDate']),
-        'lastStatementThruDate': CalendarToJSON(value['lastStatementThruDate']),
-        'lastYearEligibleContribution': Money2ToJSON(value['lastYearEligibleContribution']),
-        'lastYearMaxContribution': Money2ToJSON(value['lastYearMaxContribution']),
-        'memberNumber': value['memberNumber'],
-        'micrNumber': value['micrNumber'],
-        'nickName': value['nickName'],
-        'nonQualifiedRate': value['nonQualifiedRate'],
-        'overdraftAccountNum': AccountNumberToJSON(value['overdraftAccountNum']),
-        'overdraftAccountNumber': value['overdraftAccountNumber'],
-        'overdraftAvailableAmount': Money2ToJSON(value['overdraftAvailableAmount']),
-        'overdraftLimit': Money2ToJSON(value['overdraftLimit']),
-        'ownershipType': value['ownershipType'],
-        'plasticCardPin': value['plasticCardPin'],
-        'plasticCardSecurityDigits': value['plasticCardSecurityDigits'],
-        'posCount': value['posCount'],
-        'primaryHolderId': FICustomerIdToJSON(value['primaryHolderId']),
-        'primaryHolderName': value['primaryHolderName'],
-        'quickBalanceEnabled': value['quickBalanceEnabled'],
-        'refreshStatus': AccountRefreshStatusToJSON(value['refreshStatus']),
-        'refreshfromcc': value['refreshfromcc'],
-        'refreshwaitseconds': value['refreshwaitseconds'],
-        'regDLimits': RegDLimits1ToJSON(value['regDLimits']),
-        'rewardsCount': value['rewardsCount'],
-        'routingNumber': value['routingNumber'],
-        'smsBankingDefaultAccount': value['smsBankingDefaultAccount'],
-        'taxPriorYearToDate': Money2ToJSON(value['taxPriorYearToDate']),
-        'taxYearToDate': Money2ToJSON(value['taxYearToDate']),
-        'tier1BalanceDesc': value['tier1BalanceDesc'],
-        'tier1QualifiedRate': value['tier1QualifiedRate'],
-        'tier2BalanceDesc': value['tier2BalanceDesc'],
-        'tier2QualifiedRate': value['tier2QualifiedRate'],
-        'totalFundsAvailable': Money2ToJSON(value['totalFundsAvailable']),
-        'tpvReference': value['tpvReference'],
-        'transferRestriction': value['transferRestriction'],
-        'usrHidden': value['usrHidden'],
-    };
-}

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

@@ -1,46 +0,0 @@
-/**
- * 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 { Account1 } from './Account1.js';
-import type { EventDetails } from './EventDetails.js';
-/**
- *
- * @export
- * @interface AccountEvent
- */
-export interface AccountEvent {
-    /**
-     *
-     * @type {EventDetails}
-     * @memberof AccountEvent
-     */
-    eventDetails?: EventDetails;
-    /**
-     *
-     * @type {string}
-     * @memberof AccountEvent
-     */
-    eventDomainType?: string;
-    /**
-     *
-     * @type {Account1}
-     * @memberof AccountEvent
-     */
-    account?: Account1;
-}
-/**
- * Check if a given object implements the AccountEvent interface.
- */
-export declare function instanceOfAccountEvent(value: object): value is AccountEvent;
-export declare function AccountEventFromJSON(json: any): AccountEvent;
-export declare function AccountEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountEvent;
-export declare function AccountEventToJSON(json: any): AccountEvent;
-export declare function AccountEventToJSONTyped(value?: AccountEvent | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,47 +0,0 @@
-/* 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 { Account1FromJSON, Account1ToJSON, } from './Account1.js';
-import { EventDetailsFromJSON, EventDetailsToJSON, } from './EventDetails.js';
-/**
- * Check if a given object implements the AccountEvent interface.
- */
-export function instanceOfAccountEvent(value) {
-    return true;
-}
-export function AccountEventFromJSON(json) {
-    return AccountEventFromJSONTyped(json, false);
-}
-export function AccountEventFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'eventDetails': json['eventDetails'] == null ? undefined : EventDetailsFromJSON(json['eventDetails']),
-        'eventDomainType': json['eventDomainType'] == null ? undefined : json['eventDomainType'],
-        'account': json['account'] == null ? undefined : Account1FromJSON(json['account']),
-    };
-}
-export function AccountEventToJSON(json) {
-    return AccountEventToJSONTyped(json, false);
-}
-export function AccountEventToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'eventDetails': EventDetailsToJSON(value['eventDetails']),
-        'eventDomainType': value['eventDomainType'],
-        'account': Account1ToJSON(value['account']),
-    };
-}

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

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

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

@@ -1,43 +0,0 @@
-/* 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 AccountNickname interface.
- */
-export function instanceOfAccountNickname(value) {
-    return true;
-}
-export function AccountNicknameFromJSON(json) {
-    return AccountNicknameFromJSONTyped(json, false);
-}
-export function AccountNicknameFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'nickName': json['nickName'] == null ? undefined : json['nickName'],
-        'isVisible': json['isVisible'] == null ? undefined : json['isVisible'],
-    };
-}
-export function AccountNicknameToJSON(json) {
-    return AccountNicknameToJSONTyped(json, false);
-}
-export function AccountNicknameToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'nickName': value['nickName'],
-        'isVisible': value['isVisible'],
-    };
-}

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

@@ -1,77 +0,0 @@
-/**
- * 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 { Calendar } from './Calendar.js';
-/**
- *
- * @export
- * @interface AccountRefreshStatus
- */
-export interface AccountRefreshStatus {
-    /**
-     *
-     * @type {number}
-     * @memberof AccountRefreshStatus
-     */
-    code?: number;
-    /**
-     *
-     * @type {Calendar}
-     * @memberof AccountRefreshStatus
-     */
-    lastAttemptDate?: Calendar;
-    /**
-     *
-     * @type {Calendar}
-     * @memberof AccountRefreshStatus
-     */
-    lastSuccessDate?: Calendar;
-    /**
-     *
-     * @type {string}
-     * @memberof AccountRefreshStatus
-     */
-    message?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof AccountRefreshStatus
-     */
-    modifiedBy?: number;
-    /**
-     *
-     * @type {AccountRefreshStatusStatusEnum}
-     * @memberof AccountRefreshStatus
-     */
-    status?: AccountRefreshStatusStatusEnum;
-    /**
-     *
-     * @type {boolean}
-     * @memberof AccountRefreshStatus
-     */
-    transactionsUpdated?: boolean;
-}
-/**
- * @export
- */
-export declare const AccountRefreshStatusStatusEnum: {
-    readonly SUCCESS: "SUCCESS";
-    readonly ERROR: "ERROR";
-};
-export type AccountRefreshStatusStatusEnum = typeof AccountRefreshStatusStatusEnum[keyof typeof AccountRefreshStatusStatusEnum];
-/**
- * Check if a given object implements the AccountRefreshStatus interface.
- */
-export declare function instanceOfAccountRefreshStatus(value: object): value is AccountRefreshStatus;
-export declare function AccountRefreshStatusFromJSON(json: any): AccountRefreshStatus;
-export declare function AccountRefreshStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountRefreshStatus;
-export declare function AccountRefreshStatusToJSON(json: any): AccountRefreshStatus;
-export declare function AccountRefreshStatusToJSONTyped(value?: AccountRefreshStatus | null, ignoreDiscriminator?: boolean): any;