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

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

@@ -0,0 +1,148 @@
+/* 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AchTransactionFromJSON, AchTransactionToJSON, } from './AchTransaction.js';
+/**
+ * @export
+ */
+export const AchPaymentPaymentTypeEnum = {
+    ACH_COLLECTION: 'ACH_COLLECTION',
+    ACH_PAYMENT: 'ACH_PAYMENT',
+    WIRE_DOMESTIC: 'WIRE_DOMESTIC',
+    WIRE_INTERNATIONAL: 'WIRE_INTERNATIONAL'
+};
+/**
+ * @export
+ */
+export const AchPaymentTransactionTypeEnum = {
+    CREDIT: 'CREDIT',
+    DEBIT: 'DEBIT'
+};
+/**
+ * @export
+ */
+export const AchPaymentStatusEnum = {
+    PENDING_COMPANY_APPROVAL: 'PENDING_COMPANY_APPROVAL',
+    SCHEDULED: 'SCHEDULED',
+    COMPANY_DECLINED: 'COMPANY_DECLINED',
+    PENDING_FI_APPROVAL: 'PENDING_FI_APPROVAL',
+    FI_APPROVED: 'FI_APPROVED',
+    FI_DECLINED: 'FI_DECLINED',
+    SEND_TO_PROCESSOR: 'SEND_TO_PROCESSOR',
+    SEND_TO_PROCESSOR_FAILED: 'SEND_TO_PROCESSOR_FAILED',
+    PROCESSOR_ACCEPTED: 'PROCESSOR_ACCEPTED',
+    PROCESSOR_REJECTED: 'PROCESSOR_REJECTED',
+    PROCESSOR_CANCELLED: 'PROCESSOR_CANCELLED',
+    PROCESSED: 'PROCESSED',
+    CANCELLED: 'CANCELLED',
+    FAILED: 'FAILED',
+    COMPANY_APPROVED: 'COMPANY_APPROVED',
+    PREFUNDING_PENDING: 'PREFUNDING_PENDING',
+    PREFUNDING_FAILED: 'PREFUNDING_FAILED',
+    EXPIRED_REVERSAL: 'EXPIRED_REVERSAL',
+    RECURRING_PAYMENT_CREATE_FAILED: 'RECURRING_PAYMENT_CREATE_FAILED',
+    PARTIALLY_PROCESSED: 'PARTIALLY_PROCESSED',
+    DRAFT: 'DRAFT'
+};
+/**
+ * @export
+ */
+export const AchPaymentAchSecCodeEnum = {
+    COMMERCIAL_CCD: 'COMMERCIAL_CCD',
+    CONSUMER_PPD: 'CONSUMER_PPD',
+    PAYROLL_PPD: 'PAYROLL_PPD',
+    CHILD_SUPPORT_CCD: 'CHILD_SUPPORT_CCD'
+};
+/**
+ * Check if a given object implements the AchPayment interface.
+ */
+export function instanceOfAchPayment(value) {
+    if (!('paymentDescription' in value) || value['paymentDescription'] === undefined)
+        return false;
+    if (!('paymentType' in value) || value['paymentType'] === undefined)
+        return false;
+    if (!('transactionType' in value) || value['transactionType'] === undefined)
+        return false;
+    if (!('deliveryDate' in value) || value['deliveryDate'] === undefined)
+        return false;
+    if (!('accountNumber' in value) || value['accountNumber'] === undefined)
+        return false;
+    if (!('tinNumber' in value) || value['tinNumber'] === undefined)
+        return false;
+    if (!('achCompanyId' in value) || value['achCompanyId'] === undefined)
+        return false;
+    if (!('achSecCode' in value) || value['achSecCode'] === undefined)
+        return false;
+    if (!('achTransactions' in value) || value['achTransactions'] === undefined)
+        return false;
+    return true;
+}
+export function AchPaymentFromJSON(json) {
+    return AchPaymentFromJSONTyped(json, false);
+}
+export function AchPaymentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'institutionId': json['institutionId'] == null ? undefined : json['institutionId'],
+        'paymentName': json['paymentName'] == null ? undefined : json['paymentName'],
+        'paymentDescription': json['paymentDescription'],
+        'paymentType': json['paymentType'],
+        'transactionType': json['transactionType'],
+        'deliveryDate': json['deliveryDate'],
+        'accountNumber': json['accountNumber'],
+        'tinNumber': json['tinNumber'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'confirmationNumber': json['confirmationNumber'] == null ? undefined : json['confirmationNumber'],
+        'totalAmount': json['totalAmount'] == null ? undefined : json['totalAmount'],
+        'numberOfPayments': json['numberOfPayments'] == null ? undefined : json['numberOfPayments'],
+        'achCompanyId': json['achCompanyId'],
+        'achCompanyName': json['achCompanyName'] == null ? undefined : json['achCompanyName'],
+        'achSecCode': json['achSecCode'],
+        'sameDayAch': json['sameDayAch'] == null ? undefined : json['sameDayAch'],
+        'batchOffset': json['batchOffset'] == null ? undefined : json['batchOffset'],
+        'achTransactions': (json['achTransactions'].map(AchTransactionFromJSON)),
+    };
+}
+export function AchPaymentToJSON(json) {
+    return AchPaymentToJSONTyped(json, false);
+}
+export function AchPaymentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'institutionId': value['institutionId'],
+        'paymentName': value['paymentName'],
+        'paymentDescription': value['paymentDescription'],
+        'paymentType': value['paymentType'],
+        'transactionType': value['transactionType'],
+        'deliveryDate': value['deliveryDate'],
+        'accountNumber': value['accountNumber'],
+        'tinNumber': value['tinNumber'],
+        'status': value['status'],
+        'confirmationNumber': value['confirmationNumber'],
+        'totalAmount': value['totalAmount'],
+        'numberOfPayments': value['numberOfPayments'],
+        'achCompanyId': value['achCompanyId'],
+        'achCompanyName': value['achCompanyName'],
+        'achSecCode': value['achSecCode'],
+        'sameDayAch': value['sameDayAch'],
+        'batchOffset': value['batchOffset'],
+        'achTransactions': (value['achTransactions'].map(AchTransactionToJSON)),
+    };
+}
+//# sourceMappingURL=AchPayment.js.map

