anchorbrowser
Version:
The official TypeScript library for the Anchorbrowser API
98 lines • 3.04 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import * as Shared from "../../shared.mjs";
import * as PrimaryAPI from "./primary.mjs";
import { Primary } from "./primary.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class Recordings extends APIResource {
primary: PrimaryAPI.Primary;
/**
* Retrieves the URLs of the browser session's video recordings. Requires a valid
* API key for authentication.
*
* @example
* ```ts
* const recordings = await client.sessions.recordings.list(
* 'session_id',
* );
* ```
*/
list(sessionID: string, options?: RequestOptions): APIPromise<RecordingListResponse>;
/**
* Pauses the video recording for the specified browser session.
*
* @example
* ```ts
* const response = await client.sessions.recordings.pause(
* 'session_id',
* );
* ```
*/
pause(sessionID: string, options?: RequestOptions): APIPromise<RecordingPauseResponse>;
/**
* Resumes the video recording for the specified browser session.
*
* @example
* ```ts
* const response = await client.sessions.recordings.resume(
* 'session_id',
* );
* ```
*/
resume(sessionID: string, options?: RequestOptions): APIPromise<RecordingResumeResponse>;
}
export interface RecordingListResponse {
data?: RecordingListResponse.Data;
}
export declare namespace RecordingListResponse {
interface Data {
/**
* Total number of video recordings
*/
count?: number;
items?: Array<Data.Item>;
}
namespace Data {
interface Item {
/**
* Unique identifier for the recording
*/
id?: string;
/**
* Timestamp when the recording was created
*/
created_at?: string;
/**
* Duration of the recording
*/
duration?: string;
/**
* URL to access the recording file
*/
file_link?: string;
/**
* Indicates if this is the primary recording
*/
is_primary?: boolean;
/**
* Size of the recording file in bytes
*/
size?: number;
/**
* Suggested filename for the recording
*/
suggested_file_name?: string;
}
}
}
export interface RecordingPauseResponse {
data?: Shared.SuccessResponse;
}
export interface RecordingResumeResponse {
data?: Shared.SuccessResponse;
}
export declare namespace Recordings {
export { type RecordingListResponse as RecordingListResponse, type RecordingPauseResponse as RecordingPauseResponse, type RecordingResumeResponse as RecordingResumeResponse, };
export { Primary as Primary };
}
//# sourceMappingURL=recordings.d.mts.map