@meeting-baas/sdk
Version:
Official SDK for Meeting BaaS API - https://meetingbaas.com
513 lines (512 loc) • 33.7 kB
TypeScript
/**
* Meeting BaaS API
* Meeting BaaS API
*
* The version of the OpenAPI document: 1.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { DeleteResponse } from '../models';
import type { JoinRequest } from '../models';
import type { JoinResponse } from '../models';
import type { LeaveResponse } from '../models';
import type { ListRecentBotsResponse } from '../models';
import type { Metadata } from '../models';
import type { RetranscribeBody } from '../models';
import type { ScreenshotWrapper } from '../models';
/**
* DefaultApi - axios parameter creator
* @export
*/
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Retrieves a paginated list of the user\'s bots with essential metadata, including IDs, names, and meeting details. Supports filtering, sorting, and advanced querying options.
* @summary List Bots with Metadata
* @param {string | null} [botName] Filter bots by name containing this string. Performs a case-insensitive partial match on the bot\'s name. Useful for finding bots with specific naming conventions or to locate a particular bot when you don\'t have its ID. Example: \"Sales\" would match \"Sales Meeting\", \"Quarterly Sales\", etc.
* @param {string | null} [createdAfter] Filter bots created after this date (ISO format). Limits results to bots created at or after the specified timestamp. Used for time-based filtering to find recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @param {string | null} [createdBefore] Filter bots created before this date (ISO format). Limits results to bots created at or before the specified timestamp. Used for time-based filtering to exclude recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-31T23:59:59\"
* @param {string | null} [cursor] Cursor for pagination, obtained from previous response. Used for retrieving the next set of results after a previous call. The cursor value is returned in the `nextCursor` field of responses that have additional results available. Format: Base64-encoded string containing pagination metadata
* @param {string | null} [endedAfter] Filter bots ended after this date (ISO format). Limits results to bots that ended at or after the specified timestamp. Useful for finding completed meetings within a specific time period. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @param {string | null} [filterByExtra] Filter bots by matching values in the extra JSON payload. This parameter performs in-memory filtering on the `extra` JSON field, similar to a SQL WHERE clause. It reduces the result set to only include bots that match all specified conditions. Format specifications: - Single condition: \"field:value\" - Multiple conditions: \"field1:value1,field2:value2\" Examples: - \"customerId:12345\" - Only bots with this customer ID - \"status:active,project:sales\" - Only active bots from sales projects Notes: - All conditions must match for a bot to be included - Values are matched exactly (case-sensitive) - Bots without the specified field are excluded
* @param {number} [limit] Maximum number of bots to return in a single request. Limits the number of results returned in a single API call. This parameter helps control response size and page length. Default: 10 Minimum: 1 Maximum: 50
* @param {string | null} [meetingUrl] Filter bots by meeting URL containing this string. Performs a case-insensitive partial match on the bot\'s meeting URL. Use this to find bots associated with specific meeting platforms or particular meeting IDs. Example: \"zoom.us\" would match all Zoom meetings
* @param {string | null} [sortByExtra] Sort the results by a field in the extra JSON payload. This parameter performs in-memory sorting on the `extra` JSON field, similar to a SQL ORDER BY clause. It changes the order of results but not which results are included. Format specifications: - Default (ascending): \"field\" - Explicit direction: \"field:asc\" or \"field:desc\" Examples: - \"customer_id\" - Sort by customer_id (ascending) - \"priority:desc\" - Sort by priority (descending) Notes: - Applied after all filtering - String comparison is used for sorting - Bots with the field come before bots without it - Can be combined with filter_by_extra
* @param {string | null} [speakerName] NOTE: this is a preview feature and not yet available Filter bots by speaker name containing this string. Performs a case-insensitive partial match on the speakers in the meeting. Useful for finding meetings that included a specific person. Example: \"John\" would match meetings with speakers like \"John Smith\" or \"John Doe\"
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
botsWithMetadata: (botName?: string | null, createdAfter?: string | null, createdBefore?: string | null, cursor?: string | null, endedAfter?: string | null, filterByExtra?: string | null, limit?: number, meetingUrl?: string | null, sortByExtra?: string | null, speakerName?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Deletes a bot\'s data including recording, transcription, and logs. Only metadata is retained. Rate limited to 5 requests per minute per API key.
* @summary Delete Data
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteData: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get meeting recording and metadata
* @summary Get Meeting Data
* @param {string} botId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMeetingData: (botId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves screenshots captured during the bot\'s session
* @summary Get Screenshots
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getScreenshots: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Have a bot join a meeting, now or in the future. You can provide a `webhook_url` parameter to receive webhook events specific to this bot, overriding your account\'s default webhook URL. Events include recording completion, failures, and transcription updates.
* @summary Join
* @param {JoinRequest} joinRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
join: (joinRequest: JoinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Leave
* @summary Leave
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leave: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Transcribe or retranscribe a bot\'s audio using the Default or your provided Speech to Text Provider
* @summary Retranscribe Bot
* @param {RetranscribeBody} retranscribeBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retranscribeBot: (retranscribeBody: RetranscribeBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* DefaultApi - functional programming interface
* @export
*/
export declare const DefaultApiFp: (configuration?: Configuration) => {
/**
* Retrieves a paginated list of the user\'s bots with essential metadata, including IDs, names, and meeting details. Supports filtering, sorting, and advanced querying options.
* @summary List Bots with Metadata
* @param {string | null} [botName] Filter bots by name containing this string. Performs a case-insensitive partial match on the bot\'s name. Useful for finding bots with specific naming conventions or to locate a particular bot when you don\'t have its ID. Example: \"Sales\" would match \"Sales Meeting\", \"Quarterly Sales\", etc.
* @param {string | null} [createdAfter] Filter bots created after this date (ISO format). Limits results to bots created at or after the specified timestamp. Used for time-based filtering to find recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @param {string | null} [createdBefore] Filter bots created before this date (ISO format). Limits results to bots created at or before the specified timestamp. Used for time-based filtering to exclude recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-31T23:59:59\"
* @param {string | null} [cursor] Cursor for pagination, obtained from previous response. Used for retrieving the next set of results after a previous call. The cursor value is returned in the `nextCursor` field of responses that have additional results available. Format: Base64-encoded string containing pagination metadata
* @param {string | null} [endedAfter] Filter bots ended after this date (ISO format). Limits results to bots that ended at or after the specified timestamp. Useful for finding completed meetings within a specific time period. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @param {string | null} [filterByExtra] Filter bots by matching values in the extra JSON payload. This parameter performs in-memory filtering on the `extra` JSON field, similar to a SQL WHERE clause. It reduces the result set to only include bots that match all specified conditions. Format specifications: - Single condition: \"field:value\" - Multiple conditions: \"field1:value1,field2:value2\" Examples: - \"customerId:12345\" - Only bots with this customer ID - \"status:active,project:sales\" - Only active bots from sales projects Notes: - All conditions must match for a bot to be included - Values are matched exactly (case-sensitive) - Bots without the specified field are excluded
* @param {number} [limit] Maximum number of bots to return in a single request. Limits the number of results returned in a single API call. This parameter helps control response size and page length. Default: 10 Minimum: 1 Maximum: 50
* @param {string | null} [meetingUrl] Filter bots by meeting URL containing this string. Performs a case-insensitive partial match on the bot\'s meeting URL. Use this to find bots associated with specific meeting platforms or particular meeting IDs. Example: \"zoom.us\" would match all Zoom meetings
* @param {string | null} [sortByExtra] Sort the results by a field in the extra JSON payload. This parameter performs in-memory sorting on the `extra` JSON field, similar to a SQL ORDER BY clause. It changes the order of results but not which results are included. Format specifications: - Default (ascending): \"field\" - Explicit direction: \"field:asc\" or \"field:desc\" Examples: - \"customer_id\" - Sort by customer_id (ascending) - \"priority:desc\" - Sort by priority (descending) Notes: - Applied after all filtering - String comparison is used for sorting - Bots with the field come before bots without it - Can be combined with filter_by_extra
* @param {string | null} [speakerName] NOTE: this is a preview feature and not yet available Filter bots by speaker name containing this string. Performs a case-insensitive partial match on the speakers in the meeting. Useful for finding meetings that included a specific person. Example: \"John\" would match meetings with speakers like \"John Smith\" or \"John Doe\"
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
botsWithMetadata(botName?: string | null, createdAfter?: string | null, createdBefore?: string | null, cursor?: string | null, endedAfter?: string | null, filterByExtra?: string | null, limit?: number, meetingUrl?: string | null, sortByExtra?: string | null, speakerName?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRecentBotsResponse>>;
/**
* Deletes a bot\'s data including recording, transcription, and logs. Only metadata is retained. Rate limited to 5 requests per minute per API key.
* @summary Delete Data
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteData(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
/**
* Get meeting recording and metadata
* @summary Get Meeting Data
* @param {string} botId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMeetingData(botId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Metadata>>;
/**
* Retrieves screenshots captured during the bot\'s session
* @summary Get Screenshots
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getScreenshots(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScreenshotWrapper>>>;
/**
* Have a bot join a meeting, now or in the future. You can provide a `webhook_url` parameter to receive webhook events specific to this bot, overriding your account\'s default webhook URL. Events include recording completion, failures, and transcription updates.
* @summary Join
* @param {JoinRequest} joinRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
join(joinRequest: JoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JoinResponse>>;
/**
* Leave
* @summary Leave
* @param {string} uuid The UUID identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leave(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaveResponse>>;
/**
* Transcribe or retranscribe a bot\'s audio using the Default or your provided Speech to Text Provider
* @summary Retranscribe Bot
* @param {RetranscribeBody} retranscribeBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retranscribeBot(retranscribeBody: RetranscribeBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* DefaultApi - factory interface
* @export
*/
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Retrieves a paginated list of the user\'s bots with essential metadata, including IDs, names, and meeting details. Supports filtering, sorting, and advanced querying options.
* @summary List Bots with Metadata
* @param {DefaultApiBotsWithMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
botsWithMetadata(requestParameters?: DefaultApiBotsWithMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListRecentBotsResponse>;
/**
* Deletes a bot\'s data including recording, transcription, and logs. Only metadata is retained. Rate limited to 5 requests per minute per API key.
* @summary Delete Data
* @param {DefaultApiDeleteDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteData(requestParameters: DefaultApiDeleteDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
/**
* Get meeting recording and metadata
* @summary Get Meeting Data
* @param {DefaultApiGetMeetingDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMeetingData(requestParameters: DefaultApiGetMeetingDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<Metadata>;
/**
* Retrieves screenshots captured during the bot\'s session
* @summary Get Screenshots
* @param {DefaultApiGetScreenshotsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getScreenshots(requestParameters: DefaultApiGetScreenshotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ScreenshotWrapper>>;
/**
* Have a bot join a meeting, now or in the future. You can provide a `webhook_url` parameter to receive webhook events specific to this bot, overriding your account\'s default webhook URL. Events include recording completion, failures, and transcription updates.
* @summary Join
* @param {DefaultApiJoinRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
join(requestParameters: DefaultApiJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise<JoinResponse>;
/**
* Leave
* @summary Leave
* @param {DefaultApiLeaveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leave(requestParameters: DefaultApiLeaveRequest, options?: RawAxiosRequestConfig): AxiosPromise<LeaveResponse>;
/**
* Transcribe or retranscribe a bot\'s audio using the Default or your provided Speech to Text Provider
* @summary Retranscribe Bot
* @param {DefaultApiRetranscribeBotRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retranscribeBot(requestParameters: DefaultApiRetranscribeBotRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
* DefaultApi - interface
* @export
* @interface DefaultApi
*/
export interface DefaultApiInterface {
/**
* Retrieves a paginated list of the user\'s bots with essential metadata, including IDs, names, and meeting details. Supports filtering, sorting, and advanced querying options.
* @summary List Bots with Metadata
* @param {DefaultApiBotsWithMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
botsWithMetadata(requestParameters?: DefaultApiBotsWithMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListRecentBotsResponse>;
/**
* Deletes a bot\'s data including recording, transcription, and logs. Only metadata is retained. Rate limited to 5 requests per minute per API key.
* @summary Delete Data
* @param {DefaultApiDeleteDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
deleteData(requestParameters: DefaultApiDeleteDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
/**
* Get meeting recording and metadata
* @summary Get Meeting Data
* @param {DefaultApiGetMeetingDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
getMeetingData(requestParameters: DefaultApiGetMeetingDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<Metadata>;
/**
* Retrieves screenshots captured during the bot\'s session
* @summary Get Screenshots
* @param {DefaultApiGetScreenshotsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
getScreenshots(requestParameters: DefaultApiGetScreenshotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ScreenshotWrapper>>;
/**
* Have a bot join a meeting, now or in the future. You can provide a `webhook_url` parameter to receive webhook events specific to this bot, overriding your account\'s default webhook URL. Events include recording completion, failures, and transcription updates.
* @summary Join
* @param {DefaultApiJoinRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
join(requestParameters: DefaultApiJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise<JoinResponse>;
/**
* Leave
* @summary Leave
* @param {DefaultApiLeaveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
leave(requestParameters: DefaultApiLeaveRequest, options?: RawAxiosRequestConfig): AxiosPromise<LeaveResponse>;
/**
* Transcribe or retranscribe a bot\'s audio using the Default or your provided Speech to Text Provider
* @summary Retranscribe Bot
* @param {DefaultApiRetranscribeBotRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
retranscribeBot(requestParameters: DefaultApiRetranscribeBotRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
}
/**
* Request parameters for botsWithMetadata operation in DefaultApi.
* @export
* @interface DefaultApiBotsWithMetadataRequest
*/
export interface DefaultApiBotsWithMetadataRequest {
/**
* Filter bots by name containing this string. Performs a case-insensitive partial match on the bot\'s name. Useful for finding bots with specific naming conventions or to locate a particular bot when you don\'t have its ID. Example: \"Sales\" would match \"Sales Meeting\", \"Quarterly Sales\", etc.
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly botName?: string | null;
/**
* Filter bots created after this date (ISO format). Limits results to bots created at or after the specified timestamp. Used for time-based filtering to find recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly createdAfter?: string | null;
/**
* Filter bots created before this date (ISO format). Limits results to bots created at or before the specified timestamp. Used for time-based filtering to exclude recent additions. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-31T23:59:59\"
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly createdBefore?: string | null;
/**
* Cursor for pagination, obtained from previous response. Used for retrieving the next set of results after a previous call. The cursor value is returned in the `nextCursor` field of responses that have additional results available. Format: Base64-encoded string containing pagination metadata
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly cursor?: string | null;
/**
* Filter bots ended after this date (ISO format). Limits results to bots that ended at or after the specified timestamp. Useful for finding completed meetings within a specific time period. Format: ISO-8601 date-time string (YYYY-MM-DDThh:mm:ss) Example: \"2023-05-01T00:00:00\"
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly endedAfter?: string | null;
/**
* Filter bots by matching values in the extra JSON payload. This parameter performs in-memory filtering on the `extra` JSON field, similar to a SQL WHERE clause. It reduces the result set to only include bots that match all specified conditions. Format specifications: - Single condition: \"field:value\" - Multiple conditions: \"field1:value1,field2:value2\" Examples: - \"customerId:12345\" - Only bots with this customer ID - \"status:active,project:sales\" - Only active bots from sales projects Notes: - All conditions must match for a bot to be included - Values are matched exactly (case-sensitive) - Bots without the specified field are excluded
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly filterByExtra?: string | null;
/**
* Maximum number of bots to return in a single request. Limits the number of results returned in a single API call. This parameter helps control response size and page length. Default: 10 Minimum: 1 Maximum: 50
* @type {number}
* @memberof DefaultApiBotsWithMetadata
*/
readonly limit?: number;
/**
* Filter bots by meeting URL containing this string. Performs a case-insensitive partial match on the bot\'s meeting URL. Use this to find bots associated with specific meeting platforms or particular meeting IDs. Example: \"zoom.us\" would match all Zoom meetings
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly meetingUrl?: string | null;
/**
* Sort the results by a field in the extra JSON payload. This parameter performs in-memory sorting on the `extra` JSON field, similar to a SQL ORDER BY clause. It changes the order of results but not which results are included. Format specifications: - Default (ascending): \"field\" - Explicit direction: \"field:asc\" or \"field:desc\" Examples: - \"customer_id\" - Sort by customer_id (ascending) - \"priority:desc\" - Sort by priority (descending) Notes: - Applied after all filtering - String comparison is used for sorting - Bots with the field come before bots without it - Can be combined with filter_by_extra
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly sortByExtra?: string | null;
/**
* NOTE: this is a preview feature and not yet available Filter bots by speaker name containing this string. Performs a case-insensitive partial match on the speakers in the meeting. Useful for finding meetings that included a specific person. Example: \"John\" would match meetings with speakers like \"John Smith\" or \"John Doe\"
* @type {string}
* @memberof DefaultApiBotsWithMetadata
*/
readonly speakerName?: string | null;
}
/**
* Request parameters for deleteData operation in DefaultApi.
* @export
* @interface DefaultApiDeleteDataRequest
*/
export interface DefaultApiDeleteDataRequest {
/**
* The UUID identifier
* @type {string}
* @memberof DefaultApiDeleteData
*/
readonly uuid: string;
}
/**
* Request parameters for getMeetingData operation in DefaultApi.
* @export
* @interface DefaultApiGetMeetingDataRequest
*/
export interface DefaultApiGetMeetingDataRequest {
/**
*
* @type {string}
* @memberof DefaultApiGetMeetingData
*/
readonly botId: string;
}
/**
* Request parameters for getScreenshots operation in DefaultApi.
* @export
* @interface DefaultApiGetScreenshotsRequest
*/
export interface DefaultApiGetScreenshotsRequest {
/**
* The UUID identifier
* @type {string}
* @memberof DefaultApiGetScreenshots
*/
readonly uuid: string;
}
/**
* Request parameters for join operation in DefaultApi.
* @export
* @interface DefaultApiJoinRequest
*/
export interface DefaultApiJoinRequest {
/**
*
* @type {JoinRequest}
* @memberof DefaultApiJoin
*/
readonly joinRequest: JoinRequest;
}
/**
* Request parameters for leave operation in DefaultApi.
* @export
* @interface DefaultApiLeaveRequest
*/
export interface DefaultApiLeaveRequest {
/**
* The UUID identifier
* @type {string}
* @memberof DefaultApiLeave
*/
readonly uuid: string;
}
/**
* Request parameters for retranscribeBot operation in DefaultApi.
* @export
* @interface DefaultApiRetranscribeBotRequest
*/
export interface DefaultApiRetranscribeBotRequest {
/**
*
* @type {RetranscribeBody}
* @memberof DefaultApiRetranscribeBot
*/
readonly retranscribeBody: RetranscribeBody;
}
/**
* DefaultApi - object-oriented interface
* @export
* @class DefaultApi
* @extends {BaseAPI}
*/
export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
/**
* Retrieves a paginated list of the user\'s bots with essential metadata, including IDs, names, and meeting details. Supports filtering, sorting, and advanced querying options.
* @summary List Bots with Metadata
* @param {DefaultApiBotsWithMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
botsWithMetadata(requestParameters?: DefaultApiBotsWithMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRecentBotsResponse, any>>;
/**
* Deletes a bot\'s data including recording, transcription, and logs. Only metadata is retained. Rate limited to 5 requests per minute per API key.
* @summary Delete Data
* @param {DefaultApiDeleteDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
deleteData(requestParameters: DefaultApiDeleteDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any>>;
/**
* Get meeting recording and metadata
* @summary Get Meeting Data
* @param {DefaultApiGetMeetingDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
getMeetingData(requestParameters: DefaultApiGetMeetingDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Metadata, any>>;
/**
* Retrieves screenshots captured during the bot\'s session
* @summary Get Screenshots
* @param {DefaultApiGetScreenshotsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
getScreenshots(requestParameters: DefaultApiGetScreenshotsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScreenshotWrapper[], any>>;
/**
* Have a bot join a meeting, now or in the future. You can provide a `webhook_url` parameter to receive webhook events specific to this bot, overriding your account\'s default webhook URL. Events include recording completion, failures, and transcription updates.
* @summary Join
* @param {DefaultApiJoinRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
join(requestParameters: DefaultApiJoinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JoinResponse, any>>;
/**
* Leave
* @summary Leave
* @param {DefaultApiLeaveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
leave(requestParameters: DefaultApiLeaveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LeaveResponse, any>>;
/**
* Transcribe or retranscribe a bot\'s audio using the Default or your provided Speech to Text Provider
* @summary Retranscribe Bot
* @param {DefaultApiRetranscribeBotRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
retranscribeBot(requestParameters: DefaultApiRetranscribeBotRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}