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

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

@@ -0,0 +1,138 @@
+/**
+ * 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 { InstitutionDisclosure, InstitutionDisclosureCreateRequest, InstitutionDisclosureUpdateRequest, InstitutionDisclosuresResponse } from '../models/index.js';
+export interface InstitutionDisclosuresApiCreateInstitutionDisclosureRequest {
+    institutionDisclosureCreateRequest: InstitutionDisclosureCreateRequest;
+}
+export interface InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest {
+    institutionDisclosureId: string;
+    institutionDisclosureUpdateRequest: InstitutionDisclosureUpdateRequest;
+}
+/**
+ * InstitutionDisclosuresApi - interface
+ *
+ * @export
+ * @interface InstitutionDisclosuresApiInterface
+ */
+export interface InstitutionDisclosuresApiInterface {
+    /**
+     * Creates request options for createInstitutionDisclosure without sending the request
+     * @param {InstitutionDisclosureCreateRequest} institutionDisclosureCreateRequest Request payload used to create an institution disclosure.
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    createInstitutionDisclosureRequestOpts(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * @summary Create Institution Disclosure
+     * @param {InstitutionDisclosureCreateRequest} institutionDisclosureCreateRequest Request payload used to create an institution disclosure.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    createInstitutionDisclosureRaw(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * Create Institution Disclosure
+     */
+    createInstitutionDisclosure(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
+    /**
+     * Creates request options for listInstitutionDisclosures without sending the request
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    listInstitutionDisclosuresRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * @summary List Institution Disclosures
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    listInstitutionDisclosuresRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosuresResponse>>;
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * List Institution Disclosures
+     */
+    listInstitutionDisclosures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosuresResponse>;
+    /**
+     * Creates request options for updateInstitutionDisclosure without sending the request
+     * @param {string} institutionDisclosureId Unique identifier of the institution disclosure associated with the financial institution.
+     * @param {InstitutionDisclosureUpdateRequest} institutionDisclosureUpdateRequest Request payload used to update an institution disclosure.
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    updateInstitutionDisclosureRequestOpts(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * @summary Update Institution Disclosure
+     * @param {string} institutionDisclosureId Unique identifier of the institution disclosure associated with the financial institution.
+     * @param {InstitutionDisclosureUpdateRequest} institutionDisclosureUpdateRequest Request payload used to update an institution disclosure.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionDisclosuresApiInterface
+     */
+    updateInstitutionDisclosureRaw(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * Update Institution Disclosure
+     */
+    updateInstitutionDisclosure(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
+}
+/**
+ *
+ */
+export declare class InstitutionDisclosuresApi extends runtime.BaseAPI implements InstitutionDisclosuresApiInterface {
+    /**
+     * Creates request options for createInstitutionDisclosure without sending the request
+     */
+    createInstitutionDisclosureRequestOpts(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * Create Institution Disclosure
+     */
+    createInstitutionDisclosureRaw(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * Create Institution Disclosure
+     */
+    createInstitutionDisclosure(requestParameters: InstitutionDisclosuresApiCreateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
+    /**
+     * Creates request options for listInstitutionDisclosures without sending the request
+     */
+    listInstitutionDisclosuresRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * List Institution Disclosures
+     */
+    listInstitutionDisclosuresRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosuresResponse>>;
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * List Institution Disclosures
+     */
+    listInstitutionDisclosures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosuresResponse>;
+    /**
+     * Creates request options for updateInstitutionDisclosure without sending the request
+     */
+    updateInstitutionDisclosureRequestOpts(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * Update Institution Disclosure
+     */
+    updateInstitutionDisclosureRaw(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionDisclosure>>;
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * Update Institution Disclosure
+     */
+    updateInstitutionDisclosure(requestParameters: InstitutionDisclosuresApiUpdateInstitutionDisclosureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionDisclosure>;
+}

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

@@ -0,0 +1,149 @@
+/* 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 { InstitutionDisclosureFromJSON, InstitutionDisclosureCreateRequestToJSON, InstitutionDisclosureUpdateRequestToJSON, InstitutionDisclosuresResponseFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class InstitutionDisclosuresApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createInstitutionDisclosure without sending the request
+     */
+    async createInstitutionDisclosureRequestOpts(requestParameters) {
+        if (requestParameters['institutionDisclosureCreateRequest'] == null) {
+            throw new runtime.RequiredError('institutionDisclosureCreateRequest', 'Required parameter "institutionDisclosureCreateRequest" was null or undefined when calling createInstitutionDisclosure().');
+        }
+        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/institution-disclosures`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: InstitutionDisclosureCreateRequestToJSON(requestParameters['institutionDisclosureCreateRequest']),
+        };
+    }
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * Create Institution Disclosure
+     */
+    async createInstitutionDisclosureRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createInstitutionDisclosureRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosureFromJSON(jsonValue));
+    }
+    /**
+     * This endpoint is part of the Disclosures Service, which manages disclosure definitions for financial institutions and tracks user acceptance of those disclosures in digital banking applications. Institution disclosures define the disclosures that must be presented to users (for example, online statements or regulatory agreements) and serve as the source of truth for downstream user disclosure workflows.  Creates a new institution disclosure definition for the financial institution associated with the authenticated caller. The service validates the request, persists the disclosure, returns the created record (including the newly assigned disclosure identifier), and evicts the institution disclosures cache for that financial institution.  **Use this endpoint to:** - Create a new disclosure definition for a financial institution. - Configure disclosure content that will later be presented to users during onboarding or   account-related flows. - Enable an institution to manage which disclosures are available for user acceptance.  **Behavior and capabilities:** - The request body must include `institutionDisclosureName`. Do not send   `institutionDisclosureId` on create; the identifier is assigned by the downstream service   and returned in the response. - Optional disclosure content is supported only as a URL; if `institutionDisclosureData` is   present, `institutionDisclosureDataType` must be `URL`. If both data and type are omitted,   the disclosure is created without URL content. - All request values must be printable ASCII and comply with field length limits enforced by   the service.
+     * Create Institution Disclosure
+     */
+    async createInstitutionDisclosure(requestParameters, initOverrides) {
+        const response = await this.createInstitutionDisclosureRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for listInstitutionDisclosures without sending the request
+     */
+    async listInstitutionDisclosuresRequestOpts() {
+        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/institution-disclosures`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * List Institution Disclosures
+     */
+    async listInstitutionDisclosuresRaw(initOverrides) {
+        const requestOptions = await this.listInstitutionDisclosuresRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosuresResponseFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves all institution disclosure definitions configured for the financial institution associated with the authenticated caller. This endpoint returns the authoritative set of disclosures that govern what disclosure content may be presented to users in downstream onboarding, enrollment, or account servicing flows.  **Use this endpoint to:** - Retrieve the complete set of disclosures configured for an institution. - Drive UI or integration flows that need to display or evaluate available disclosures. - Audit or verify disclosure configuration for the financial institution.  **Behavior and capabilities:** - Disclosures include all configured disclosure definitions (stored content and status),   regardless of enabled or disabled status. - Optional URL or raw content is included for disclosures that have it. - The `institutionDisclosureStatus` is included for disclosures that have it. - Responses are cache‑backed per institution; on a cache miss, disclosures are loaded from   backend service and cached using an institution‑specific TTL before being returned. - A successful response returns HTTP 200 with either a populated or empty   institutionDisclosures collection.
+     * List Institution Disclosures
+     */
+    async listInstitutionDisclosures(initOverrides) {
+        const response = await this.listInstitutionDisclosuresRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for updateInstitutionDisclosure without sending the request
+     */
+    async updateInstitutionDisclosureRequestOpts(requestParameters) {
+        if (requestParameters['institutionDisclosureId'] == null) {
+            throw new runtime.RequiredError('institutionDisclosureId', 'Required parameter "institutionDisclosureId" was null or undefined when calling updateInstitutionDisclosure().');
+        }
+        if (requestParameters['institutionDisclosureUpdateRequest'] == null) {
+            throw new runtime.RequiredError('institutionDisclosureUpdateRequest', 'Required parameter "institutionDisclosureUpdateRequest" was null or undefined when calling updateInstitutionDisclosure().');
+        }
+        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/institution-disclosures/{institutionDisclosureId}`;
+        urlPath = urlPath.replace(`{${"institutionDisclosureId"}}`, encodeURIComponent(String(requestParameters['institutionDisclosureId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: InstitutionDisclosureUpdateRequestToJSON(requestParameters['institutionDisclosureUpdateRequest']),
+        };
+    }
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * Update Institution Disclosure
+     */
+    async updateInstitutionDisclosureRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateInstitutionDisclosureRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => InstitutionDisclosureFromJSON(jsonValue));
+    }
+    /**
+     * Updates an existing institution disclosure definition for the financial institution associated with the authenticated caller. This endpoint allows changes to disclosure configuration or content and returns the updated disclosure as persisted by the service. Updates take effect immediately for downstream user disclosure workflows.  **Use this endpoint to:** - Modify an existing institution disclosure’s name, content, or enabled status. - Update disclosure configuration that controls how disclosures are presented to users. - Keep institution disclosure definitions in sync with regulatory or business changes.  **Behavior and capabilities:** - The disclosure to update is identified by `{institutionDisclosureId}` in the path and must   match the `institutionDisclosureId` provided in the request body (case-insensitive). - Requests are validated for required fields, printable ASCII, length limits, and proper   pairing of disclosure data and data type before being persisted. - Optional URL content: if `institutionDisclosureData` is present,   `institutionDisclosureDataType` must be `URL`; if either data or type is supplied alone,   the request is rejected. - Disclosure updates are persisted through backend service and the institution disclosures   cache is evicted to ensure subsequent reads reflect the update.
+     * Update Institution Disclosure
+     */
+    async updateInstitutionDisclosure(requestParameters, initOverrides) {
+        const response = await this.updateInstitutionDisclosureRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+//# sourceMappingURL=InstitutionDisclosuresApi.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InstitutionDisclosuresApi.js","sourceRoot":"","sources":["../../../../generated/src/apis/InstitutionDisclosuresApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AASzC,OAAO,EAKH,6BAA6B,EAG7B,wCAAwC,EAExC,wCAAwC,EACxC,sCAAsC,GAEzC,MAAM,oBAAoB,CAAC;AA4F5B;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAO,CAAC,OAAO;IAE1D;;OAEG;IACH,KAAK,CAAC,sCAAsC,CAAC,iBAA8E;QACvH,IAAI,iBAAiB,CAAC,oCAAoC,CAAC,IAAI,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,oCAAoC,EACpC,2HAA2H,CAC9H,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,6BAA6B,CAAC;QAE5C,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,wCAAwC,CAAC,iBAAiB,CAAC,oCAAoC,CAAC,CAAC;SAC1G,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,8BAA8B,CAAC,iBAA8E,EAAE,aAA0D;QAC3K,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,iBAAiB,CAAC,CAAC;QAC5F,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,2BAA2B,CAAC,iBAA8E,EAAE,aAA0D;QACxK,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qCAAqC;QACvC,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,6BAA6B,CAAC;QAE5C,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,6BAA6B,CAAC,aAA0D;QAC1F,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,qCAAqC,EAAE,CAAC;QAC1E,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,sCAAsC,CAAC,SAAS,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,0BAA0B,CAAC,aAA0D;QACvF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,6BAA6B,CAAC,aAAa,CAAC,CAAC;QACzE,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sCAAsC,CAAC,iBAA8E;QACvH,IAAI,iBAAiB,CAAC,yBAAyB,CAAC,IAAI,IAAI,EAAE,CAAC;YACvD,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,yBAAyB,EACzB,gHAAgH,CACnH,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,oCAAoC,CAAC,IAAI,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,oCAAoC,EACpC,2HAA2H,CAC9H,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,uDAAuD,CAAC;QACtE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,yBAAyB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtI,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,wCAAwC,CAAC,iBAAiB,CAAC,oCAAoC,CAAC,CAAC;SAC1G,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,8BAA8B,CAAC,iBAA8E,EAAE,aAA0D;QAC3K,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,iBAAiB,CAAC,CAAC;QAC5F,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,2BAA2B,CAAC,iBAA8E,EAAE,aAA0D;QACxK,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ"}

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

@@ -0,0 +1,181 @@
+/**
+ * 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 { FiAlertPreferenceResource, FiAlertPreferenceResources } from '../models/index.js';
+export interface InstitutionPreferencesApiCreateInstitutionRequest {
+    fiAlertPreferenceResource: FiAlertPreferenceResource;
+}
+export interface InstitutionPreferencesApiDeleteInstitutionRequest {
+    institutionAlertPreferenceId: number;
+}
+export interface InstitutionPreferencesApiListInstitutionRequest {
+    alertTypes?: string;
+}
+export interface InstitutionPreferencesApiUpdateInstitutionRequest {
+    institutionAlertPreferenceId: number;
+    fiAlertPreferenceResource?: FiAlertPreferenceResource;
+}
+/**
+ * InstitutionPreferencesApi - interface
+ *
+ * @export
+ * @interface InstitutionPreferencesApiInterface
+ */
+export interface InstitutionPreferencesApiInterface {
+    /**
+     * Creates request options for createInstitution without sending the request
+     * @param {FiAlertPreferenceResource} fiAlertPreferenceResource fiAlertPreferenceModel
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    createInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create user alert preference of certain user with destination presence earlier
+     * @summary Create Institution Alert Preference
+     * @param {FiAlertPreferenceResource} fiAlertPreferenceResource fiAlertPreferenceModel
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    createInstitutionRaw(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
+    /**
+     * Create user alert preference of certain user with destination presence earlier
+     * Create Institution Alert Preference
+     */
+    createInstitution(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
+    /**
+     * Creates request options for deleteInstitution without sending the request
+     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    deleteInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removal of particular user alert preference
+     * @summary Delete Institution Alert Preference
+     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    deleteInstitutionRaw(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removal of particular user alert preference
+     * Delete Institution Alert Preference
+     */
+    deleteInstitution(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listInstitution without sending the request
+     * @param {string} [alertTypes] alertTypes
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    listInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiListInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * GET FI preference list with opt in or opt out status
+     * @summary List Institution Alert Preferences
+     * @param {string} [alertTypes] alertTypes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    listInstitutionRaw(requestParameters: InstitutionPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResources>>;
+    /**
+     * GET FI preference list with opt in or opt out status
+     * List Institution Alert Preferences
+     */
+    listInstitution(requestParameters: InstitutionPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResources>;
+    /**
+     * Creates request options for updateInstitution without sending the request
+     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
+     * @param {FiAlertPreferenceResource} [fiAlertPreferenceResource] fiAlertPrefModel
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    updateInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates user alert preference for opt in/opt out
+     * @summary Update Institution Alert Preference
+     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
+     * @param {FiAlertPreferenceResource} [fiAlertPreferenceResource] fiAlertPrefModel
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InstitutionPreferencesApiInterface
+     */
+    updateInstitutionRaw(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
+    /**
+     * Updates user alert preference for opt in/opt out
+     * Update Institution Alert Preference
+     */
+    updateInstitution(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
+}
+/**
+ *
+ */
+export declare class InstitutionPreferencesApi extends runtime.BaseAPI implements InstitutionPreferencesApiInterface {
+    /**
+     * Creates request options for createInstitution without sending the request
+     */
+    createInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create user alert preference of certain user with destination presence earlier
+     * Create Institution Alert Preference
+     */
+    createInstitutionRaw(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
+    /**
+     * Create user alert preference of certain user with destination presence earlier
+     * Create Institution Alert Preference
+     */
+    createInstitution(requestParameters: InstitutionPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
+    /**
+     * Creates request options for deleteInstitution without sending the request
+     */
+    deleteInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removal of particular user alert preference
+     * Delete Institution Alert Preference
+     */
+    deleteInstitutionRaw(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removal of particular user alert preference
+     * Delete Institution Alert Preference
+     */
+    deleteInstitution(requestParameters: InstitutionPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listInstitution without sending the request
+     */
+    listInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiListInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * GET FI preference list with opt in or opt out status
+     * List Institution Alert Preferences
+     */
+    listInstitutionRaw(requestParameters: InstitutionPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResources>>;
+    /**
+     * GET FI preference list with opt in or opt out status
+     * List Institution Alert Preferences
+     */
+    listInstitution(requestParameters?: InstitutionPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResources>;
+    /**
+     * Creates request options for updateInstitution without sending the request
+     */
+    updateInstitutionRequestOpts(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates user alert preference for opt in/opt out
+     * Update Institution Alert Preference
+     */
+    updateInstitutionRaw(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
+    /**
+     * Updates user alert preference for opt in/opt out
+     * Update Institution Alert Preference
+     */
+    updateInstitution(requestParameters: InstitutionPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
+}