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

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

@@ -0,0 +1,203 @@
+/* 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 { AccountIdFromJSON, AccountIdToJSON, } from './AccountId.js';
+import { Money2FromJSON, Money2ToJSON, } from './Money2.js';
+import { CalendarFromJSON, CalendarToJSON, } from './Calendar.js';
+import { TransactionCategoryFromJSON, TransactionCategoryToJSON, } from './TransactionCategory.js';
+import { HostTransactionTypeFromJSON, HostTransactionTypeToJSON, } from './HostTransactionType.js';
+import { IdTypeFromJSON, IdTypeToJSON, } from './IdType.js';
+/**
+ * @export
+ */
+export const AccountTransaction1PostTypeEnum = {
+    POSTED: 'POSTED',
+    MEMO: 'MEMO',
+    PENDING: 'PENDING'
+};
+/**
+ * @export
+ */
+export const AccountTransaction1TransactionTypeEnum = {
+    WITHDRAWAL: 'WITHDRAWAL',
+    CHECK: 'CHECK',
+    SAVINGS_WITHDRAWAL_PASSBOOK: 'SAVINGS_WITHDRAWAL_PASSBOOK',
+    SAVINGS_WITHDRAWAL_OTHER: 'SAVINGS_WITHDRAWAL_OTHER',
+    TELEPHONE_TRANSFER_DEBIT: 'TELEPHONE_TRANSFER_DEBIT',
+    TRANSFER_DEBIT: 'TRANSFER_DEBIT',
+    ADVANCE: 'ADVANCE',
+    AUTOMATIC_DEBIT: 'AUTOMATIC_DEBIT',
+    ATM_WITHDRAWAL: 'ATM_WITHDRAWAL',
+    ELECTRONIC_TRANSFER_DEBIT: 'ELECTRONIC_TRANSFER_DEBIT',
+    POS_PURCHASE: 'POS_PURCHASE',
+    BILL_PAYMENT: 'BILL_PAYMENT',
+    ACH_CHECK: 'ACH_CHECK',
+    SERVICE_CHARGE: 'SERVICE_CHARGE',
+    CHECK_BOOK_CHARGE: 'CHECK_BOOK_CHARGE',
+    ATM_FEE: 'ATM_FEE',
+    POS_PURCHASE_FEE: 'POS_PURCHASE_FEE',
+    STOP_PAYMENT_FEE: 'STOP_PAYMENT_FEE',
+    INTEREST_CHARGE_NORMAL: 'INTEREST_CHARGE_NORMAL',
+    INSUFFICIENT_FUNDS_CHARGE: 'INSUFFICIENT_FUNDS_CHARGE',
+    RETURNED_CHECK_FEE: 'RETURNED_CHECK_FEE',
+    OVERDRAFT_FEE: 'OVERDRAFT_FEE',
+    EARLY_WITHDRAWAL_FEE: 'EARLY_WITHDRAWAL_FEE',
+    LEDGER_ADJUSTMENT_DEBIT: 'LEDGER_ADJUSTMENT_DEBIT',
+    MISCELLANEOUS_DEBIT: 'MISCELLANEOUS_DEBIT',
+    RETAIL_PURCHASE: 'RETAIL_PURCHASE',
+    MAIL_ORDER_OR_TELEPHONE_PURCHASE: 'MAIL_ORDER_OR_TELEPHONE_PURCHASE',
+    CASH_ADVANCE: 'CASH_ADVANCE',
+    ANNUAL_FEE: 'ANNUAL_FEE',
+    LATE_PAYMENT_FEE: 'LATE_PAYMENT_FEE',
+    INTEREST_CHARGE: 'INTEREST_CHARGE',
+    DEBIT_ADJUSTMENT: 'DEBIT_ADJUSTMENT',
+    DEPOSIT: 'DEPOSIT',
+    TELEPHONE_TRANSFER_CREDIT: 'TELEPHONE_TRANSFER_CREDIT',
+    TRANSFER_CREDIT: 'TRANSFER_CREDIT',
+    PAYMENT: 'PAYMENT',
+    DIVIDEND: 'DIVIDEND',
+    DIRECT_DEPOSIT: 'DIRECT_DEPOSIT',
+    ATM_DEPOSIT: 'ATM_DEPOSIT',
+    ELECTRONIC_TRANSFER_CREDIT: 'ELECTRONIC_TRANSFER_CREDIT',
+    POS_CREDIT: 'POS_CREDIT',
+    BILL_PAYMENT_CREDIT: 'BILL_PAYMENT_CREDIT',
+    ACH_CREDIT: 'ACH_CREDIT',
+    INTEREST_POSTING: 'INTEREST_POSTING',
+    LEDGER_ADJUSTMENT_CREDIT: 'LEDGER_ADJUSTMENT_CREDIT',
+    MISCELLANEOUS_CREDIT: 'MISCELLANEOUS_CREDIT',
+    RETURN_OF_GOODS: 'RETURN_OF_GOODS',
+    REFUND: 'REFUND',
+    PAYMENT_CREDIT_CARD: 'PAYMENT_CREDIT_CARD',
+    CREDIT_ADJUSTMENT: 'CREDIT_ADJUSTMENT'
+};
+/**
+ * Check if a given object implements the AccountTransaction1 interface.
+ */
+export function instanceOfAccountTransaction1(value) {
+    return true;
+}
+export function AccountTransaction1FromJSON(json) {
+    return AccountTransaction1FromJSONTyped(json, false);
+}
+export function AccountTransaction1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accountId': json['accountId'] == null ? undefined : AccountIdFromJSON(json['accountId']),
+        'amount': json['amount'] == null ? undefined : Money2FromJSON(json['amount']),
+        'amountStr': json['amountStr'] == null ? undefined : json['amountStr'],
+        'amountToEscrow': json['amountToEscrow'] == null ? undefined : Money2FromJSON(json['amountToEscrow']),
+        'amountToInterest': json['amountToInterest'] == null ? undefined : Money2FromJSON(json['amountToInterest']),
+        'amountToPrincipal': json['amountToPrincipal'] == null ? undefined : Money2FromJSON(json['amountToPrincipal']),
+        'baiCode': json['baiCode'] == null ? undefined : json['baiCode'],
+        'ccTid': json['ccTid'] == null ? undefined : json['ccTid'],
+        'checkImageIdentifier': json['checkImageIdentifier'] == null ? undefined : json['checkImageIdentifier'],
+        'checkImageLocator': json['checkImageLocator'] == null ? undefined : json['checkImageLocator'],
+        'checkNumber': json['checkNumber'] == null ? undefined : json['checkNumber'],
+        'checkNumberStr': json['checkNumberStr'] == null ? undefined : json['checkNumberStr'],
+        'creditLineAccountId': json['creditLineAccountId'] == null ? undefined : AccountIdFromJSON(json['creditLineAccountId']),
+        'creditTransaction': json['creditTransaction'] == null ? undefined : json['creditTransaction'],
+        'dcTid': json['dcTid'] == null ? undefined : json['dcTid'],
+        'depositSlipIdentifier': json['depositSlipIdentifier'] == null ? undefined : json['depositSlipIdentifier'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'displayDescription': json['displayDescription'] == null ? undefined : json['displayDescription'],
+        'effectiveDate': json['effectiveDate'] == null ? undefined : CalendarFromJSON(json['effectiveDate']),
+        'fee': json['fee'] == null ? undefined : Money2FromJSON(json['fee']),
+        'fiCustomerId': json['fiCustomerId'] == null ? undefined : FICustomerIdFromJSON(json['fiCustomerId']),
+        'fiId': json['fiId'] == null ? undefined : IdTypeFromJSON(json['fiId']),
+        'hostTransactionCode': json['hostTransactionCode'] == null ? undefined : json['hostTransactionCode'],
+        'hostTransactionType': json['hostTransactionType'] == null ? undefined : HostTransactionTypeFromJSON(json['hostTransactionType']),
+        'id': json['id'] == null ? undefined : IdTypeFromJSON(json['id']),
+        'ledgerBalance': json['ledgerBalance'] == null ? undefined : Money2FromJSON(json['ledgerBalance']),
+        'memo': json['memo'] == null ? undefined : json['memo'],
+        'micr': json['micr'] == null ? undefined : json['micr'],
+        'noImage': json['noImage'] == null ? undefined : json['noImage'],
+        'noteAccountId': json['noteAccountId'] == null ? undefined : AccountIdFromJSON(json['noteAccountId']),
+        'ofxTid': json['ofxTid'] == null ? undefined : json['ofxTid'],
+        'otherAccountId': json['otherAccountId'] == null ? undefined : AccountIdFromJSON(json['otherAccountId']),
+        'otherAccountType': json['otherAccountType'] == null ? undefined : json['otherAccountType'],
+        'otherCreditLineAccountId': json['otherCreditLineAccountId'] == null ? undefined : AccountIdFromJSON(json['otherCreditLineAccountId']),
+        'otherNoteAccountId': json['otherNoteAccountId'] == null ? undefined : AccountIdFromJSON(json['otherNoteAccountId']),
+        'pending': json['pending'] == null ? undefined : json['pending'],
+        'persistentTnum': json['persistentTnum'] == null ? undefined : json['persistentTnum'],
+        'postType': json['postType'] == null ? undefined : json['postType'],
+        'transactionCategory': json['transactionCategory'] == null ? undefined : TransactionCategoryFromJSON(json['transactionCategory']),
+        'transactionDate': json['transactionDate'] == null ? undefined : CalendarFromJSON(json['transactionDate']),
+        'transactionId': json['transactionId'] == null ? undefined : json['transactionId'],
+        'transactionKey': json['transactionKey'] == null ? undefined : json['transactionKey'],
+        'transactionNumber': json['transactionNumber'] == null ? undefined : json['transactionNumber'],
+        'transactionPayee': json['transactionPayee'] == null ? undefined : json['transactionPayee'],
+        'transactionStatus': json['transactionStatus'] == null ? undefined : json['transactionStatus'],
+        'transactionTime': json['transactionTime'] == null ? undefined : CalendarFromJSON(json['transactionTime']),
+        'transactionType': json['transactionType'] == null ? undefined : json['transactionType'],
+    };
+}
+export function AccountTransaction1ToJSON(json) {
+    return AccountTransaction1ToJSONTyped(json, false);
+}
+export function AccountTransaction1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'accountId': AccountIdToJSON(value['accountId']),
+        'amount': Money2ToJSON(value['amount']),
+        'amountStr': value['amountStr'],
+        'amountToEscrow': Money2ToJSON(value['amountToEscrow']),
+        'amountToInterest': Money2ToJSON(value['amountToInterest']),
+        'amountToPrincipal': Money2ToJSON(value['amountToPrincipal']),
+        'baiCode': value['baiCode'],
+        'ccTid': value['ccTid'],
+        'checkImageIdentifier': value['checkImageIdentifier'],
+        'checkImageLocator': value['checkImageLocator'],
+        'checkNumber': value['checkNumber'],
+        'checkNumberStr': value['checkNumberStr'],
+        'creditLineAccountId': AccountIdToJSON(value['creditLineAccountId']),
+        'creditTransaction': value['creditTransaction'],
+        'dcTid': value['dcTid'],
+        'depositSlipIdentifier': value['depositSlipIdentifier'],
+        'description': value['description'],
+        'displayDescription': value['displayDescription'],
+        'effectiveDate': CalendarToJSON(value['effectiveDate']),
+        'fee': Money2ToJSON(value['fee']),
+        'fiCustomerId': FICustomerIdToJSON(value['fiCustomerId']),
+        'fiId': IdTypeToJSON(value['fiId']),
+        'hostTransactionCode': value['hostTransactionCode'],
+        'hostTransactionType': HostTransactionTypeToJSON(value['hostTransactionType']),
+        'id': IdTypeToJSON(value['id']),
+        'ledgerBalance': Money2ToJSON(value['ledgerBalance']),
+        'memo': value['memo'],
+        'micr': value['micr'],
+        'noImage': value['noImage'],
+        'noteAccountId': AccountIdToJSON(value['noteAccountId']),
+        'ofxTid': value['ofxTid'],
+        'otherAccountId': AccountIdToJSON(value['otherAccountId']),
+        'otherAccountType': value['otherAccountType'],
+        'otherCreditLineAccountId': AccountIdToJSON(value['otherCreditLineAccountId']),
+        'otherNoteAccountId': AccountIdToJSON(value['otherNoteAccountId']),
+        'pending': value['pending'],
+        'persistentTnum': value['persistentTnum'],
+        'postType': value['postType'],
+        'transactionCategory': TransactionCategoryToJSON(value['transactionCategory']),
+        'transactionDate': CalendarToJSON(value['transactionDate']),
+        'transactionId': value['transactionId'],
+        'transactionKey': value['transactionKey'],
+        'transactionNumber': value['transactionNumber'],
+        'transactionPayee': value['transactionPayee'],
+        'transactionStatus': value['transactionStatus'],
+        'transactionTime': CalendarToJSON(value['transactionTime']),
+        'transactionType': value['transactionType'],
+    };
+}

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

