/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * 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'; import type { CreateWebhookRequest, CreateWebhookResponse, GetWebhookResponse, ListWebhooksResponse, UpdateWebhookResponse, WebhooksServiceUpdateBody } from '../models/index'; export interface WebhooksServiceCreateRequest { createWebhookRequest: CreateWebhookRequest; } export interface WebhooksServiceDeleteRequest { id: string; } export interface WebhooksServiceGetRequest { id: string; } export interface WebhooksServiceListRequest { status?: string; } export interface WebhooksServiceUpdateRequest { id: string; webhooksServiceUpdateBody: WebhooksServiceUpdateBody; } /** * WebhooksApi - interface * * @export * @interface WebhooksApiInterface */ export interface WebhooksApiInterface { /** * Creates request options for webhooksServiceCreate without sending the request * @param {CreateWebhookRequest} createWebhookRequest * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceCreateRequestOpts(requestParameters: WebhooksServiceCreateRequest): Promise; /** * Create a new webhook endpoint to receive event notifications when workflow steps complete. * @summary Create a webhook * @param {CreateWebhookRequest} createWebhookRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceCreateRaw(requestParameters: WebhooksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new webhook endpoint to receive event notifications when workflow steps complete. * Create a webhook */ webhooksServiceCreate(requestParameters: WebhooksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceDelete without sending the request * @param {string} id Identifier of the webhook to delete (UUID) * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceDeleteRequestOpts(requestParameters: WebhooksServiceDeleteRequest): Promise; /** * Remove a webhook endpoint so it no longer receives event notifications. * @summary Delete a webhook * @param {string} id Identifier of the webhook to delete (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceDeleteRaw(requestParameters: WebhooksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a webhook endpoint so it no longer receives event notifications. * Delete a webhook */ webhooksServiceDelete(requestParameters: WebhooksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceGet without sending the request * @param {string} id Identifier of the desired webhook (UUID) * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceGetRequestOpts(requestParameters: WebhooksServiceGetRequest): Promise; /** * Retrieve details for a specific webhook endpoint. * @summary Get a webhook * @param {string} id Identifier of the desired webhook (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceGetRaw(requestParameters: WebhooksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve details for a specific webhook endpoint. * Get a webhook */ webhooksServiceGet(requestParameters: WebhooksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceList without sending the request * @param {string} [status] Filter by webhook status (optional) - WEBHOOK_STATUS_UNSPECIFIED: Webhook status not specified - WEBHOOK_STATUS_ACTIVE: Webhook is active and receiving events - WEBHOOK_STATUS_DISABLED: Webhook is disabled due to repeated failures - WEBHOOK_STATUS_PAUSED: Webhook is paused by user action * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceListRequestOpts(requestParameters: WebhooksServiceListRequest): Promise; /** * Enumerate all webhooks for the workspace to manage event integrations. * @summary List webhooks * @param {string} [status] Filter by webhook status (optional) - WEBHOOK_STATUS_UNSPECIFIED: Webhook status not specified - WEBHOOK_STATUS_ACTIVE: Webhook is active and receiving events - WEBHOOK_STATUS_DISABLED: Webhook is disabled due to repeated failures - WEBHOOK_STATUS_PAUSED: Webhook is paused by user action * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceListRaw(requestParameters: WebhooksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enumerate all webhooks for the workspace to manage event integrations. * List webhooks */ webhooksServiceList(requestParameters: WebhooksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceUpdate without sending the request * @param {string} id Identifier of the webhook to update (UUID) * @param {WebhooksServiceUpdateBody} webhooksServiceUpdateBody * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceUpdateRequestOpts(requestParameters: WebhooksServiceUpdateRequest): Promise; /** * Modify an existing webhook endpoint configuration. * @summary Update a webhook * @param {string} id Identifier of the webhook to update (UUID) * @param {WebhooksServiceUpdateBody} webhooksServiceUpdateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApiInterface */ webhooksServiceUpdateRaw(requestParameters: WebhooksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify an existing webhook endpoint configuration. * Update a webhook */ webhooksServiceUpdate(requestParameters: WebhooksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface { /** * Creates request options for webhooksServiceCreate without sending the request */ webhooksServiceCreateRequestOpts(requestParameters: WebhooksServiceCreateRequest): Promise; /** * Create a new webhook endpoint to receive event notifications when workflow steps complete. * Create a webhook */ webhooksServiceCreateRaw(requestParameters: WebhooksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new webhook endpoint to receive event notifications when workflow steps complete. * Create a webhook */ webhooksServiceCreate(requestParameters: WebhooksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceDelete without sending the request */ webhooksServiceDeleteRequestOpts(requestParameters: WebhooksServiceDeleteRequest): Promise; /** * Remove a webhook endpoint so it no longer receives event notifications. * Delete a webhook */ webhooksServiceDeleteRaw(requestParameters: WebhooksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a webhook endpoint so it no longer receives event notifications. * Delete a webhook */ webhooksServiceDelete(requestParameters: WebhooksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceGet without sending the request */ webhooksServiceGetRequestOpts(requestParameters: WebhooksServiceGetRequest): Promise; /** * Retrieve details for a specific webhook endpoint. * Get a webhook */ webhooksServiceGetRaw(requestParameters: WebhooksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve details for a specific webhook endpoint. * Get a webhook */ webhooksServiceGet(requestParameters: WebhooksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceList without sending the request */ webhooksServiceListRequestOpts(requestParameters: WebhooksServiceListRequest): Promise; /** * Enumerate all webhooks for the workspace to manage event integrations. * List webhooks */ webhooksServiceListRaw(requestParameters: WebhooksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enumerate all webhooks for the workspace to manage event integrations. * List webhooks */ webhooksServiceList(requestParameters?: WebhooksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksServiceUpdate without sending the request */ webhooksServiceUpdateRequestOpts(requestParameters: WebhooksServiceUpdateRequest): Promise; /** * Modify an existing webhook endpoint configuration. * Update a webhook */ webhooksServiceUpdateRaw(requestParameters: WebhooksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify an existing webhook endpoint configuration. * Update a webhook */ webhooksServiceUpdate(requestParameters: WebhooksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }