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

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

@@ -0,0 +1,90 @@
+/* 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 { Money1FromJSON, Money1ToJSON, } from './Money1.js';
+/**
+ * Check if a given object implements the AccountTransaction interface.
+ */
+export function instanceOfAccountTransaction(value) {
+    return true;
+}
+export function AccountTransactionFromJSON(json) {
+    return AccountTransactionFromJSONTyped(json, false);
+}
+export function AccountTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accountId': json['accountId'] == null ? undefined : json['accountId'],
+        'amount': json['amount'] == null ? undefined : Money1FromJSON(json['amount']),
+        'amountToEscrow': json['amountToEscrow'] == null ? undefined : Money1FromJSON(json['amountToEscrow']),
+        'amountToInterest': json['amountToInterest'] == null ? undefined : Money1FromJSON(json['amountToInterest']),
+        'amountToPrincipal': json['amountToPrincipal'] == null ? undefined : Money1FromJSON(json['amountToPrincipal']),
+        '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'],
+        'creditTransaction': json['creditTransaction'] == null ? undefined : json['creditTransaction'],
+        'depositSlipIdentifier': json['depositSlipIdentifier'] == null ? undefined : json['depositSlipIdentifier'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'effectiveDate': json['effectiveDate'] == null ? undefined : json['effectiveDate'],
+        'fee': json['fee'] == null ? undefined : Money1FromJSON(json['fee']),
+        'fiId': json['fiId'] == null ? undefined : json['fiId'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'ledgerBalance': json['ledgerBalance'] == null ? undefined : Money1FromJSON(json['ledgerBalance']),
+        'memo': json['memo'] == null ? undefined : json['memo'],
+        'micr': json['micr'] == null ? undefined : json['micr'],
+        'isPending': json['isPending'] == null ? undefined : json['isPending'],
+        'persistentTnum': json['persistentTnum'] == null ? undefined : json['persistentTnum'],
+        'transactionDate': json['transactionDate'] == null ? undefined : json['transactionDate'],
+        'transactionId': json['transactionId'] == null ? undefined : json['transactionId'],
+        'transactionNumber': json['transactionNumber'] == null ? undefined : json['transactionNumber'],
+        'transactionType': json['transactionType'] == null ? undefined : json['transactionType'],
+    };
+}
+export function AccountTransactionToJSON(json) {
+    return AccountTransactionToJSONTyped(json, false);
+}
+export function AccountTransactionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'accountId': value['accountId'],
+        'amount': Money1ToJSON(value['amount']),
+        'amountToEscrow': Money1ToJSON(value['amountToEscrow']),
+        'amountToInterest': Money1ToJSON(value['amountToInterest']),
+        'amountToPrincipal': Money1ToJSON(value['amountToPrincipal']),
+        'checkImageIdentifier': value['checkImageIdentifier'],
+        'checkImageLocator': value['checkImageLocator'],
+        'checkNumber': value['checkNumber'],
+        'checkNumberStr': value['checkNumberStr'],
+        'creditTransaction': value['creditTransaction'],
+        'depositSlipIdentifier': value['depositSlipIdentifier'],
+        'description': value['description'],
+        'effectiveDate': value['effectiveDate'],
+        'fee': Money1ToJSON(value['fee']),
+        'fiId': value['fiId'],
+        'id': value['id'],
+        'ledgerBalance': Money1ToJSON(value['ledgerBalance']),
+        'memo': value['memo'],
+        'micr': value['micr'],
+        'isPending': value['isPending'],
+        'persistentTnum': value['persistentTnum'],
+        'transactionDate': value['transactionDate'],
+        'transactionId': value['transactionId'],
+        'transactionNumber': value['transactionNumber'],
+        'transactionType': value['transactionType'],
+    };
+}

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

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