package/dist/generated/src/models/AchPayment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AchPayment.js","sourceRoot":"","sources":["../../../../generated/src/models/AchPayment.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,sBAAsB,EAEtB,oBAAoB,GAEvB,MAAM,qBAAqB,CAAC;AAmI7B;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACrC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,eAAe;IAC9B,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IACzC,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;CACR,CAAC;AAGX;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAChC,wBAAwB,EAAE,0BAA0B;IACpD,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;IACpC,mBAAmB,EAAE,qBAAqB;IAC1C,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,wBAAwB,EAAE,0BAA0B;IACpD,kBAAkB,EAAE,oBAAoB;IACxC,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,qBAAqB;IAC1C,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,gBAAgB,EAAE,kBAAkB;IACpC,kBAAkB,EAAE,oBAAoB;IACxC,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,+BAA+B,EAAE,iCAAiC;IAClE,mBAAmB,EAAE,qBAAqB;IAC1C,KAAK,EAAE,OAAO;CACR,CAAC;AAGX;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACpC,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,iBAAiB,EAAE,mBAAmB;CAChC,CAAC;AAIX;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAC9C,IAAI,CAAC,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChG,IAAI,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClF,IAAI,CAAC,CAAC,iBAAiB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC1F,IAAI,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpF,IAAI,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtF,IAAI,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC9E,IAAI,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpF,IAAI,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChF,IAAI,CAAC,CAAC,iBAAiB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC1F,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAS;IACxC,OAAO,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAS,EAAE,mBAA4B;IAC3E,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjD,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAClF,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC;QAChD,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAClC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC;QAC1C,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC;QACpC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QACtC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;QAC9B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC7D,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QACjG,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC3F,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC;QACpC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAChC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QACzE,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,iBAAiB,EAAE,CAAE,IAAI,CAAC,iBAAiB,CAAgB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;KAC3F,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAS;IACtC,OAAO,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,KAAyB,EAAE,sBAA+B,KAAK;IACjG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QACjB,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC;QACjD,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;QAC3C,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;QACrC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC;QACvC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC;QACjD,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAC7C,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;QACrC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,iBAAiB,EAAE,CAAE,KAAK,CAAC,iBAAiB,CAAgB,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;KAC1F,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,112 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CurrencyCode6 } from './CurrencyCode6.js';
+/**
+ * A single ACH transaction within a payment
+ * @export
+ * @interface AchTransaction
+ */
+export interface AchTransaction {
+    /**
+     * Transaction identifier
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    id?: string;
+    /**
+     * Transaction amount
+     * @type {number}
+     * @memberof AchTransaction
+     */
+    amount: number;
+    /**
+     * Price per transaction
+     * @type {number}
+     * @memberof AchTransaction
+     */
+    transactionPrice?: number;
+    /**
+     *
+     * @type {CurrencyCode6}
+     * @memberof AchTransaction
+     */
+    currencyCode: CurrencyCode6;
+    /**
+     * Parent payment identifier
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    paymentId?: string;
+    /**
+     * Contact name
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    contactName: string;
+    /**
+     * Contact bank name
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    contactBankName?: string;
+    /**
+     * Contact account number
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    contactAccountNumber: string;
+    /**
+     * Contact (recipient) account type. Allowed values (must match exactly):
+     * **PERSONAL_CHECKING**, **PERSONAL_SAVINGS**, **BUSINESS_CHECKING**, **BUSINESS_SAVINGS**, **BUSINESS_LOAN**.
+     *
+     * @type {AchTransactionContactAccountTypeEnum}
+     * @memberof AchTransaction
+     */
+    contactAccountType: AchTransactionContactAccountTypeEnum;
+    /**
+     * Contact bank ACH routing number
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    contactBankAchRoutingNumber: string;
+    /**
+     * Contact identifier
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    contactIdentifier?: string;
+    /**
+     * Optional addenda information
+     * @type {string}
+     * @memberof AchTransaction
+     */
+    addenda?: string;
+}
+/**
+ * @export
+ */
+export declare const AchTransactionContactAccountTypeEnum: {
+    readonly PERSONAL_CHECKING: "PERSONAL_CHECKING";
+    readonly PERSONAL_SAVINGS: "PERSONAL_SAVINGS";
+    readonly BUSINESS_CHECKING: "BUSINESS_CHECKING";
+    readonly BUSINESS_SAVINGS: "BUSINESS_SAVINGS";
+    readonly BUSINESS_LOAN: "BUSINESS_LOAN";
+};
+export type AchTransactionContactAccountTypeEnum = typeof AchTransactionContactAccountTypeEnum[keyof typeof AchTransactionContactAccountTypeEnum];
+/**
+ * Check if a given object implements the AchTransaction interface.
+ */
+export declare function instanceOfAchTransaction(value: object): value is AchTransaction;
+export declare function AchTransactionFromJSON(json: any): AchTransaction;
+export declare function AchTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AchTransaction;
+export declare function AchTransactionToJSON(json: any): AchTransaction;
+export declare function AchTransactionToJSONTyped(value?: AchTransaction | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,87 @@
+/* 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CurrencyCode6FromJSON, CurrencyCode6ToJSON, } from './CurrencyCode6.js';
+/**
+ * @export
+ */
+export const AchTransactionContactAccountTypeEnum = {
+    PERSONAL_CHECKING: 'PERSONAL_CHECKING',
+    PERSONAL_SAVINGS: 'PERSONAL_SAVINGS',
+    BUSINESS_CHECKING: 'BUSINESS_CHECKING',
+    BUSINESS_SAVINGS: 'BUSINESS_SAVINGS',
+    BUSINESS_LOAN: 'BUSINESS_LOAN'
+};
+/**
+ * Check if a given object implements the AchTransaction interface.
+ */
+export function instanceOfAchTransaction(value) {
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('currencyCode' in value) || value['currencyCode'] === undefined)
+        return false;
+    if (!('contactName' in value) || value['contactName'] === undefined)
+        return false;
+    if (!('contactAccountNumber' in value) || value['contactAccountNumber'] === undefined)
+        return false;
+    if (!('contactAccountType' in value) || value['contactAccountType'] === undefined)
+        return false;
+    if (!('contactBankAchRoutingNumber' in value) || value['contactBankAchRoutingNumber'] === undefined)
+        return false;
+    return true;
+}
+export function AchTransactionFromJSON(json) {
+    return AchTransactionFromJSONTyped(json, false);
+}
+export function AchTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'amount': json['amount'],
+        'transactionPrice': json['transactionPrice'] == null ? undefined : json['transactionPrice'],
+        'currencyCode': CurrencyCode6FromJSON(json['currencyCode']),
+        'paymentId': json['paymentId'] == null ? undefined : json['paymentId'],
+        'contactName': json['contactName'],
+        'contactBankName': json['contactBankName'] == null ? undefined : json['contactBankName'],
+        'contactAccountNumber': json['contactAccountNumber'],
+        'contactAccountType': json['contactAccountType'],
+        'contactBankAchRoutingNumber': json['contactBankAchRoutingNumber'],
+        'contactIdentifier': json['contactIdentifier'] == null ? undefined : json['contactIdentifier'],
+        'addenda': json['addenda'] == null ? undefined : json['addenda'],
+    };
+}
+export function AchTransactionToJSON(json) {
+    return AchTransactionToJSONTyped(json, false);
+}
+export function AchTransactionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'amount': value['amount'],
+        'transactionPrice': value['transactionPrice'],
+        'currencyCode': CurrencyCode6ToJSON(value['currencyCode']),
+        'paymentId': value['paymentId'],
+        'contactName': value['contactName'],
+        'contactBankName': value['contactBankName'],
+        'contactAccountNumber': value['contactAccountNumber'],
+        'contactAccountType': value['contactAccountType'],
+        'contactBankAchRoutingNumber': value['contactBankAchRoutingNumber'],
+        'contactIdentifier': value['contactIdentifier'],
+        'addenda': value['addenda'],
+    };
+}
+//# sourceMappingURL=AchTransaction.js.map

