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

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

@@ -0,0 +1,403 @@
+/**
+ * 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 { Events, Subscription } from '../models/index.js';
+export interface NotificationChannelsApiCreateSubscriptionRequest {
+    diFiid: string;
+    diFicustomer: string;
+    subscription: Subscription;
+    contentType?: string;
+    originatingIp?: string;
+    userAgent?: string;
+}
+export interface NotificationChannelsApiDeleteSubscriptionRequest {
+    diFiid: string;
+    diFicustomer: string;
+    subscriptionId: string;
+    originatingIp?: string;
+    userAgent?: string;
+}
+export interface NotificationChannelsApiGetSubscriptionRequest {
+    diFiid: string;
+    diFicustomer: string;
+    subscriptionId: string;
+    originatingIp?: string;
+    userAgent?: string;
+    eventType?: string;
+    action?: string;
+}
+export interface NotificationChannelsApiListInstitutionSubscriptionsRequest {
+    diFiid: string;
+    originatingIp?: string;
+    userAgent?: string;
+    eventType?: string;
+    limit?: string;
+    userToken?: string;
+    filterOutSubs?: string;
+    status?: string;
+}
+export interface NotificationChannelsApiListUserSubscriptionsRequest {
+    diFiid: string;
+    diFicustomer: string;
+    originatingIp?: string;
+    userAgent?: string;
+    eventType?: string;
+    action?: string;
+}
+export interface NotificationChannelsApiSendCustomerEventRequest {
+    diFiid: string;
+    diFicustomer: string;
+    body: Array<Events>;
+    contentType?: string;
+    originatingIp?: string;
+    userAgent?: string;
+}
+export interface NotificationChannelsApiUpdateSubscriptionRequest {
+    diFiid: string;
+    diFicustomer: string;
+    subscription: Subscription;
+    contentType?: string;
+    originatingIp?: string;
+    userAgent?: string;
+}
+/**
+ * NotificationChannelsApi - interface
+ *
+ * @export
+ * @interface NotificationChannelsApiInterface
+ */
+export interface NotificationChannelsApiInterface {
+    /**
+     * Creates request options for createSubscription without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Subscription} subscription
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    createSubscriptionRequestOpts(requestParameters: NotificationChannelsApiCreateSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new Subscription.
+     * @summary Create subscription
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Subscription} subscription
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    createSubscriptionRaw(requestParameters: NotificationChannelsApiCreateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Creates a new Subscription.
+     * Create subscription
+     */
+    createSubscription(requestParameters: NotificationChannelsApiCreateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+    /**
+     * Creates request options for deleteSubscription without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} subscriptionId Identifies the subscription to be deleted
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    deleteSubscriptionRequestOpts(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a Subscription
+     * @summary Delete subscription
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} subscriptionId Identifies the subscription to be deleted
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    deleteSubscriptionRaw(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a Subscription
+     * Delete subscription
+     */
+    deleteSubscription(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getSubscription without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} subscriptionId Identifies the subscription to get
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [action] The action that needs to take place for this subscription.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    getSubscriptionRequestOpts(requestParameters: NotificationChannelsApiGetSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the Subscription identified by the subscription_id
+     * @summary Get subscription by ID
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} subscriptionId Identifies the subscription to get
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [action] The action that needs to take place for this subscription.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    getSubscriptionRaw(requestParameters: NotificationChannelsApiGetSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Retrieves the Subscription identified by the subscription_id
+     * Get subscription by ID
+     */
+    getSubscription(requestParameters: NotificationChannelsApiGetSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+    /**
+     * Creates request options for listInstitutionSubscriptions without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [limit] The number of subscriptions to be retrieved as response. The default value for this query parameter is 30
+     * @param {string} [userToken] The user identifier of the last subscription in the previous list retrieved. If this is not specified, the calling application will receive the first \&#39;limit\&#39; subscriptions in the list as response.
+     * @param {string} [filterOutSubs] Its boolean type, when its true - subscription that is already processed during the given day will not be returned in the response
+     * @param {string} [status] A - Active, I - Inactive, default behavior is to send both active and inactive subscriptions
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    listInstitutionSubscriptionsRequestOpts(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the first twenty subscriptions.
+     * @summary List institution subscriptions
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [limit] The number of subscriptions to be retrieved as response. The default value for this query parameter is 30
+     * @param {string} [userToken] The user identifier of the last subscription in the previous list retrieved. If this is not specified, the calling application will receive the first \&#39;limit\&#39; subscriptions in the list as response.
+     * @param {string} [filterOutSubs] Its boolean type, when its true - subscription that is already processed during the given day will not be returned in the response
+     * @param {string} [status] A - Active, I - Inactive, default behavior is to send both active and inactive subscriptions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    listInstitutionSubscriptionsRaw(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Subscription>>>;
+    /**
+     * Retrieves the first twenty subscriptions.
+     * List institution subscriptions
+     */
+    listInstitutionSubscriptions(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription>>;
+    /**
+     * Creates request options for listUserSubscriptions without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [action] The action that needs to take place for this subscription
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    listUserSubscriptionsRequestOpts(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve the subscriptions for a given fi and customer. This can be filtered by a single eventType or list of event Types and/or action by specifying the query params.
+     * @summary List user subscriptions
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [eventType] The event type which identifies the subscription
+     * @param {string} [action] The action that needs to take place for this subscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    listUserSubscriptionsRaw(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Subscription>>>;
+    /**
+     * Retrieve the subscriptions for a given fi and customer. This can be filtered by a single eventType or list of event Types and/or action by specifying the query params.
+     * List user subscriptions
+     */
+    listUserSubscriptions(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription> | null | undefined>;
+    /**
+     * Creates request options for sendCustomerEvent without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Array<Events>} body Events
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    sendCustomerEventRequestOpts(requestParameters: NotificationChannelsApiSendCustomerEventRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sends the necessary event to the message service.
+     * @summary Send event
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Array<Events>} body Events
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    sendCustomerEventRaw(requestParameters: NotificationChannelsApiSendCustomerEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends the necessary event to the message service.
+     * Send event
+     */
+    sendCustomerEvent(requestParameters: NotificationChannelsApiSendCustomerEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateSubscription without sending the request
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Subscription} subscription
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    updateSubscriptionRequestOpts(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing Subscription
+     * @summary Update subscription
+     * @param {string} diFiid Identifies the Financial Institution
+     * @param {string} diFicustomer Identifies the customer
+     * @param {Subscription} subscription
+     * @param {string} [contentType] The content type of the request body, the expected content type is application/xml
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [userAgent] Identifies the application and the platform making the request.The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationChannelsApiInterface
+     */
+    updateSubscriptionRaw(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Updates an existing Subscription
+     * Update subscription
+     */
+    updateSubscription(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+}
+/**
+ *
+ */
+export declare class NotificationChannelsApi extends runtime.BaseAPI implements NotificationChannelsApiInterface {
+    /**
+     * Creates request options for createSubscription without sending the request
+     */
+    createSubscriptionRequestOpts(requestParameters: NotificationChannelsApiCreateSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new Subscription.
+     * Create subscription
+     */
+    createSubscriptionRaw(requestParameters: NotificationChannelsApiCreateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Creates a new Subscription.
+     * Create subscription
+     */
+    createSubscription(requestParameters: NotificationChannelsApiCreateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+    /**
+     * Creates request options for deleteSubscription without sending the request
+     */
+    deleteSubscriptionRequestOpts(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a Subscription
+     * Delete subscription
+     */
+    deleteSubscriptionRaw(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a Subscription
+     * Delete subscription
+     */
+    deleteSubscription(requestParameters: NotificationChannelsApiDeleteSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getSubscription without sending the request
+     */
+    getSubscriptionRequestOpts(requestParameters: NotificationChannelsApiGetSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the Subscription identified by the subscription_id
+     * Get subscription by ID
+     */
+    getSubscriptionRaw(requestParameters: NotificationChannelsApiGetSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Retrieves the Subscription identified by the subscription_id
+     * Get subscription by ID
+     */
+    getSubscription(requestParameters: NotificationChannelsApiGetSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+    /**
+     * Creates request options for listInstitutionSubscriptions without sending the request
+     */
+    listInstitutionSubscriptionsRequestOpts(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the first twenty subscriptions.
+     * List institution subscriptions
+     */
+    listInstitutionSubscriptionsRaw(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Subscription>>>;
+    /**
+     * Retrieves the first twenty subscriptions.
+     * List institution subscriptions
+     */
+    listInstitutionSubscriptions(requestParameters: NotificationChannelsApiListInstitutionSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription>>;
+    /**
+     * Creates request options for listUserSubscriptions without sending the request
+     */
+    listUserSubscriptionsRequestOpts(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve the subscriptions for a given fi and customer. This can be filtered by a single eventType or list of event Types and/or action by specifying the query params.
+     * List user subscriptions
+     */
+    listUserSubscriptionsRaw(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Subscription>>>;
+    /**
+     * Retrieve the subscriptions for a given fi and customer. This can be filtered by a single eventType or list of event Types and/or action by specifying the query params.
+     * List user subscriptions
+     */
+    listUserSubscriptions(requestParameters: NotificationChannelsApiListUserSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription> | null | undefined>;
+    /**
+     * Creates request options for sendCustomerEvent without sending the request
+     */
+    sendCustomerEventRequestOpts(requestParameters: NotificationChannelsApiSendCustomerEventRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sends the necessary event to the message service.
+     * Send event
+     */
+    sendCustomerEventRaw(requestParameters: NotificationChannelsApiSendCustomerEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends the necessary event to the message service.
+     * Send event
+     */
+    sendCustomerEvent(requestParameters: NotificationChannelsApiSendCustomerEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateSubscription without sending the request
+     */
+    updateSubscriptionRequestOpts(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing Subscription
+     * Update subscription
+     */
+    updateSubscriptionRaw(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
+    /**
+     * Updates an existing Subscription
+     * Update subscription
+     */
+    updateSubscription(requestParameters: NotificationChannelsApiUpdateSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
+}