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

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

@@ -0,0 +1,119 @@
+/* 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 { ContactInfoToJSON, ContactMethodResponseFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class ContactInfoApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getContactMethods without sending the request
+     */
+    async getContactMethodsRequestOpts(requestParameters) {
+        if (requestParameters['customerId'] == null) {
+            throw new runtime.RequiredError('customerId', 'Required parameter "customerId" was null or undefined when calling getContactMethods().');
+        }
+        const queryParameters = {};
+        if (requestParameters['userIdType'] != null) {
+            queryParameters['userIdType'] = requestParameters['userIdType'];
+        }
+        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/customers/{customerId}/contact-methods`;
+        urlPath = urlPath.replace(`{${"customerId"}}`, encodeURIComponent(String(requestParameters['customerId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * Fetch Contact Methods
+     */
+    async getContactMethodsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getContactMethodsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ContactMethodResponseFromJSON(jsonValue));
+    }
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * Fetch Contact Methods
+     */
+    async getContactMethods(requestParameters, initOverrides) {
+        const response = await this.getContactMethodsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for updateContactInfo without sending the request
+     */
+    async updateContactInfoRequestOpts(requestParameters) {
+        if (requestParameters['customerId'] == null) {
+            throw new runtime.RequiredError('customerId', 'Required parameter "customerId" was null or undefined when calling updateContactInfo().');
+        }
+        if (requestParameters['contactInfo'] == null) {
+            throw new runtime.RequiredError('contactInfo', 'Required parameter "contactInfo" was null or undefined when calling updateContactInfo().');
+        }
+        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/customers/{customerId}:contact-info`;
+        urlPath = urlPath.replace(`{${"customerId"}}`, encodeURIComponent(String(requestParameters['customerId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ContactInfoToJSON(requestParameters['contactInfo']),
+        };
+    }
+    /**
+     * Update contact info
+     * Update Contact Info
+     */
+    async updateContactInfoRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateContactInfoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Update contact info
+     * Update Contact Info
+     */
+    async updateContactInfo(requestParameters, initOverrides) {
+        await this.updateContactInfoRaw(requestParameters, initOverrides);
+    }
+}
+/**
+ * @export
+ */
+export const GetContactMethodsUserIdTypeEnum = {
+    CUSTOMER_ID: 'CUSTOMER_ID',
+    LOGIN_ID: 'LOGIN_ID'
+};
+//# sourceMappingURL=ContactInfoApi.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContactInfoApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/ContactInfoApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAMzC,OAAO,EAEH,iBAAiB,EACjB,6BAA6B,GAIhC,MAAM,oBAAoB,CAAC;AAyE5B;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,OAAO,CAAC,OAAO;IAE/C;;OAEG;IACH,KAAK,CAAC,4BAA4B,CAAC,iBAAyD;QACxF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,YAAY,EACZ,yFAAyF,CAC5F,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,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,4CAA4C,CAAC;QAC3D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,YAAY,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5G,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,oBAAoB,CAAC,iBAAyD,EAAE,aAA0D;QAC5I,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;QAClF,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,iBAAiB,CAAC,iBAAyD,EAAE,aAA0D;QACzI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,4BAA4B,CAAC,iBAAyD;QACxF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,YAAY,EACZ,yFAAyF,CAC5F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC;YAC3C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,aAAa,EACb,0FAA0F,CAC7F,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,yCAAyC,CAAC;QACxD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,YAAY,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5G,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;SAC5D,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAAyD,EAAE,aAA0D;QAC5I,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;QAClF,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,iBAAiB,CAAC,iBAAyD,EAAE,aAA0D;QACzI,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;CAEJ;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG;IAC3C,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;CACd,CAAC"}

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

@@ -0,0 +1,72 @@
+/**
+ * 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';
+export interface DataApiDownloadTransactionLogsRequest {
+    extHost: string;
+    institutionId: string;
+    date: Date;
+    accept: string;
+}
+/**
+ * DataApi - interface
+ *
+ * @export
+ * @interface DataApiInterface
+ */
+export interface DataApiInterface {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {Date} date Date to query (YYYY-MM-DD)
+     * @param {string} accept
+     * @throws {RequiredError}
+     * @memberof DataApiInterface
+     */
+    downloadTransactionLogsRequestOpts(requestParameters: DataApiDownloadTransactionLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * @summary Download Transaction Logs
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {Date} date Date to query (YYYY-MM-DD)
+     * @param {string} accept
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataApiInterface
+     */
+    downloadTransactionLogsRaw(requestParameters: DataApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download Transaction Logs
+     */
+    downloadTransactionLogs(requestParameters: DataApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}
+/**
+ *
+ */
+export declare class DataApi extends runtime.BaseAPI implements DataApiInterface {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     */
+    downloadTransactionLogsRequestOpts(requestParameters: DataApiDownloadTransactionLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download Transaction Logs
+     */
+    downloadTransactionLogsRaw(requestParameters: DataApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download Transaction Logs
+     */
+    downloadTransactionLogs(requestParameters: DataApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}

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

@@ -0,0 +1,83 @@
+/* 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';
+/**
+ *
+ */
+export class DataApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     */
+    async downloadTransactionLogsRequestOpts(requestParameters) {
+        if (requestParameters['extHost'] == null) {
+            throw new runtime.RequiredError('extHost', 'Required parameter "extHost" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['institutionId'] == null) {
+            throw new runtime.RequiredError('institutionId', 'Required parameter "institutionId" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['date'] == null) {
+            throw new runtime.RequiredError('date', 'Required parameter "date" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['accept'] == null) {
+            throw new runtime.RequiredError('accept', 'Required parameter "accept" was null or undefined when calling downloadTransactionLogs().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['extHost'] != null) {
+            headerParameters['ext_host'] = String(requestParameters['extHost']);
+        }
+        if (requestParameters['accept'] != null) {
+            headerParameters['Accept'] = String(requestParameters['accept']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/mx/download/{institution_id}/{date}/transactions/created`;
+        urlPath = urlPath.replace(`{${"institution_id"}}`, encodeURIComponent(String(requestParameters['institutionId'])));
+        if (requestParameters['date'] instanceof Date) {
+            urlPath = urlPath.replace(`{${"date"}}`, encodeURIComponent(requestParameters['date'].toISOString().substring(0, 10)));
+        }
+        else {
+            urlPath = urlPath.replace(`{${"date"}}`, encodeURIComponent(String(requestParameters['date'])));
+        }
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download Transaction Logs
+     */
+    async downloadTransactionLogsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.downloadTransactionLogsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.BlobApiResponse(response);
+    }
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download Transaction Logs
+     */
+    async downloadTransactionLogs(requestParameters, initOverrides) {
+        const response = await this.downloadTransactionLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+//# sourceMappingURL=DataApi.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/DataApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAgEzC;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,OAAO,CAAC,OAAO;IAExC;;OAEG;IACH,KAAK,CAAC,kCAAkC,CAAC,iBAAwD;QAC7F,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,4FAA4F,CAC/F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,eAAe,CAAC,IAAI,IAAI,EAAE,CAAC;YAC7C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,eAAe,EACf,kGAAkG,CACrG,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACpC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,MAAM,EACN,yFAAyF,CAC5F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,QAAQ,EACR,2FAA2F,CAC9F,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,gBAAgB,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,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,2DAA2D,CAAC;QAC1E,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,gBAAgB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACnH,IAAI,iBAAiB,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;YAC5C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,MAAM,GAAG,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1H,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,MAAM,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpG,CAAC;QAED,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,iBAAwD,EAAE,aAA0D;QACjJ,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,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAAwD,EAAE,aAA0D;QAC9I,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/ElectronicStatementsApi.d.ts

@@ -0,0 +1,202 @@
+/**
+ * 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 { EStatementDisclosureResponse, EStatementPreferencesRequest, EStatementReportRequest, EStatementReportResponse, EStatementRequest } from '../models/index.js';
+export interface ElectronicStatementsApiGetDisclosuresByAccountRequest {
+    accountId: string;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface ElectronicStatementsApiGetEstatementsReportRequest {
+    eStatementReportRequest: EStatementReportRequest;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface ElectronicStatementsApiUpdateEStatementPreferencesRequest {
+    eStatementPreferencesRequest: EStatementPreferencesRequest;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest {
+    eStatementRequest: EStatementRequest;
+    hostUserId?: string;
+    loginId?: string;
+}
+/**
+ * ElectronicStatementsApi - interface
+ *
+ * @export
+ * @interface ElectronicStatementsApiInterface
+ */
+export interface ElectronicStatementsApiInterface {
+    /**
+     * Creates request options for getDisclosuresByAccount without sending the request
+     * @param {string} accountId Unique identifier of financial institution customer account
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    getDisclosuresByAccountRequestOpts(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to fetch disclosure information for the particular account Id
+     * @summary Fetch Disclosure Information
+     * @param {string} accountId Unique identifier of financial institution customer account
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    getDisclosuresByAccountRaw(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementDisclosureResponse>>;
+    /**
+     * API to fetch disclosure information for the particular account Id
+     * Fetch Disclosure Information
+     */
+    getDisclosuresByAccount(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementDisclosureResponse>;
+    /**
+     * Creates request options for getEstatementsReport without sending the request
+     * @param {EStatementReportRequest} eStatementReportRequest Information needed for generating eStatement opt-in report
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    getEstatementsReportRequestOpts(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
+     * @summary Fetch Opt-in Data
+     * @param {EStatementReportRequest} eStatementReportRequest Information needed for generating eStatement opt-in report
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    getEstatementsReportRaw(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementReportResponse>>;
+    /**
+     * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
+     * Fetch Opt-in Data
+     */
+    getEstatementsReport(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementReportResponse>;
+    /**
+     * Creates request options for updateEStatementPreferences without sending the request
+     * @param {EStatementPreferencesRequest} eStatementPreferencesRequest Payload specifying the user\&#39;s preferred e-statement delivery method for all accounts.
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    updateEStatementPreferencesRequestOpts(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user.  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
+     * @summary Update User Electronic Statement Preferences
+     * @param {EStatementPreferencesRequest} eStatementPreferencesRequest Payload specifying the user\&#39;s preferred e-statement delivery method for all accounts.
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    updateEStatementPreferencesRaw(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user.  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
+     * Update User Electronic Statement Preferences
+     */
+    updateEStatementPreferences(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateStatementDeliveryPreference without sending the request
+     * @param {EStatementRequest} eStatementRequest Payload specifying the user\&#39;s preferred account statement delivery method (e-statement or mail) for a given account.
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    updateStatementDeliveryPreferenceRequestOpts(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**).  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
+     * @summary Update Account Electronic Statement Preferences
+     * @param {EStatementRequest} eStatementRequest Payload specifying the user\&#39;s preferred account statement delivery method (e-statement or mail) for a given account.
+     * @param {string} [hostUserId] Unique identifier for the user associated with the financial institution. This is used to provide context  for the account’s e-statement preference. This parameter is **required** when the access token is issued using the **client_credentials** **grant type**; otherwise, it is optional. This parameter cannot be used together with the **loginId** query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution, used to provide context for the account\&#39;s e-statement preference. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. This parameter cannot be used together with the **hostUserId** query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ElectronicStatementsApiInterface
+     */
+    updateStatementDeliveryPreferenceRaw(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**).  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
+     * Update Account Electronic Statement Preferences
+     */
+    updateStatementDeliveryPreference(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class ElectronicStatementsApi extends runtime.BaseAPI implements ElectronicStatementsApiInterface {
+    /**
+     * Creates request options for getDisclosuresByAccount without sending the request
+     */
+    getDisclosuresByAccountRequestOpts(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to fetch disclosure information for the particular account Id
+     * Fetch Disclosure Information
+     */
+    getDisclosuresByAccountRaw(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementDisclosureResponse>>;
+    /**
+     * API to fetch disclosure information for the particular account Id
+     * Fetch Disclosure Information
+     */
+    getDisclosuresByAccount(requestParameters: ElectronicStatementsApiGetDisclosuresByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementDisclosureResponse>;
+    /**
+     * Creates request options for getEstatementsReport without sending the request
+     */
+    getEstatementsReportRequestOpts(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
+     * Fetch Opt-in Data
+     */
+    getEstatementsReportRaw(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EStatementReportResponse>>;
+    /**
+     * Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.
+     * Fetch Opt-in Data
+     */
+    getEstatementsReport(requestParameters: ElectronicStatementsApiGetEstatementsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EStatementReportResponse>;
+    /**
+     * Creates request options for updateEStatementPreferences without sending the request
+     */
+    updateEStatementPreferencesRequestOpts(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user.  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
+     * Update User Electronic Statement Preferences
+     */
+    updateEStatementPreferencesRaw(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when the **MultiStatement** feature configured to `false` for the financial institution during the onboarding process. - **Disclosure** — The preference applies only where the applicable e-statement disclosure has been approved for the user.  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined in that operation. Then pass the token in the `Authorization` header as `Bearer <access_token>`. For full details, see the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Enables users to apply a unified statement delivery preference (online or mail) to **all** of their accounts.
+     * Update User Electronic Statement Preferences
+     */
+    updateEStatementPreferences(requestParameters: ElectronicStatementsApiUpdateEStatementPreferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateStatementDeliveryPreference without sending the request
+     */
+    updateStatementDeliveryPreferenceRequestOpts(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**).  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
+     * Update Account Electronic Statement Preferences
+     */
+    updateStatementDeliveryPreferenceRaw(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * ### Before you call  - **MultiStatement** — This API is available only when **MultiStatement** is configured **`true`** for the financial institution during the onboarding process (account-level statement preference). - **Disclosure** — The preference applies only when the required e-statement disclosure agreement exists for the **account** in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example **404**).  - **Access token** — Obtain a **V2** OAuth 2.0 access token by calling **`POST /oauth2/v1/token`** (Authentication API — **Create V2 access token**). Grant types, required headers (for example `institutionId`, `transactionid`), and form body are defined on that operation. Send the token in the `Authorization` header as `Bearer <access_token>`. See the [Authentication API reference](/api/generated/o-auth-v-2/).  ### Behavior  Updates whether account statements are delivered electronically or by mail for a **single** account. This preference is set per account, not for all accounts at once.
+     * Update Account Electronic Statement Preferences
+     */
+    updateStatementDeliveryPreference(requestParameters: ElectronicStatementsApiUpdateStatementDeliveryPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}