package/dist/generated/src/models/AchTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AchTransaction.js","sourceRoot":"","sources":["../../../../generated/src/models/AchTransaction.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,qBAAqB,EAErB,mBAAmB,GAEtB,MAAM,oBAAoB,CAAC;AAqF5B;;GAEG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG;IAChD,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,aAAa,EAAE,eAAe;CACxB,CAAC;AAIX;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAa;IAClD,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpF,IAAI,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClF,IAAI,CAAC,CAAC,sBAAsB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpG,IAAI,CAAC,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChG,IAAI,CAAC,CAAC,6BAA6B,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClH,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAS;IAC5C,OAAO,2BAA2B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,IAAS,EAAE,mBAA4B;IAC/E,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjD,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxB,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC3F,cAAc,EAAE,qBAAqB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3D,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;QACtE,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAClC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACxF,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC;QACpD,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC;QAChD,6BAA6B,EAAE,IAAI,CAAC,6BAA6B,CAAC;QAClE,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC9F,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;KACnE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAS;IAC1C,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAA6B,EAAE,sBAA+B,KAAK;IACzG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAC7C,cAAc,EAAE,mBAAmB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC1D,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;QAC3C,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,CAAC;QACrD,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC;QACjD,6BAA6B,EAAE,KAAK,CAAC,6BAA6B,CAAC;QACnE,mBAAmB,EAAE,KAAK,CAAC,mBAAmB,CAAC;QAC/C,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;KAC9B,CAAC;AACN,CAAC"}

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

