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

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

@@ -0,0 +1,282 @@
+/**
+ * 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 { AlertPreferenceResource, AlertPreferenceResources } from '../models/index.js';
+export interface UserPreferencesApiDeleteRequest {
+    alertPreferenceId: number;
+    hostUserId?: string;
+    loginId?: string;
+    institutionCustomerId?: string;
+}
+export interface UserPreferencesApiCreateRequest {
+    alertPreferenceResource: AlertPreferenceResource;
+    institutionCustomerId?: string;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface UserPreferencesApiGetRequest {
+    alertPreferenceId: number;
+    institutionCustomerId?: string;
+    hostUserId?: string;
+    loginId?: string;
+}
+export interface UserPreferencesApiListRequest {
+    hostUserId?: string;
+    loginId?: string;
+    accountExternalId?: string;
+    accountId?: string;
+    alertTypes?: string;
+    _default?: boolean;
+    externalId?: string;
+    pageNo?: number;
+    pageSize?: number;
+    institutionCustomerId?: string;
+}
+export interface UserPreferencesApiUpdateRequest {
+    alertPreferenceId: number;
+    alertPreferenceResource: AlertPreferenceResource;
+    hostUserId?: string;
+    loginId?: string;
+    allowCallback?: boolean;
+    institutionCustomerId?: string;
+}
+/**
+ * UserPreferencesApi - interface
+ *
+ * @export
+ * @interface UserPreferencesApiInterface
+ */
+export interface UserPreferencesApiInterface {
+    /**
+     * Creates request options for _delete without sending the request
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    _deleteRequestOpts(requestParameters: UserPreferencesApiDeleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removal of particular user alert preference
+     * @summary Delete User Alert Preference
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    _deleteRaw(requestParameters: UserPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removal of particular user alert preference
+     * Delete User Alert Preference
+     */
+    _delete(requestParameters: UserPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for create without sending the request
+     * @param {AlertPreferenceResource} alertPreferenceResource alertPreferenceModel
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    createRequestOpts(requestParameters: UserPreferencesApiCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
+     * @summary Create User Alert Preference
+     * @param {AlertPreferenceResource} alertPreferenceResource alertPreferenceModel
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    createRaw(requestParameters: UserPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
+     * Create User Alert Preference
+     */
+    create(requestParameters: UserPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+    /**
+     * Creates request options for get without sending the request
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    getRequestOpts(requestParameters: UserPreferencesApiGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Get Alert Preference by ID
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    getRaw(requestParameters: UserPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Get Alert Preference by ID
+     */
+    get(requestParameters: UserPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+    /**
+     * Creates request options for list without sending the request
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [accountExternalId] accountExternalId
+     * @param {string} [accountId] accountId
+     * @param {string} [alertTypes] alertTypes
+     * @param {boolean} [_default] default
+     * @param {string} [externalId] externalId
+     * @param {number} [pageNo] pageNo
+     * @param {number} [pageSize] pageSize
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    listRequestOpts(requestParameters: UserPreferencesApiListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
+     * @summary List User Alert Preferences
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [accountExternalId] accountExternalId
+     * @param {string} [accountId] accountId
+     * @param {string} [alertTypes] alertTypes
+     * @param {boolean} [_default] default
+     * @param {string} [externalId] externalId
+     * @param {number} [pageNo] pageNo
+     * @param {number} [pageSize] pageSize
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    listRaw(requestParameters: UserPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResources>>;
+    /**
+     * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
+     * List User Alert Preferences
+     */
+    list(requestParameters: UserPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResources>;
+    /**
+     * Creates request options for update without sending the request
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {AlertPreferenceResource} alertPreferenceResource alertPrefModel
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {boolean} [allowCallback] allowCallback
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    updateRequestOpts(requestParameters: UserPreferencesApiUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update user alert preference for opt in/opt out
+     * @summary Update User Alert Preference
+     * @param {number} alertPreferenceId alertPreferenceId
+     * @param {AlertPreferenceResource} alertPreferenceResource alertPrefModel
+     * @param {string} [hostUserId] Identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;loginId&#x60; query parameter.
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {boolean} [allowCallback] allowCallback
+     * @param {string} [institutionCustomerId] institutionCustomerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPreferencesApiInterface
+     */
+    updateRaw(requestParameters: UserPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Update user alert preference for opt in/opt out
+     * Update User Alert Preference
+     */
+    update(requestParameters: UserPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+}
+/**
+ *
+ */
+export declare class UserPreferencesApi extends runtime.BaseAPI implements UserPreferencesApiInterface {
+    /**
+     * Creates request options for _delete without sending the request
+     */
+    _deleteRequestOpts(requestParameters: UserPreferencesApiDeleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removal of particular user alert preference
+     * Delete User Alert Preference
+     */
+    _deleteRaw(requestParameters: UserPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removal of particular user alert preference
+     * Delete User Alert Preference
+     */
+    _delete(requestParameters: UserPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for create without sending the request
+     */
+    createRequestOpts(requestParameters: UserPreferencesApiCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
+     * Create User Alert Preference
+     */
+    createRaw(requestParameters: UserPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
+     * Create User Alert Preference
+     */
+    create(requestParameters: UserPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+    /**
+     * Creates request options for get without sending the request
+     */
+    getRequestOpts(requestParameters: UserPreferencesApiGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get Alert Preference by ID
+     */
+    getRaw(requestParameters: UserPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Get Alert Preference by ID
+     */
+    get(requestParameters: UserPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+    /**
+     * Creates request options for list without sending the request
+     */
+    listRequestOpts(requestParameters: UserPreferencesApiListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
+     * List User Alert Preferences
+     */
+    listRaw(requestParameters: UserPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResources>>;
+    /**
+     * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
+     * List User Alert Preferences
+     */
+    list(requestParameters?: UserPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResources>;
+    /**
+     * Creates request options for update without sending the request
+     */
+    updateRequestOpts(requestParameters: UserPreferencesApiUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update user alert preference for opt in/opt out
+     * Update User Alert Preference
+     */
+    updateRaw(requestParameters: UserPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
+    /**
+     * Update user alert preference for opt in/opt out
+     * Update User Alert Preference
+     */
+    update(requestParameters: UserPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
+}

package/dist/generated/src/apis/{AlertPreferencesApi.js → UserPreferencesApi.js}

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Candescent DI API
- * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,11 +12,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import { AlertPreferenceResourceFromJSON, AlertPreferenceResourceToJSON, AlertPreferenceResourcesFromJSON, FiAlertPreferenceResourceFromJSON, FiAlertPreferenceResourceToJSON, FiAlertPreferenceResourcesFromJSON, } from '../models/index.js';
+import { AlertPreferenceResourceFromJSON, AlertPreferenceResourceToJSON, AlertPreferenceResourcesFromJSON, } from '../models/index.js';
 /**
  *
  */
-export class AlertPreferencesApi extends runtime.BaseAPI {
+export class UserPreferencesApi extends runtime.BaseAPI {
     /**
      * Creates request options for _delete without sending the request
      */
@@ -42,7 +42,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-preferences/v1/alert-preferences/{alertPreferenceId}`;
+        let urlPath = `/v1/alert-preferences/{alertPreferenceId}`;
         urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
         return {
             path: urlPath,
@@ -53,7 +53,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Removal of particular user alert preference
-     * Delete user alert preference for  existing alert preference
+     * Delete User Alert Preference
      */
     async _deleteRaw(requestParameters, initOverrides) {
         const requestOptions = await this._deleteRequestOpts(requestParameters);
@@ -62,7 +62,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Removal of particular user alert preference
-     * Delete user alert preference for  existing alert preference
+     * Delete User Alert Preference
      */
     async _delete(requestParameters, initOverrides) {
         await this._deleteRaw(requestParameters, initOverrides);
@@ -93,7 +93,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-preferences/v1/alert-preferences`;
+        let urlPath = `/v1/alert-preferences`;
         return {
             path: urlPath,
             method: 'POST',
@@ -104,7 +104,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
-     * Create user alert preference
+     * Create User Alert Preference
      */
     async createRaw(requestParameters, initOverrides) {
         const requestOptions = await this.createRequestOpts(requestParameters);
@@ -113,96 +113,12 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.  **Required:** User must have destinations (email, phone, device) configured before creating preferences.
-     * Create user alert preference
+     * Create User Alert Preference
      */
     async create(requestParameters, initOverrides) {
         const response = await this.createRaw(requestParameters, initOverrides);
         return await response.value();
     }
-    /**
-     * Creates request options for createInstitution without sending the request
-     */
-    async createInstitutionRequestOpts(requestParameters) {
-        if (requestParameters['fiAlertPreferenceResource'] == null) {
-            throw new runtime.RequiredError('fiAlertPreferenceResource', 'Required parameter "fiAlertPreferenceResource" was null or undefined when calling createInstitution().');
-        }
-        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 = `/db-alerts-preferences/v1/institution-alert-preferences`;
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: FiAlertPreferenceResourceToJSON(requestParameters['fiAlertPreferenceResource']),
-        };
-    }
-    /**
-     * Create user alert preference of certain user with destination presence earlier
-     * Create institution alert preference
-     */
-    async createInstitutionRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.createInstitutionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => FiAlertPreferenceResourceFromJSON(jsonValue));
-    }
-    /**
-     * Create user alert preference of certain user with destination presence earlier
-     * Create institution alert preference
-     */
-    async createInstitution(requestParameters, initOverrides) {
-        const response = await this.createInstitutionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Creates request options for deleteInstitution without sending the request
-     */
-    async deleteInstitutionRequestOpts(requestParameters) {
-        if (requestParameters['institutionAlertPreferenceId'] == null) {
-            throw new runtime.RequiredError('institutionAlertPreferenceId', 'Required parameter "institutionAlertPreferenceId" was null or undefined when calling deleteInstitution().');
-        }
-        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 = `/db-alerts-preferences/v1/institution-alert-preferences/{institutionAlertPreferenceId}`;
-        urlPath = urlPath.replace(`{${"institutionAlertPreferenceId"}}`, encodeURIComponent(String(requestParameters['institutionAlertPreferenceId'])));
-        return {
-            path: urlPath,
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-    /**
-     * Removal of particular user alert preference
-     * Delete institution alert preference
-     */
-    async deleteInstitutionRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.deleteInstitutionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.VoidApiResponse(response);
-    }
-    /**
-     * Removal of particular user alert preference
-     * Delete institution alert preference
-     */
-    async deleteInstitution(requestParameters, initOverrides) {
-        await this.deleteInstitutionRaw(requestParameters, initOverrides);
-    }
     /**
      * Creates request options for get without sending the request
      */
@@ -228,7 +144,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-preferences/v1/alert-preferences/{alertPreferenceId}`;
+        let urlPath = `/v1/alert-preferences/{alertPreferenceId}`;
         urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
         return {
             path: urlPath,
@@ -238,7 +154,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Get alert preference by id
+     * Get Alert Preference by ID
      */
     async getRaw(requestParameters, initOverrides) {
         const requestOptions = await this.getRequestOpts(requestParameters);
@@ -246,7 +162,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => AlertPreferenceResourceFromJSON(jsonValue));
     }
     /**
-     * Get alert preference by id
+     * Get Alert Preference by ID
      */
     async get(requestParameters, initOverrides) {
         const response = await this.getRaw(requestParameters, initOverrides);
@@ -295,7 +211,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-preferences/v1/alert-preferences`;
+        let urlPath = `/v1/alert-preferences`;
         return {
             path: urlPath,
             method: 'GET',
@@ -305,7 +221,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
-     * List user alert preferences
+     * List User Alert Preferences
      */
     async listRaw(requestParameters, initOverrides) {
         const requestOptions = await this.listRequestOpts(requestParameters);
@@ -314,53 +230,12 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.  **Key Features:** - Filter by account ID, alert types, or external ID - Supports pagination with `pageNo` and `pageSize` parameters - Returns opt-in/opt-out status for each alert type and channel
-     * List user alert preferences
+     * List User Alert Preferences
      */
     async list(requestParameters = {}, initOverrides) {
         const response = await this.listRaw(requestParameters, initOverrides);
         return await response.value();
     }
-    /**
-     * Creates request options for listInstitution without sending the request
-     */
-    async listInstitutionRequestOpts(requestParameters) {
-        const queryParameters = {};
-        if (requestParameters['alertTypes'] != null) {
-            queryParameters['alertTypes'] = requestParameters['alertTypes'];
-        }
-        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 = `/db-alerts-preferences/v1/institution-alert-preferences`;
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-    /**
-     * GET FI preference list with opt in or opt out status
-     * List institution alert preferences
-     */
-    async listInstitutionRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.listInstitutionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => FiAlertPreferenceResourcesFromJSON(jsonValue));
-    }
-    /**
-     * GET FI preference list with opt in or opt out status
-     * List institution alert preferences
-     */
-    async listInstitution(requestParameters = {}, initOverrides) {
-        const response = await this.listInstitutionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
     /**
      * Creates request options for update without sending the request
      */
@@ -393,7 +268,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/db-alerts-preferences/v1/alert-preferences/{alertPreferenceId}`;
+        let urlPath = `/v1/alert-preferences/{alertPreferenceId}`;
         urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
         return {
             path: urlPath,
@@ -405,7 +280,7 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Update user alert preference for opt in/opt out
-     * Update user alert preference for existing alert preference
+     * Update User Alert Preference
      */
     async updateRaw(requestParameters, initOverrides) {
         const requestOptions = await this.updateRequestOpts(requestParameters);
@@ -414,54 +289,11 @@ export class AlertPreferencesApi extends runtime.BaseAPI {
     }
     /**
      * Update user alert preference for opt in/opt out
-     * Update user alert preference for existing alert preference
+     * Update User Alert Preference
      */
     async update(requestParameters, initOverrides) {
         const response = await this.updateRaw(requestParameters, initOverrides);
         return await response.value();
     }
-    /**
-     * Creates request options for updateInstitution without sending the request
-     */
-    async updateInstitutionRequestOpts(requestParameters) {
-        if (requestParameters['institutionAlertPreferenceId'] == null) {
-            throw new runtime.RequiredError('institutionAlertPreferenceId', 'Required parameter "institutionAlertPreferenceId" was null or undefined when calling updateInstitution().');
-        }
-        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 = `/db-alerts-preferences/v1/institution-alert-preferences/{institutionAlertPreferenceId}`;
-        urlPath = urlPath.replace(`{${"institutionAlertPreferenceId"}}`, encodeURIComponent(String(requestParameters['institutionAlertPreferenceId'])));
-        return {
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: FiAlertPreferenceResourceToJSON(requestParameters['fiAlertPreferenceResource']),
-        };
-    }
-    /**
-     * Updates user alert preference for opt in/opt out
-     * Update institution alert preference
-     */
-    async updateInstitutionRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.updateInstitutionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => FiAlertPreferenceResourceFromJSON(jsonValue));
-    }
-    /**
-     * Updates user alert preference for opt in/opt out
-     * Update institution alert preference
-     */
-    async updateInstitution(requestParameters, initOverrides) {
-        const response = await this.updateInstitutionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
 }
+//# sourceMappingURL=UserPreferencesApi.js.map