@openfort/openfort-node 0.6.34 → 0.6.36

package/dist/generated/apis/NotificationsApi.d.ts

@@ -0,0 +1,204 @@
+import { BaseAPIRequestFactory } from './baseapi';
+import { Configuration } from '../configuration';
+import { RequestContext, ResponseContext } from '../http/http';
+import { CreateNotificationRequest } from '../models/CreateNotificationRequest';
+import { CreateSubscriptionRequest } from '../models/CreateSubscriptionRequest';
+import { CreateTriggerRequest } from '../models/CreateTriggerRequest';
+import { NotificationDeleteResponse } from '../models/NotificationDeleteResponse';
+import { NotificationListResponse } from '../models/NotificationListResponse';
+import { NotificationResponse } from '../models/NotificationResponse';
+import { NotificationResponseExpandable } from '../models/NotificationResponseExpandable';
+import { NotificationSubscription } from '../models/NotificationSubscription';
+import { NotificationSubscriptionDeleteResponse } from '../models/NotificationSubscriptionDeleteResponse';
+import { NotificationSubscriptionListResponse } from '../models/NotificationSubscriptionListResponse';
+import { NotificationTriggerDeleteResponse } from '../models/NotificationTriggerDeleteResponse';
+import { NotificationTriggerListResponse } from '../models/NotificationTriggerListResponse';
+import { NotificationTriggerResponse } from '../models/NotificationTriggerResponse';
+import { SortOrder } from '../models/SortOrder';
+/**
+ * no description
+ */
+export declare class NotificationsApiRequestFactory extends BaseAPIRequestFactory {
+    /**
+     * Create a notification object.
+     * Create a notification object.
+     * @param createNotificationRequest
+     */
+    createNotification(createNotificationRequest: CreateNotificationRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Create a subscription for the provided notification.
+     * Create a notification subscription object.
+     * @param createSubscriptionRequest
+     */
+    createNotificationSubscription(createSubscriptionRequest: CreateSubscriptionRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Create a trigger for the provided notification.
+     * Create a notification trigger object.
+     * @param createTriggerRequest
+     */
+    createNotificationTrigger(createTriggerRequest: CreateTriggerRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Delete a notification by providing its notification id.
+     * Deletes a notification object.
+     * @param id Specifies the unique notification ID (starts with not_).
+     */
+    deleteNotification(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Delete a notification subscription by providing its notification subscription id.
+     * Deletes a notification subscription object.
+     * @param id Specifies the unique notification subscription ID (starts with ntr_).
+     */
+    deleteNotificationSubscription(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Delete a notification trigger by providing its notification trigger id.
+     * Deletes a notification trigger object.
+     * @param id Specifies the unique notification trigger ID (starts with ntr_).
+     */
+    deleteNotificationTrigger(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Retrieves the details of an existing account.  Supply the unique notification ID.
+     * Get existing account.
+     * @param id Specifies the unique account ID (starts with not_).
+     * @param expand
+     */
+    getNotification(id: string, expand?: Array<NotificationResponseExpandable>, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Retrieves the details of an existing notification subscription.  Supply the unique notification subscription ID.
+     * Get existing notification subscription.
+     * @param id Specifies the unique notification subscription ID (starts with not_).
+     */
+    getNotificationSubscription(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a list of subscriptions of a notification.  The subscriptions are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 notification subscriptions are shown per page.
+     * List notification subscriptions of a notification.
+     * @param notification Specifies the unique notification ID (starts with not_).
+     * @param limit Specifies the maximum number of records to return.
+     * @param skip Specifies the offset for the first records to return.
+     * @param order Specifies the order in which to sort the results.
+     */
+    getNotificationSubscriptions(notification: string, limit?: number, skip?: number, order?: SortOrder, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Retrieves the details of an existing notification trigger.  Supply the unique notification trigger ID.
+     * Get existing notification trigger.
+     * @param id Specifies the unique notification trigger ID (starts with ntr_).
+     */
+    getNotificationTrigger(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a list of triggers of a notification.  The triggers are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 notification triggers are shown per page.
+     * List notification triggers of a notification.
+     * @param notification Specifies the unique notification ID (starts with not_).
+     * @param limit Specifies the maximum number of records to return.
+     * @param skip Specifies the offset for the first records to return.
+     * @param order Specifies the order in which to sort the results.
+     */
+    getNotificationTriggers(notification: string, limit?: number, skip?: number, order?: SortOrder, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a list of notifications.  The notifications are returned sorted by creation date, with the most recently created notifications appearing first.  By default, a maximum of 10 notifications are shown per page.
+     * List notifications.
+     * @param limit Specifies the maximum number of records to return.
+     * @param skip Specifies the offset for the first records to return.
+     * @param order Specifies the order in which to sort the results.
+     * @param expand Specifies the fields to expand in the response.
+     * @param deleted Specifies whether to include deleted notifications.
+     * @param name Specifies the name of the notifications.
+     */
+    getNotifications(limit?: number, skip?: number, order?: SortOrder, expand?: Array<NotificationResponseExpandable>, deleted?: boolean, name?: string, _options?: Configuration): Promise<RequestContext>;
+}
+export declare class NotificationsApiResponseProcessor {
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to createNotification
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createNotification(response: ResponseContext): Promise<NotificationResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to createNotificationSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createNotificationSubscription(response: ResponseContext): Promise<NotificationSubscription>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to createNotificationTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createNotificationTrigger(response: ResponseContext): Promise<NotificationTriggerResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to deleteNotification
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteNotification(response: ResponseContext): Promise<NotificationDeleteResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to deleteNotificationSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteNotificationSubscription(response: ResponseContext): Promise<NotificationSubscriptionDeleteResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to deleteNotificationTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteNotificationTrigger(response: ResponseContext): Promise<NotificationTriggerDeleteResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotification
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotification(response: ResponseContext): Promise<NotificationResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotificationSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotificationSubscription(response: ResponseContext): Promise<NotificationSubscription>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotificationSubscriptions
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotificationSubscriptions(response: ResponseContext): Promise<NotificationSubscriptionListResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotificationTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotificationTrigger(response: ResponseContext): Promise<NotificationTriggerResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotificationTriggers
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotificationTriggers(response: ResponseContext): Promise<NotificationTriggerListResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getNotifications
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getNotifications(response: ResponseContext): Promise<NotificationListResponse>;
+}