@openfort/openfort-node 0.6.52 → 0.6.53

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

@@ -0,0 +1,171 @@
+import { BaseAPIRequestFactory } from './baseapi';
+import { Configuration } from '../configuration';
+import { RequestContext, ResponseContext } from '../http/http';
+import { APITopic } from '../models/APITopic';
+import { BaseEntityListResponseLogResponse } from '../models/BaseEntityListResponseLogResponse';
+import { BaseEntityListResponseTriggerResponse } from '../models/BaseEntityListResponseTriggerResponse';
+import { CreateSubscriptionRequest } from '../models/CreateSubscriptionRequest';
+import { CreateTriggerRequest } from '../models/CreateTriggerRequest';
+import { SortOrder } from '../models/SortOrder';
+import { Status } from '../models/Status';
+import { SubscriptionDeleteResponse } from '../models/SubscriptionDeleteResponse';
+import { SubscriptionListResponse } from '../models/SubscriptionListResponse';
+import { SubscriptionResponse } from '../models/SubscriptionResponse';
+import { TriggerDeleteResponse } from '../models/TriggerDeleteResponse';
+import { TriggerResponse } from '../models/TriggerResponse';
+/**
+ * no description
+ */
+export declare class SubscriptionsApiRequestFactory extends BaseAPIRequestFactory {
+    /**
+     * Creates a subscription for the given project.  This object represents the subscription where the project owner has subscribed to.
+     * Create subscription for project.
+     * @param createSubscriptionRequest
+     */
+    createSubscription(createSubscriptionRequest: CreateSubscriptionRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Creates a trigger for the given subscription.  This object represents the trigger where the subscription owner has subscribed to.
+     * Create trigger for subscription.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     * @param createTriggerRequest
+     */
+    createTrigger(id: string, createTriggerRequest: CreateTriggerRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Deletes a subscription for the given project.  This object represents the subscription where the project owner has subscribed to.
+     * Delete subscription of project.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     */
+    deleteSubscription(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Deletes a trigger for the given subscription.  This object represents the trigger where the subscription owner has subscribed to.
+     * Delete trigger of subscription.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     * @param triggerId Specifies the unique subscription ID (starts with sub_).
+     */
+    deleteTrigger(id: string, triggerId: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a subscription for the given project.  This object represents the subscription where the project owner has subscribed to.
+     * Get subscription of project.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     */
+    getSubscription(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a list of subscriptions for the given project.  This object represents the subscriptions where the project owner has subscribed to.  Subscriptions are returned sorted by creation date, with the most recently created subscriptions appearing first.  By default, a maximum of 10 subscriptions are shown per page.
+     * List subscriptions of project.
+     */
+    getSubscriptions(_options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a trigger for the given id.  This object represents the trigger where the subscription owner has subscribed to.
+     * Get trigger by id.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     * @param triggerId Specifies the unique subscription ID (starts with sub_).
+     */
+    getTrigger(id: string, triggerId: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Returns a list of triggers for the given subscription.  This object represents the triggers where the subscription owner has subscribed to.  Triggers are returned sorted by creation date, with the most recently created triggers appearing first.  By default, a maximum of 10 triggers are shown per page.
+     * List triggers of subscription.
+     * @param id Specifies the unique subscription ID (starts with sub_).
+     */
+    getTriggers(id: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Lists logs of the triggered subscriptions for the given project.  This object represents the logs of the triggered subscriptions where the project owner has subscribed to.
+     * List logs of triggered subscriptions.
+     * @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 topic Specifies the topic of the subscription logs
+     * @param status Specifies the status of the subscription logs
+     * @param object Specifies the object ID of the object related to triggered notification
+     * @param subscription Specifies the subscription ID
+     * @param trigger Specifies the trigger ID
+     * @param requestID Specifies the request ID
+     */
+    listSubscriptionLogs(limit?: number, skip?: number, order?: SortOrder, topic?: APITopic, status?: Status, object?: string, subscription?: string, trigger?: string, requestID?: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Test a trigger  Returns a trigger for the given id.
+     * Test trigger by id.
+     */
+    testTrigger(_options?: Configuration): Promise<RequestContext>;
+}
+export declare class SubscriptionsApiResponseProcessor {
+    /**
+     * 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 createSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createSubscription(response: ResponseContext): Promise<SubscriptionResponse>;
+    /**
+     * 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 createTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createTrigger(response: ResponseContext): Promise<TriggerResponse>;
+    /**
+     * 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 deleteSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteSubscription(response: ResponseContext): Promise<SubscriptionDeleteResponse>;
+    /**
+     * 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 deleteTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteTrigger(response: ResponseContext): Promise<TriggerDeleteResponse>;
+    /**
+     * 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 getSubscription
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getSubscription(response: ResponseContext): Promise<SubscriptionResponse>;
+    /**
+     * 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 getSubscriptions
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getSubscriptions(response: ResponseContext): Promise<SubscriptionListResponse>;
+    /**
+     * 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 getTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getTrigger(response: ResponseContext): Promise<TriggerResponse>;
+    /**
+     * 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 getTriggers
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getTriggers(response: ResponseContext): Promise<BaseEntityListResponseTriggerResponse>;
+    /**
+     * 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 listSubscriptionLogs
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listSubscriptionLogs(response: ResponseContext): Promise<BaseEntityListResponseLogResponse>;
+    /**
+     * 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 testTrigger
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    testTrigger(response: ResponseContext): Promise<void>;
+}