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

package/dist/generated/src/apis/TemplatesApi.js

@@ -0,0 +1,218 @@
+/* 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 * as runtime from '../runtime.js';
+import { AlertTemplateResourceFromJSON, AlertTemplateResourceToJSON, AlertTemplateResourcesFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class TemplatesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTemplate without sending the request
+     */
+    async createTemplateRequestOpts(requestParameters) {
+        if (requestParameters['alertTemplateResource'] == null) {
+            throw new runtime.RequiredError('alertTemplateResource', 'Required parameter "alertTemplateResource" was null or undefined when calling createTemplate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/alert-templates`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AlertTemplateResourceToJSON(requestParameters['alertTemplateResource']),
+        };
+    }
+    /**
+     * Create a new alert template for your financial institution. When you create a template, you define: - A unique ID, name, and status (Draft, Archived, or Published) - The content type (such as EMAIL_SUBJECT, EMAIL_BODY, or SMS_BODY) - The notification channel (Email, SMS, or Push) - The language locale (such as US English or Spanish) - For third-party vendor events, the vendor name
+     * Create Alert Template
+     */
+    async createTemplateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createTemplateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertTemplateResourceFromJSON(jsonValue));
+    }
+    /**
+     * Create a new alert template for your financial institution. When you create a template, you define: - A unique ID, name, and status (Draft, Archived, or Published) - The content type (such as EMAIL_SUBJECT, EMAIL_BODY, or SMS_BODY) - The notification channel (Email, SMS, or Push) - The language locale (such as US English or Spanish) - For third-party vendor events, the vendor name
+     * Create Alert Template
+     */
+    async createTemplate(requestParameters, initOverrides) {
+        const response = await this.createTemplateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for deleteTemplate without sending the request
+     */
+    async deleteTemplateRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteTemplate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/alert-templates/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Delete an alert template that is no longer needed. This permanently removes the template from the database.
+     * Delete Alert Template
+     */
+    async deleteTemplateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.deleteTemplateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Delete an alert template that is no longer needed. This permanently removes the template from the database.
+     * Delete Alert Template
+     */
+    async deleteTemplate(requestParameters, initOverrides) {
+        await this.deleteTemplateRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Creates request options for listTemplates without sending the request
+     */
+    async listTemplatesRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['alertTypeName'] != null) {
+            queryParameters['alertTypeName'] = requestParameters['alertTypeName'];
+        }
+        if (requestParameters['channel'] != null) {
+            queryParameters['channel'] = requestParameters['channel'];
+        }
+        if (requestParameters['id'] != null) {
+            queryParameters['id'] = requestParameters['id'];
+        }
+        if (requestParameters['locale'] != null) {
+            queryParameters['locale'] = requestParameters['locale'];
+        }
+        if (requestParameters['state'] != null) {
+            queryParameters['state'] = requestParameters['state'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/alert-templates`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieve a list of all alert templates configured for the financial institution. The response includes all templates in any state (Draft, Archived, or Published) with their configured values. Use query parameters to filter results by alert type name, channel, content type, locale, or status.
+     * List Alert Templates
+     */
+    async listTemplatesRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listTemplatesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertTemplateResourcesFromJSON(jsonValue));
+    }
+    /**
+     * Retrieve a list of all alert templates configured for the financial institution. The response includes all templates in any state (Draft, Archived, or Published) with their configured values. Use query parameters to filter results by alert type name, channel, content type, locale, or status.
+     * List Alert Templates
+     */
+    async listTemplates(requestParameters = {}, initOverrides) {
+        const response = await this.listTemplatesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for updateTemplate without sending the request
+     */
+    async updateTemplateRequestOpts(requestParameters) {
+        if (requestParameters['alertTemplateResource'] == null) {
+            throw new runtime.RequiredError('alertTemplateResource', 'Required parameter "alertTemplateResource" was null or undefined when calling updateTemplate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/alert-templates`;
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AlertTemplateResourceToJSON(requestParameters['alertTemplateResource']),
+        };
+    }
+    /**
+     * Update an existing alert template. You can modify the template content, status, channel, content type, and locale settings.
+     * Update Alert Template
+     */
+    async updateTemplateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateTemplateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertTemplateResourceFromJSON(jsonValue));
+    }
+    /**
+     * Update an existing alert template. You can modify the template content, status, channel, content type, and locale settings.
+     * Update Alert Template
+     */
+    async updateTemplate(requestParameters, initOverrides) {
+        const response = await this.updateTemplateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+/**
+ * @export
+ */
+export const ListTemplatesChannelEnum = {
+    EMAIL: 'EMAIL',
+    SMS: 'SMS',
+    PUSH: 'PUSH',
+    WEB: 'WEB'
+};
+/**
+ * @export
+ */
+export const ListTemplatesStateEnum = {
+    DRAFT: 'DRAFT',
+    PUBLISHED: 'PUBLISHED',
+    ARCHIVED: 'ARCHIVED'
+};
+//# sourceMappingURL=TemplatesApi.js.map

package/dist/generated/src/apis/TemplatesApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplatesApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/TemplatesApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAMzC,OAAO,EACH,6BAA6B,EAC7B,2BAA2B,EAC3B,8BAA8B,GAIjC,MAAM,oBAAoB,CAAC;AAuI5B;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAoD;QAChF,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,uBAAuB,EACvB,iGAAiG,CACpG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,qBAAqB,CAAC;QAEpC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,2BAA2B,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;SAChF,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAAoD,EAAE,aAA0D;QACpI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAoD,EAAE,aAA0D;QACjI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAChF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAoD;QAChF,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,IAAI,EACJ,8EAA8E,CACjF,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,0BAA0B,CAAC;QACzC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5F,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAAoD,EAAE,aAA0D;QACpI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAoD,EAAE,aAA0D;QACjI,MAAM,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAAmD;QAC9E,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,eAAe,CAAC,IAAI,IAAI,EAAE,CAAC;YAC7C,eAAe,CAAC,eAAe,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC1E,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,eAAe,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,qBAAqB,CAAC;QAEpC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,iBAAmD,EAAE,aAA0D;QAClI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,oBAAsD,EAAE,EAAE,aAA0D;QACpI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC/E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAoD;QAChF,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,uBAAuB,EACvB,iGAAiG,CACpG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,qBAAqB,CAAC;QAEpC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,2BAA2B,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;SAChF,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAAoD,EAAE,aAA0D;QACpI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAoD,EAAE,aAA0D;QACjI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAChF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACpC,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;CACJ,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IAClC,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;CACd,CAAC"}

package/dist/generated/src/apis/TransactionsApi.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 * as runtime from '../runtime.js';
+import type { TransactionsResponse } from '../models/index.js';
+export interface TransactionsApiListAccountTransactionsRequest {
+    accountId: string;
+    hostUserId?: string;
+    loginId?: string;
+    institutionCustomerId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    retrieveFutureTransactions?: boolean;
+    $skip?: number;
+    $top?: number;
+    $filter?: string;
+    isCreditTransaction?: boolean;
+    additionalFields?: boolean;
+}
+/**
+ * TransactionsApi - interface
+ *
+ * @export
+ * @interface TransactionsApiInterface
+ */
+export interface TransactionsApiInterface {
+    /**
+     * Creates request options for listAccountTransactions without sending the request
+     * @param {string} accountId Unique identifier of the account associated with the requested transactions.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [startDate] Inclusive beginning of the transaction date range, specified as an ISO 8601 calendar date (YYYY-MM-DD).  If omitted, the service applies institution defaults: when endDate is provided, startDate is derived from it using the FI‑configured default range (adjusted when retrieveFutureTransactions is enabled). If both dates are omitted, the service builds a default range ending in the near future based on FI configuration.  When both startDate and endDate are supplied, startDate must be on or before endDate; invalid values or ranges result in error TXN_10001.
+     * @param {Date} [endDate] Inclusive end of the transaction date range, specified as an ISO 8601 calendar date (YYYY-MM-DD).  When retrieveFutureTransactions is true, any supplied endDate is ignored and the service sets the end date to today plus an FI‑configured number of future days.  If endDate is omitted but startDate is provided, the service derives the end date using FI defaults, adjusting to a future‑days window when applicable. When both dates are supplied, endDate must be on or after startDate; invalid values or ranges result in error TXN_10001.
+     * @param {boolean} [retrieveFutureTransactions] When set to true, overrides the effective endDate to today plus an FI‑configured number of future days; any provided endDate is ignored. The calculated end date is used for all subsequent date‑range logic, including defaulting startDate when omitted.
+     * @param {number} [$skip] OData‑style parameter that specifies the number of transactions to omit from the start of the date‑range result set before $top is applied. May be used alone or together with $top. The value must be a non‑negative integer; negative values are rejected with TXN_10005. If $skip is greater than or equal to the number of transactions in range, the result set is empty. Pagination links are included when used with $top. Pagination errors may result in TXN_20006.  Processing order: date range → $skip / $top → $filter → isCreditTransaction
+     * @param {number} [$top] OData‑style parameter that limits the maximum number of transactions returned after $skip is applied. May be used alone or together with $skip. If the value is below the FI‑configured minimum transactions per request, it is raised to that minimum. Pagination links are included when used with $skip. Pagination errors may result in TXN_20006.  Processing order: date range → $skip / $top → $filter → isCreditTransaction
+     * @param {string} [$filter] OData $filter expression evaluated in memory on each transaction after the date range is applied and after $skip / $top paging. The expression is parsed using Apache Olingo and evaluated against each transaction. Supported properties include id and description (case‑insensitive). Supported operators and functions include eq, ne, ge, gt, le, lt, and, or, string and integer literals, and string functions contains, tolower, and toupper. Unsupported expressions or evaluation errors result in error TXN_20005.
+     * @param {boolean} [isCreditTransaction] Optional filter that narrows results based on a transaction’s credit or debit designation. When set to true, only credit transactions are returned; when set to false, only debit (non‑credit) transactions are returned. When omitted, no credit/debit filtering is applied and both types are returned, subject to date range, $skip / $top, and $filter.
+     * @param {boolean} [additionalFields] When set to true, the service retrieves the institution\&#39;s time zone along with the transaction data and includes a top‑level additionalInfo object in the response containing  timeZone (time zone ID), timeZoneOffset (GMT offset in whole hours). If the time‑zone  lookup fails, the request fails entirely.
+     * @throws {RequiredError}
+     * @memberof TransactionsApiInterface
+     */
+    listAccountTransactionsRequestOpts(requestParameters: TransactionsApiListAccountTransactionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * @summary List Account Transactions
+     * @param {string} accountId Unique identifier of the account associated with the requested transactions.
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] Identifies the institution customer (business location) whose accounts should be returned. This parameter is applicable to Business Banking users with access to multiple locations. When provided, results are limited to accounts associated with the specified institution customer.
+     * @param {Date} [startDate] Inclusive beginning of the transaction date range, specified as an ISO 8601 calendar date (YYYY-MM-DD).  If omitted, the service applies institution defaults: when endDate is provided, startDate is derived from it using the FI‑configured default range (adjusted when retrieveFutureTransactions is enabled). If both dates are omitted, the service builds a default range ending in the near future based on FI configuration.  When both startDate and endDate are supplied, startDate must be on or before endDate; invalid values or ranges result in error TXN_10001.
+     * @param {Date} [endDate] Inclusive end of the transaction date range, specified as an ISO 8601 calendar date (YYYY-MM-DD).  When retrieveFutureTransactions is true, any supplied endDate is ignored and the service sets the end date to today plus an FI‑configured number of future days.  If endDate is omitted but startDate is provided, the service derives the end date using FI defaults, adjusting to a future‑days window when applicable. When both dates are supplied, endDate must be on or after startDate; invalid values or ranges result in error TXN_10001.
+     * @param {boolean} [retrieveFutureTransactions] When set to true, overrides the effective endDate to today plus an FI‑configured number of future days; any provided endDate is ignored. The calculated end date is used for all subsequent date‑range logic, including defaulting startDate when omitted.
+     * @param {number} [$skip] OData‑style parameter that specifies the number of transactions to omit from the start of the date‑range result set before $top is applied. May be used alone or together with $top. The value must be a non‑negative integer; negative values are rejected with TXN_10005. If $skip is greater than or equal to the number of transactions in range, the result set is empty. Pagination links are included when used with $top. Pagination errors may result in TXN_20006.  Processing order: date range → $skip / $top → $filter → isCreditTransaction
+     * @param {number} [$top] OData‑style parameter that limits the maximum number of transactions returned after $skip is applied. May be used alone or together with $skip. If the value is below the FI‑configured minimum transactions per request, it is raised to that minimum. Pagination links are included when used with $skip. Pagination errors may result in TXN_20006.  Processing order: date range → $skip / $top → $filter → isCreditTransaction
+     * @param {string} [$filter] OData $filter expression evaluated in memory on each transaction after the date range is applied and after $skip / $top paging. The expression is parsed using Apache Olingo and evaluated against each transaction. Supported properties include id and description (case‑insensitive). Supported operators and functions include eq, ne, ge, gt, le, lt, and, or, string and integer literals, and string functions contains, tolower, and toupper. Unsupported expressions or evaluation errors result in error TXN_20005.
+     * @param {boolean} [isCreditTransaction] Optional filter that narrows results based on a transaction’s credit or debit designation. When set to true, only credit transactions are returned; when set to false, only debit (non‑credit) transactions are returned. When omitted, no credit/debit filtering is applied and both types are returned, subject to date range, $skip / $top, and $filter.
+     * @param {boolean} [additionalFields] When set to true, the service retrieves the institution\&#39;s time zone along with the transaction data and includes a top‑level additionalInfo object in the response containing  timeZone (time zone ID), timeZoneOffset (GMT offset in whole hours). If the time‑zone  lookup fails, the request fails entirely.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransactionsApiInterface
+     */
+    listAccountTransactionsRaw(requestParameters: TransactionsApiListAccountTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * List Account Transactions
+     */
+    listAccountTransactions(requestParameters: TransactionsApiListAccountTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+}
+/**
+ *
+ */
+export declare class TransactionsApi extends runtime.BaseAPI implements TransactionsApiInterface {
+    /**
+     * Creates request options for listAccountTransactions without sending the request
+     */
+    listAccountTransactionsRequestOpts(requestParameters: TransactionsApiListAccountTransactionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * List Account Transactions
+     */
+    listAccountTransactionsRaw(requestParameters: TransactionsApiListAccountTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * List Account Transactions
+     */
+    listAccountTransactions(requestParameters: TransactionsApiListAccountTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+}

package/dist/generated/src/apis/TransactionsApi.js

@@ -0,0 +1,98 @@
+/* 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 * as runtime from '../runtime.js';
+import { TransactionsResponseFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class TransactionsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for listAccountTransactions without sending the request
+     */
+    async listAccountTransactionsRequestOpts(requestParameters) {
+        if (requestParameters['accountId'] == null) {
+            throw new runtime.RequiredError('accountId', 'Required parameter "accountId" was null or undefined when calling listAccountTransactions().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['institutionCustomerId'] != null) {
+            queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
+        }
+        if (requestParameters['accountId'] != null) {
+            queryParameters['accountId'] = requestParameters['accountId'];
+        }
+        if (requestParameters['startDate'] != null) {
+            queryParameters['startDate'] = requestParameters['startDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['endDate'] != null) {
+            queryParameters['endDate'] = requestParameters['endDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['retrieveFutureTransactions'] != null) {
+            queryParameters['retrieveFutureTransactions'] = requestParameters['retrieveFutureTransactions'];
+        }
+        if (requestParameters['$skip'] != null) {
+            queryParameters['$skip'] = requestParameters['$skip'];
+        }
+        if (requestParameters['$top'] != null) {
+            queryParameters['$top'] = requestParameters['$top'];
+        }
+        if (requestParameters['$filter'] != null) {
+            queryParameters['$filter'] = requestParameters['$filter'];
+        }
+        if (requestParameters['isCreditTransaction'] != null) {
+            queryParameters['isCreditTransaction'] = requestParameters['isCreditTransaction'];
+        }
+        if (requestParameters['additionalFields'] != null) {
+            queryParameters['additionalFields'] = requestParameters['additionalFields'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/transactions`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * List Account Transactions
+     */
+    async listAccountTransactionsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listAccountTransactionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => TransactionsResponseFromJSON(jsonValue));
+    }
+    /**
+     * Retrieve transaction history for a specified account. It returns a record of financial actions performed by a customer, including deposits, withdrawals, transfers, and payments. The endpoint supports date-based filtering, pending and future transaction retrieval, and business‑banking–specific scoping, while providing detailed transaction metadata suitable for display, reconciliation, and downstream processing.  **Use this endpoint to:** - Retrieve a complete history of posted, pending, and future‑dated transactions for a   customer account - Filter transaction results by a specific date range to support statements, reporting, and   reviews - Present transaction activity for customer‑facing displays such as account history and   statements - Access transactions scoped to a specific business banking location - Obtain detailed transaction metadata to support reconciliation, auditing, and downstream   processing  **Behavior and capabilities:** - Retrieves transactions for a specified accountId, including both posted and pending items,   with pending status explicitly indicated for each transaction. - Supports filtering transactions by an inclusive date range using startDate and endDate,   provided in ISO 8601 format (YYYY-MM-DD), with validation to ensure a valid range. - Applies a financial‑institution–configured default date range when no date parameters are   supplied. - Enables retrieval of future‑dated transactions when retrieveFutureTransactions is set to   true, overriding any provided endDate based on institution configuration. - Returns comprehensive transaction details—including transaction identifiers, dates,   descriptions, memos, amounts, currency codes, transaction types, statuses, fee details,   and optional image metadata for checks and deposit slips when available. - Supports Business Banking scoping via institutionCustomerId.
+     * List Account Transactions
+     */
+    async listAccountTransactions(requestParameters, initOverrides) {
+        const response = await this.listAccountTransactionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+//# sourceMappingURL=TransactionsApi.js.map

package/dist/generated/src/apis/TransactionsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionsApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/TransactionsApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAKzC,OAAO,EAGH,4BAA4B,GAE/B,MAAM,oBAAoB,CAAC;AAwE5B;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,OAAO,CAAC,OAAO;IAEhD;;OAEG;IACH,KAAK,CAAC,kCAAkC,CAAC,iBAAgE;QACrG,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,WAAW,EACX,8FAA8F,CACjG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,eAAe,CAAC,uBAAuB,CAAC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,eAAe,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,eAAe,CAAC,WAAW,CAAC,GAAI,iBAAiB,CAAC,WAAW,CAAS,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC;QACzG,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAI,iBAAiB,CAAC,SAAS,CAAS,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC;QACrG,CAAC;QAED,IAAI,iBAAiB,CAAC,4BAA4B,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1D,eAAe,CAAC,4BAA4B,CAAC,GAAG,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;QACpG,CAAC;QAED,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACpC,eAAe,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,eAAe,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,IAAI,EAAE,CAAC;YACnD,eAAe,CAAC,qBAAqB,CAAC,GAAG,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,eAAe,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,kBAAkB,CAAC;QAEjC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,0BAA0B,CAAC,iBAAgE,EAAE,aAA0D;QACzJ,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kCAAkC,CAAC,iBAAiB,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAAgE,EAAE,aAA0D;QACtJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACzF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ"}

package/dist/generated/src/apis/TransfersApi.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 * as runtime from '../runtime.js';
+import type { Transfer } from '../models/index.js';
+export interface TransfersApiCreateTransferRequest {
+    hostUserId?: string;
+    loginId?: string;
+    transferRequest?: Transfer;
+}
+/**
+ * TransfersApi - interface
+ *
+ * @export
+ * @interface TransfersApiInterface
+ */
+export interface TransfersApiInterface {
+    /**
+     * Creates request options for createTransfer without sending the request
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Transfer} [transferRequest] The transfer request object containing source account, destination account, amount,  and optional scheduling information.
+     * @throws {RequiredError}
+     * @memberof TransfersApiInterface
+     */
+    createTransferRequestOpts(requestParameters: TransfersApiCreateTransferRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * @summary Create Transfer
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {Transfer} [transferRequest] The transfer request object containing source account, destination account, amount,  and optional scheduling information.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransfersApiInterface
+     */
+    createTransferRaw(requestParameters: TransfersApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Transfer>>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create Transfer
+     */
+    createTransfer(requestParameters: TransfersApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Transfer>;
+}
+/**
+ *
+ */
+export declare class TransfersApi extends runtime.BaseAPI implements TransfersApiInterface {
+    /**
+     * Creates request options for createTransfer without sending the request
+     */
+    createTransferRequestOpts(requestParameters: TransfersApiCreateTransferRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create Transfer
+     */
+    createTransferRaw(requestParameters: TransfersApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Transfer>>;
+    /**
+     * Creates a one-time or scheduled recurring transfer between accounts. Supports various  transfer types including standard transfers, loan payments, and IRA contributions.  **Transfer Types:** - **Standard**: Regular transfer between user\'s own accounts - **Recipient**: Transfer to another member at the same institution - **Loan Payment**: Transfer to pay down a loan balance - **IRA Contribution**: Transfer for retirement account contributions  **Scheduling Options:** - **One-time**: Execute immediately or on a specific future date - **Recurring**: Set up automatic transfers on a schedule (daily, weekly, monthly, etc.)  **Payment Options for Loans:** - `DEFAULT`: Standard payment - `PRINCIPAL_ONLY`: Apply payment to principal only - `INTEREST_ONLY`: Apply payment to interest only - `EXCESS_TO_PRINCIPAL`: Extra amount goes to principal - `EXCESS_TO_INTEREST`: Extra amount goes to interest
+     * Create Transfer
+     */
+    createTransfer(requestParameters?: TransfersApiCreateTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Transfer>;
+}