/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * 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 { CreateWebhookRequestBody, RecallWebhookRequest, UpdateWebhookRequestBody, WebhookSchema, WebhooksSchema } from '../models/index'; export interface CreateWebhookRequest { createWebhookRequestBody: CreateWebhookRequestBody; } export interface DeleteWebhookRequest { webhookId: string; } export interface ListWebhooksRequest { filterStatus?: ListWebhooksFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface RecallWebhookOperationRequest { tenantId: string; meetingId: string; recallWebhookRequest: RecallWebhookRequest; } export interface RecallWebhookOptionsRequest { tenantId: string; meetingId: string; } export interface ShowWebhookRequest { webhookId: string; } export interface UpdateWebhookRequest { webhookId: string; updateWebhookRequestBody: UpdateWebhookRequestBody; } export interface WebhookOptionsRequest { webhookId: string; } /** * */ export declare class WebhooksApi extends runtime.BaseAPI { /** * Creates request options for createWebhook without sending the request */ createWebhookRequestOpts(requestParameters: CreateWebhookRequest): Promise; /** * Creates a new webhook in your account. ### Webhook\'s Attributes Here is a table that describes the attributes of the webhook object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the webhook. | | `status` | string | The current status of the webhook (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the webhook was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the webhook was last modified (ISO 8601 format). | * Create Webhook */ createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new webhook in your account. ### Webhook\'s Attributes Here is a table that describes the attributes of the webhook object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the webhook. | | `status` | string | The current status of the webhook (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the webhook was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the webhook was last modified (ISO 8601 format). | * Create Webhook */ createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteWebhook without sending the request */ deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise; /** * This endpoint allows you to delete a specific webhook from your account. Once deleted, the webhook\'s information will be permanently removed and cannot be recovered. * Delete Webhook */ deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific webhook from your account. Once deleted, the webhook\'s information will be permanently removed and cannot be recovered. * Delete Webhook */ deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listWebhooks without sending the request */ listWebhooksRequestOpts(requestParameters: ListWebhooksRequest): Promise; /** * Returns a collection of your account webhooks ## Overview Returns a collection of your account webhooks, sorted by the time they were inserted into the system in ascending order. ### Webhooks Endpoints Pagination The webhooks endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Webhooks */ listWebhooksRaw(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account webhooks ## Overview Returns a collection of your account webhooks, sorted by the time they were inserted into the system in ascending order. ### Webhooks Endpoints Pagination The webhooks endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Webhooks */ listWebhooks(requestParameters?: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for recallWebhook without sending the request */ recallWebhookRequestOpts(requestParameters: RecallWebhookOperationRequest): Promise; /** * Public endpoint recall.ai POSTs bot lifecycle events to. Resumes the parked workflow run on bot.done. * Recall.ai bot lifecycle webhook */ recallWebhookRaw(requestParameters: RecallWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Public endpoint recall.ai POSTs bot lifecycle events to. Resumes the parked workflow run on bot.done. * Recall.ai bot lifecycle webhook */ recallWebhook(requestParameters: RecallWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for recallWebhookOptions without sending the request */ recallWebhookOptionsRequestOpts(requestParameters: RecallWebhookOptionsRequest): Promise; /** * CORS preflight. * Recall webhook CORS preflight */ recallWebhookOptionsRaw(requestParameters: RecallWebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * CORS preflight. * Recall webhook CORS preflight */ recallWebhookOptions(requestParameters: RecallWebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showWebhook without sending the request */ showWebhookRequestOpts(requestParameters: ShowWebhookRequest): Promise; /** * This endpoint retrieves details of a specific webhook from your account. You can view information such as name, and other relevant attributes of the webhook. * Show Webhook */ showWebhookRaw(requestParameters: ShowWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific webhook from your account. You can view information such as name, and other relevant attributes of the webhook. * Show Webhook */ showWebhook(requestParameters: ShowWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateWebhook without sending the request */ updateWebhookRequestOpts(requestParameters: UpdateWebhookRequest): Promise; /** * This endpoint allows you to update details of a specific webhook in your account. You can modify information such as name, and other relevant attributes of the webhook. Only the fields provided in the request will be updated. * Update Webhook */ updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific webhook in your account. You can modify information such as name, and other relevant attributes of the webhook. Only the fields provided in the request will be updated. * Update Webhook */ updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhookOptions without sending the request */ webhookOptionsRequestOpts(requestParameters: WebhookOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Webhook Options */ webhookOptionsRaw(requestParameters: WebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Webhook Options */ webhookOptions(requestParameters: WebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for webhooksOptions without sending the request */ webhooksOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Webhooks Options */ webhooksOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Webhooks Options */ webhooksOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListWebhooksFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListWebhooksFilterStatusEnum = typeof ListWebhooksFilterStatusEnum[keyof typeof ListWebhooksFilterStatusEnum]; //# sourceMappingURL=WebhooksApi.d.ts.map