@@ -1,33 +1,33 @@
 /**
  * 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/)**.
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { IdType } from './IdType.js';
+import type { ActionId } from './ActionId.js';
 /**
- *
+ * Represents a permission granted on a resource as part of an entitlement.
  * @export
  * @interface Action
  */
 export interface Action {
     /**
-     *
+     * Description of the action.
      * @type {string}
      * @memberof Action
      */
     description?: string;
     /**
      *
-     * @type {IdType}
+     * @type {ActionId}
      * @memberof Action
      */
-    id?: IdType;
+    id: ActionId;
 }
 /**
  * Check if a given object implements the Action interface.

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

@@ -2,20 +2,22 @@
 /* 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/)**.
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { IdTypeFromJSON, IdTypeToJSON, } from './IdType.js';
+import { ActionIdFromJSON, ActionIdToJSON, } from './ActionId.js';
 /**
  * Check if a given object implements the Action interface.
  */
 export function instanceOfAction(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
     return true;
 }
 export function ActionFromJSON(json) {
@@ -27,7 +29,7 @@ export function ActionFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'description': json['description'] == null ? undefined : json['description'],
-        'id': json['id'] == null ? undefined : IdTypeFromJSON(json['id']),
+        'id': ActionIdFromJSON(json['id']),
     };
 }
 export function ActionToJSON(json) {
@@ -39,6 +41,7 @@ export function ActionToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'description': value['description'],
-        'id': IdTypeToJSON(value['id']),
+        'id': ActionIdToJSON(value['id']),
     };
 }
