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

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

@@ -0,0 +1,467 @@
+/* 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 | |----------|-------------| | **[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 { AlertPreferenceResourceFromJSON, AlertPreferenceResourceToJSON, AlertPreferenceResourcesFromJSON, FiAlertPreferenceResourceFromJSON, FiAlertPreferenceResourceToJSON, FiAlertPreferenceResourcesFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class AlertPreferencesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for _delete without sending the request
+     */
+    async _deleteRequestOpts(requestParameters) {
+        if (requestParameters['alertPreferenceId'] == null) {
+            throw new runtime.RequiredError('alertPreferenceId', 'Required parameter "alertPreferenceId" was null or undefined when calling _delete().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (requestParameters['institutionCustomerId'] != null) {
+            headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
+        }
+        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/alert-preferences/{alertPreferenceId}`;
+        urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Removal of particular user alert preference
+     * Delete user alert preference for  existing alert preference
+     */
+    async _deleteRaw(requestParameters, initOverrides) {
+        const requestOptions = await this._deleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Removal of particular user alert preference
+     * Delete user alert preference for  existing alert preference
+     */
+    async _delete(requestParameters, initOverrides) {
+        await this._deleteRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Creates request options for create without sending the request
+     */
+    async createRequestOpts(requestParameters) {
+        if (requestParameters['alertPreferenceResource'] == null) {
+            throw new runtime.RequiredError('alertPreferenceResource', 'Required parameter "alertPreferenceResource" was null or undefined when calling create().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['institutionCustomerId'] != null) {
+            headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
+        }
+        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/alert-preferences`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AlertPreferenceResourceToJSON(requestParameters['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
+     */
+    async createRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertPreferenceResourceFromJSON(jsonValue));
+    }
+    /**
+     * 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
+     */
+    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
+     */
+    async getRequestOpts(requestParameters) {
+        if (requestParameters['alertPreferenceId'] == null) {
+            throw new runtime.RequiredError('alertPreferenceId', 'Required parameter "alertPreferenceId" was null or undefined when calling get().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (requestParameters['institutionCustomerId'] != null) {
+            headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
+        }
+        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/alert-preferences/{alertPreferenceId}`;
+        urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Get alert preference by id
+     */
+    async getRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertPreferenceResourceFromJSON(jsonValue));
+    }
+    /**
+     * Get alert preference by id
+     */
+    async get(requestParameters, initOverrides) {
+        const response = await this.getRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for list without sending the request
+     */
+    async listRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['accountExternalId'] != null) {
+            queryParameters['accountExternalId'] = requestParameters['accountExternalId'];
+        }
+        if (requestParameters['accountId'] != null) {
+            queryParameters['accountId'] = requestParameters['accountId'];
+        }
+        if (requestParameters['alertTypes'] != null) {
+            queryParameters['alertTypes'] = requestParameters['alertTypes'];
+        }
+        if (requestParameters['_default'] != null) {
+            queryParameters['default'] = requestParameters['_default'];
+        }
+        if (requestParameters['externalId'] != null) {
+            queryParameters['externalId'] = requestParameters['externalId'];
+        }
+        if (requestParameters['pageNo'] != null) {
+            queryParameters['pageNo'] = requestParameters['pageNo'];
+        }
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+        const headerParameters = {};
+        if (requestParameters['institutionCustomerId'] != null) {
+            headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
+        }
+        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/alert-preferences`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * 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
+     */
+    async listRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertPreferenceResourcesFromJSON(jsonValue));
+    }
+    /**
+     * 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
+     */
+    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
+     */
+    async updateRequestOpts(requestParameters) {
+        if (requestParameters['alertPreferenceId'] == null) {
+            throw new runtime.RequiredError('alertPreferenceId', 'Required parameter "alertPreferenceId" was null or undefined when calling update().');
+        }
+        if (requestParameters['alertPreferenceResource'] == null) {
+            throw new runtime.RequiredError('alertPreferenceResource', 'Required parameter "alertPreferenceResource" was null or undefined when calling update().');
+        }
+        const queryParameters = {};
+        if (requestParameters['hostUserId'] != null) {
+            queryParameters['hostUserId'] = requestParameters['hostUserId'];
+        }
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['allowCallback'] != null) {
+            queryParameters['allowCallback'] = requestParameters['allowCallback'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['institutionCustomerId'] != null) {
+            headerParameters['institutionCustomerId'] = String(requestParameters['institutionCustomerId']);
+        }
+        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/alert-preferences/{alertPreferenceId}`;
+        urlPath = urlPath.replace(`{${"alertPreferenceId"}}`, encodeURIComponent(String(requestParameters['alertPreferenceId'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AlertPreferenceResourceToJSON(requestParameters['alertPreferenceResource']),
+        };
+    }
+    /**
+     * Update user alert preference for opt in/opt out
+     * Update user alert preference for existing alert preference
+     */
+    async updateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.updateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertPreferenceResourceFromJSON(jsonValue));
+    }
+    /**
+     * Update user alert preference for opt in/opt out
+     * Update user alert preference for existing 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();
+    }
+}