@@ -0,0 +1,168 @@
+/**
+ * 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 { AccountId } from './AccountId.js';
+import type { TransactionRange } from './TransactionRange.js';
+import type { AccountTransaction1 } from './AccountTransaction1.js';
+import type { Money2 } from './Money2.js';
+import type { Calendar } from './Calendar.js';
+import type { IdType } from './IdType.js';
+/**
+ *
+ * @export
+ * @interface AccountTransactions
+ */
+export interface AccountTransactions {
+    /**
+     *
+     * @type {AccountId}
+     * @memberof AccountTransactions
+     */
+    accountId?: AccountId;
+    /**
+     *
+     * @type {Array<AccountTransaction1>}
+     * @memberof AccountTransactions
+     */
+    accountTransaction?: Array<AccountTransaction1>;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof AccountTransactions
+     */
+    asOfDateTime?: Calendar;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AccountTransactions
+     */
+    complete?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountTransactions
+     */
+    creditLineNumber?: string;
+    /**
+     *
+     * @type {Money2}
+     * @memberof AccountTransactions
+     */
+    endBalance?: Money2;
+    /**
+     *
+     * @type {FICustomerId}
+     * @memberof AccountTransactions
+     */
+    fiCustomerId?: FICustomerId;
+    /**
+     *
+     * @type {IdType}
+     * @memberof AccountTransactions
+     */
+    fiId?: IdType;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof AccountTransactions
+     */
+    hostProcessingDate?: Calendar;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AccountTransactions
+     */
+    isExternalFI?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountTransactions
+     */
+    noteNumber?: string;
+    /**
+     *
+     * @type {Calendar}
+     * @memberof AccountTransactions
+     */
+    postingDate?: Calendar;
+    /**
+     *
+     * @type {TransactionRange}
+     * @memberof AccountTransactions
+     */
+    range?: TransactionRange;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AccountTransactions
+     */
+    retrieveFutureTransactions?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AccountTransactions
+     */
+    retrievePendingTransactions?: boolean;
+    /**
+     *
+     * @type {Money2}
+     * @memberof AccountTransactions
+     */
+    runningPrincipalBalance?: Money2;
+    /**
+     *
+     * @type {AccountTransactionsSortOrderEnum}
+     * @memberof AccountTransactions
+     */
+    sortOrder?: AccountTransactionsSortOrderEnum;
+    /**
+     *
+     * @type {Money2}
+     * @memberof AccountTransactions
+     */
+    startBalance?: Money2;
+    /**
+     *
+     * @type {number}
+     * @memberof AccountTransactions
+     */
+    transactionCount?: number;
+    /**
+     *
+     * @type {Money2}
+     * @memberof AccountTransactions
+     */
+    unpostedCredits?: Money2;
+    /**
+     *
+     * @type {Money2}
+     * @memberof AccountTransactions
+     */
+    unpostedDebits?: Money2;
+}
+/**
+ * @export
+ */
+export declare const AccountTransactionsSortOrderEnum: {
+    readonly UNKNOWN: "UNKNOWN";
+    readonly ASCENDING: "ASCENDING";
+    readonly DESCENDING: "DESCENDING";
+};
+export type AccountTransactionsSortOrderEnum = typeof AccountTransactionsSortOrderEnum[keyof typeof AccountTransactionsSortOrderEnum];
+/**
+ * Check if a given object implements the AccountTransactions interface.
+ */
+export declare function instanceOfAccountTransactions(value: object): value is AccountTransactions;
+export declare function AccountTransactionsFromJSON(json: any): AccountTransactions;
+export declare function AccountTransactionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountTransactions;
+export declare function AccountTransactionsToJSON(json: any): AccountTransactions;
+export declare function AccountTransactionsToJSONTyped(value?: AccountTransactions | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,96 @@
+/* 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 { AccountIdFromJSON, AccountIdToJSON, } from './AccountId.js';
+import { TransactionRangeFromJSON, TransactionRangeToJSON, } from './TransactionRange.js';
+import { AccountTransaction1FromJSON, AccountTransaction1ToJSON, } from './AccountTransaction1.js';
+import { Money2FromJSON, Money2ToJSON, } from './Money2.js';
+import { CalendarFromJSON, CalendarToJSON, } from './Calendar.js';
+import { IdTypeFromJSON, IdTypeToJSON, } from './IdType.js';
+/**
+ * @export
+ */
+export const AccountTransactionsSortOrderEnum = {
+    UNKNOWN: 'UNKNOWN',
+    ASCENDING: 'ASCENDING',
+    DESCENDING: 'DESCENDING'
+};
+/**
+ * Check if a given object implements the AccountTransactions interface.
+ */
+export function instanceOfAccountTransactions(value) {
+    return true;
+}
+export function AccountTransactionsFromJSON(json) {
+    return AccountTransactionsFromJSONTyped(json, false);
+}
+export function AccountTransactionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accountId': json['accountId'] == null ? undefined : AccountIdFromJSON(json['accountId']),
+        'accountTransaction': json['accountTransaction'] == null ? undefined : (json['accountTransaction'].map(AccountTransaction1FromJSON)),
+        'asOfDateTime': json['asOfDateTime'] == null ? undefined : CalendarFromJSON(json['asOfDateTime']),
+        'complete': json['complete'] == null ? undefined : json['complete'],
+        'creditLineNumber': json['creditLineNumber'] == null ? undefined : json['creditLineNumber'],
+        'endBalance': json['endBalance'] == null ? undefined : Money2FromJSON(json['endBalance']),
+        'fiCustomerId': json['fiCustomerId'] == null ? undefined : FICustomerIdFromJSON(json['fiCustomerId']),
+        'fiId': json['fiId'] == null ? undefined : IdTypeFromJSON(json['fiId']),
+        'hostProcessingDate': json['hostProcessingDate'] == null ? undefined : CalendarFromJSON(json['hostProcessingDate']),
+        'isExternalFI': json['isExternalFI'] == null ? undefined : json['isExternalFI'],
+        'noteNumber': json['noteNumber'] == null ? undefined : json['noteNumber'],
+        'postingDate': json['postingDate'] == null ? undefined : CalendarFromJSON(json['postingDate']),
+        'range': json['range'] == null ? undefined : TransactionRangeFromJSON(json['range']),
+        'retrieveFutureTransactions': json['retrieveFutureTransactions'] == null ? undefined : json['retrieveFutureTransactions'],
+        'retrievePendingTransactions': json['retrievePendingTransactions'] == null ? undefined : json['retrievePendingTransactions'],
+        'runningPrincipalBalance': json['runningPrincipalBalance'] == null ? undefined : Money2FromJSON(json['runningPrincipalBalance']),
+        'sortOrder': json['sortOrder'] == null ? undefined : json['sortOrder'],
+        'startBalance': json['startBalance'] == null ? undefined : Money2FromJSON(json['startBalance']),
+        'transactionCount': json['transactionCount'] == null ? undefined : json['transactionCount'],
+        'unpostedCredits': json['unpostedCredits'] == null ? undefined : Money2FromJSON(json['unpostedCredits']),
+        'unpostedDebits': json['unpostedDebits'] == null ? undefined : Money2FromJSON(json['unpostedDebits']),
+    };
+}
+export function AccountTransactionsToJSON(json) {
+    return AccountTransactionsToJSONTyped(json, false);
+}
+export function AccountTransactionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'accountId': AccountIdToJSON(value['accountId']),
+        'accountTransaction': value['accountTransaction'] == null ? undefined : (value['accountTransaction'].map(AccountTransaction1ToJSON)),
+        'asOfDateTime': CalendarToJSON(value['asOfDateTime']),
+        'complete': value['complete'],
+        'creditLineNumber': value['creditLineNumber'],
+        'endBalance': Money2ToJSON(value['endBalance']),
+        'fiCustomerId': FICustomerIdToJSON(value['fiCustomerId']),
+        'fiId': IdTypeToJSON(value['fiId']),
+        'hostProcessingDate': CalendarToJSON(value['hostProcessingDate']),
+        'isExternalFI': value['isExternalFI'],
+        'noteNumber': value['noteNumber'],
+        'postingDate': CalendarToJSON(value['postingDate']),
+        'range': TransactionRangeToJSON(value['range']),
+        'retrieveFutureTransactions': value['retrieveFutureTransactions'],
+        'retrievePendingTransactions': value['retrievePendingTransactions'],
+        'runningPrincipalBalance': Money2ToJSON(value['runningPrincipalBalance']),
+        'sortOrder': value['sortOrder'],
+        'startBalance': Money2ToJSON(value['startBalance']),
+        'transactionCount': value['transactionCount'],
+        'unpostedCredits': Money2ToJSON(value['unpostedCredits']),
+        'unpostedDebits': Money2ToJSON(value['unpostedDebits']),
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { DIAccountType } from './DIAccountType.js';
+/**
+ *
+ * @export
+ * @interface AccountType
+ */
+export interface AccountType {
+    /**
+     *
+     * @type {DIAccountType}
+     * @memberof AccountType
+     */
+    value?: DIAccountType;
+    /**
+     * FI Account type from host - Based on FI level config this value could change
+     * @type {number}
+     * @memberof AccountType
+     */
+    fiAccountType?: number;
+    /**
+     * Raw account type code from the host system before mapping to DIAccountType
+     * @type {number}
+     * @memberof AccountType
+     */
+    fiRawAccountType?: number;
+    /**
+     * Account description returned from the host - FI can send custom account type description
+     * @type {string}
+     * @memberof AccountType
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AccountType interface.
+ */
+export declare function instanceOfAccountType(value: object): value is AccountType;
+export declare function AccountTypeFromJSON(json: any): AccountType;
+export declare function AccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountType;
+export declare function AccountTypeToJSON(json: any): AccountType;
+export declare function AccountTypeToJSONTyped(value?: AccountType | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,48 @@
+/* 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 { DIAccountTypeFromJSON, DIAccountTypeToJSON, } from './DIAccountType.js';
+/**
+ * Check if a given object implements the AccountType interface.
+ */
+export function instanceOfAccountType(value) {
+    return true;
+}
+export function AccountTypeFromJSON(json) {
+    return AccountTypeFromJSONTyped(json, false);
+}
+export function AccountTypeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'value': json['value'] == null ? undefined : DIAccountTypeFromJSON(json['value']),
+        'fiAccountType': json['fiAccountType'] == null ? undefined : json['fiAccountType'],
+        'fiRawAccountType': json['fiRawAccountType'] == null ? undefined : json['fiRawAccountType'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AccountTypeToJSON(json) {
+    return AccountTypeToJSONTyped(json, false);
+}
+export function AccountTypeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'value': DIAccountTypeToJSON(value['value']),
+        'fiAccountType': value['fiAccountType'],
+        'fiRawAccountType': value['fiRawAccountType'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { DIAccountType } from './DIAccountType.js';
+/**
+ *
+ * @export
+ * @interface AccountType1
+ */
+export interface AccountType1 {
+    /**
+     *
+     * @type {DIAccountType}
+     * @memberof AccountType1
+     */
+    value?: DIAccountType;
+    /**
+     * FI Account type from host - Based on FI level config this value could change
+     * @type {number}
+     * @memberof AccountType1
+     */
+    fiAccountType?: number;
+    /**
+     * Account description returned from the host - FI can send custom account type description
+     * @type {string}
+     * @memberof AccountType1
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AccountType1 interface.
+ */
+export declare function instanceOfAccountType1(value: object): value is AccountType1;
+export declare function AccountType1FromJSON(json: any): AccountType1;
+export declare function AccountType1FromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountType1;
+export declare function AccountType1ToJSON(json: any): AccountType1;
+export declare function AccountType1ToJSONTyped(value?: AccountType1 | null, ignoreDiscriminator?: boolean): any;