+//# sourceMappingURL=Action.js.map

package/dist/generated/src/models/Action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Action.js","sourceRoot":"","sources":["../../../../generated/src/models/Action.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,gBAAgB,EAEhB,cAAc,GAEjB,MAAM,eAAe,CAAC;AAsBvB;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC1C,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAS;IACpC,OAAO,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAS,EAAE,mBAA4B;IACvE,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACrC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAS;IAClC,OAAO,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAqB,EAAE,sBAA+B,KAAK;IACzF,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KACpC,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,32 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ActionId
+ */
+export interface ActionId {
+    /**
+     *
+     * @type {any}
+     * @memberof ActionId
+     */
+    value: any | null;
+}
+/**
+ * Check if a given object implements the ActionId interface.
+ */
+export declare function instanceOfActionId(value: object): value is ActionId;
+export declare function ActionIdFromJSON(json: any): ActionId;
+export declare function ActionIdFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActionId;
+export declare function ActionIdToJSON(json: any): ActionId;
+export declare function ActionIdToJSONTyped(value?: ActionId | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,44 @@
+/* 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ActionId interface.
+ */
+export function instanceOfActionId(value) {
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    return true;
+}
+export function ActionIdFromJSON(json) {
+    return ActionIdFromJSONTyped(json, false);
+}
+export function ActionIdFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'value': json['value'],
+    };
+}
+export function ActionIdToJSON(json) {
+    return ActionIdToJSONTyped(json, false);
+}
+export function ActionIdToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'value': value['value'],
+    };
+}
+//# sourceMappingURL=ActionId.js.map

package/dist/generated/src/models/ActionId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionId.js","sourceRoot":"","sources":["../../../../generated/src/models/ActionId.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAiBH;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC5C,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAS;IACtC,OAAO,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAS,EAAE,mBAA4B;IACzE,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;KACzB,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAS;IACpC,OAAO,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAuB,EAAE,sBAA+B,KAAK;IAC7F,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;KAC1B,CAAC;AACN,CAAC"}