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

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

@@ -1,437 +0,0 @@
-/**
- * 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/)**.
- *
- * The version of the OpenAPI document: 1.4.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, FiAlertPreferenceResource, FiAlertPreferenceResources } from '../models/index.js';
-export interface AlertPreferencesApiDeleteRequest {
-    alertPreferenceId: number;
-    hostUserId?: string;
-    loginId?: string;
-    institutionCustomerId?: string;
-}
-export interface AlertPreferencesApiCreateRequest {
-    alertPreferenceResource: AlertPreferenceResource;
-    institutionCustomerId?: string;
-    hostUserId?: string;
-    loginId?: string;
-}
-export interface AlertPreferencesApiCreateInstitutionRequest {
-    fiAlertPreferenceResource: FiAlertPreferenceResource;
-}
-export interface AlertPreferencesApiDeleteInstitutionRequest {
-    institutionAlertPreferenceId: number;
-}
-export interface AlertPreferencesApiGetRequest {
-    alertPreferenceId: number;
-    institutionCustomerId?: string;
-    hostUserId?: string;
-    loginId?: string;
-}
-export interface AlertPreferencesApiListRequest {
-    hostUserId?: string;
-    loginId?: string;
-    accountExternalId?: string;
-    accountId?: string;
-    alertTypes?: string;
-    _default?: boolean;
-    externalId?: string;
-    pageNo?: number;
-    pageSize?: number;
-    institutionCustomerId?: string;
-}
-export interface AlertPreferencesApiListInstitutionRequest {
-    alertTypes?: string;
-}
-export interface AlertPreferencesApiUpdateRequest {
-    alertPreferenceId: number;
-    alertPreferenceResource: AlertPreferenceResource;
-    hostUserId?: string;
-    loginId?: string;
-    allowCallback?: boolean;
-    institutionCustomerId?: string;
-}
-export interface AlertPreferencesApiUpdateInstitutionRequest {
-    institutionAlertPreferenceId: number;
-    fiAlertPreferenceResource?: FiAlertPreferenceResource;
-}
-/**
- * AlertPreferencesApi - interface
- *
- * @export
- * @interface AlertPreferencesApiInterface
- */
-export interface AlertPreferencesApiInterface {
-    /**
-     * 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 AlertPreferencesApiInterface
-     */
-    _deleteRequestOpts(requestParameters: AlertPreferencesApiDeleteRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Removal of particular user alert preference
-     * @summary Delete user alert preference for  existing 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 AlertPreferencesApiInterface
-     */
-    _deleteRaw(requestParameters: AlertPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Removal of particular user alert preference
-     * Delete user alert preference for  existing alert preference
-     */
-    _delete(requestParameters: AlertPreferencesApiDeleteRequest, 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 AlertPreferencesApiInterface
-     */
-    createRequestOpts(requestParameters: AlertPreferencesApiCreateRequest): 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 AlertPreferencesApiInterface
-     */
-    createRaw(requestParameters: AlertPreferencesApiCreateRequest, 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: AlertPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
-    /**
-     * Creates request options for createInstitution without sending the request
-     * @param {FiAlertPreferenceResource} fiAlertPreferenceResource fiAlertPreferenceModel
-     * @throws {RequiredError}
-     * @memberof AlertPreferencesApiInterface
-     */
-    createInstitutionRequestOpts(requestParameters: AlertPreferencesApiCreateInstitutionRequest): 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 AlertPreferencesApiInterface
-     */
-    createInstitutionRaw(requestParameters: AlertPreferencesApiCreateInstitutionRequest, 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: AlertPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
-    /**
-     * Creates request options for deleteInstitution without sending the request
-     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
-     * @throws {RequiredError}
-     * @memberof AlertPreferencesApiInterface
-     */
-    deleteInstitutionRequestOpts(requestParameters: AlertPreferencesApiDeleteInstitutionRequest): 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 AlertPreferencesApiInterface
-     */
-    deleteInstitutionRaw(requestParameters: AlertPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Removal of particular user alert preference
-     * Delete institution alert preference
-     */
-    deleteInstitution(requestParameters: AlertPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * 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 AlertPreferencesApiInterface
-     */
-    getRequestOpts(requestParameters: AlertPreferencesApiGetRequest): 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 AlertPreferencesApiInterface
-     */
-    getRaw(requestParameters: AlertPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
-    /**
-     * Get alert preference by id
-     */
-    get(requestParameters: AlertPreferencesApiGetRequest, 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 AlertPreferencesApiInterface
-     */
-    listRequestOpts(requestParameters: AlertPreferencesApiListRequest): 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 AlertPreferencesApiInterface
-     */
-    listRaw(requestParameters: AlertPreferencesApiListRequest, 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: AlertPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResources>;
-    /**
-     * Creates request options for listInstitution without sending the request
-     * @param {string} [alertTypes] alertTypes
-     * @throws {RequiredError}
-     * @memberof AlertPreferencesApiInterface
-     */
-    listInstitutionRequestOpts(requestParameters: AlertPreferencesApiListInstitutionRequest): 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 AlertPreferencesApiInterface
-     */
-    listInstitutionRaw(requestParameters: AlertPreferencesApiListInstitutionRequest, 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: AlertPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResources>;
-    /**
-     * 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 AlertPreferencesApiInterface
-     */
-    updateRequestOpts(requestParameters: AlertPreferencesApiUpdateRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Update user alert preference for opt in/opt out
-     * @summary Update user alert preference for existing 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 AlertPreferencesApiInterface
-     */
-    updateRaw(requestParameters: AlertPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
-    /**
-     * Update user alert preference for opt in/opt out
-     * Update user alert preference for existing alert preference
-     */
-    update(requestParameters: AlertPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
-    /**
-     * Creates request options for updateInstitution without sending the request
-     * @param {number} institutionAlertPreferenceId institutionAlertPreferenceId
-     * @param {FiAlertPreferenceResource} [fiAlertPreferenceResource] fiAlertPrefModel
-     * @throws {RequiredError}
-     * @memberof AlertPreferencesApiInterface
-     */
-    updateInstitutionRequestOpts(requestParameters: AlertPreferencesApiUpdateInstitutionRequest): 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 AlertPreferencesApiInterface
-     */
-    updateInstitutionRaw(requestParameters: AlertPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
-    /**
-     * Updates user alert preference for opt in/opt out
-     * Update institution alert preference
-     */
-    updateInstitution(requestParameters: AlertPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
-}
-/**
- *
- */
-export declare class AlertPreferencesApi extends runtime.BaseAPI implements AlertPreferencesApiInterface {
-    /**
-     * Creates request options for _delete without sending the request
-     */
-    _deleteRequestOpts(requestParameters: AlertPreferencesApiDeleteRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Removal of particular user alert preference
-     * Delete user alert preference for  existing alert preference
-     */
-    _deleteRaw(requestParameters: AlertPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Removal of particular user alert preference
-     * Delete user alert preference for  existing alert preference
-     */
-    _delete(requestParameters: AlertPreferencesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Creates request options for create without sending the request
-     */
-    createRequestOpts(requestParameters: AlertPreferencesApiCreateRequest): 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: AlertPreferencesApiCreateRequest, 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: AlertPreferencesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
-    /**
-     * Creates request options for createInstitution without sending the request
-     */
-    createInstitutionRequestOpts(requestParameters: AlertPreferencesApiCreateInstitutionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Create user alert preference of certain user with destination presence earlier
-     * Create institution alert preference
-     */
-    createInstitutionRaw(requestParameters: AlertPreferencesApiCreateInstitutionRequest, 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: AlertPreferencesApiCreateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
-    /**
-     * Creates request options for deleteInstitution without sending the request
-     */
-    deleteInstitutionRequestOpts(requestParameters: AlertPreferencesApiDeleteInstitutionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Removal of particular user alert preference
-     * Delete institution alert preference
-     */
-    deleteInstitutionRaw(requestParameters: AlertPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Removal of particular user alert preference
-     * Delete institution alert preference
-     */
-    deleteInstitution(requestParameters: AlertPreferencesApiDeleteInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Creates request options for get without sending the request
-     */
-    getRequestOpts(requestParameters: AlertPreferencesApiGetRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Get alert preference by id
-     */
-    getRaw(requestParameters: AlertPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
-    /**
-     * Get alert preference by id
-     */
-    get(requestParameters: AlertPreferencesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
-    /**
-     * Creates request options for list without sending the request
-     */
-    listRequestOpts(requestParameters: AlertPreferencesApiListRequest): 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: AlertPreferencesApiListRequest, 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?: AlertPreferencesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResources>;
-    /**
-     * Creates request options for listInstitution without sending the request
-     */
-    listInstitutionRequestOpts(requestParameters: AlertPreferencesApiListInstitutionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * GET FI preference list with opt in or opt out status
-     * List institution alert preferences
-     */
-    listInstitutionRaw(requestParameters: AlertPreferencesApiListInstitutionRequest, 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?: AlertPreferencesApiListInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResources>;
-    /**
-     * Creates request options for update without sending the request
-     */
-    updateRequestOpts(requestParameters: AlertPreferencesApiUpdateRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Update user alert preference for opt in/opt out
-     * Update user alert preference for existing alert preference
-     */
-    updateRaw(requestParameters: AlertPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertPreferenceResource>>;
-    /**
-     * Update user alert preference for opt in/opt out
-     * Update user alert preference for existing alert preference
-     */
-    update(requestParameters: AlertPreferencesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertPreferenceResource>;
-    /**
-     * Creates request options for updateInstitution without sending the request
-     */
-    updateInstitutionRequestOpts(requestParameters: AlertPreferencesApiUpdateInstitutionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Updates user alert preference for opt in/opt out
-     * Update institution alert preference
-     */
-    updateInstitutionRaw(requestParameters: AlertPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FiAlertPreferenceResource>>;
-    /**
-     * Updates user alert preference for opt in/opt out
-     * Update institution alert preference
-     */
-    updateInstitution(requestParameters: AlertPreferencesApiUpdateInstitutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FiAlertPreferenceResource>;
-}