import type { CancelablePromise } from '../core/CancelablePromise'; import type { BaseHttpRequest } from '../core/BaseHttpRequest'; export declare class ScreenshotsService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Create screenshot from base64 * Create a screenshot by providing a base64 encoded image string * @param projectId The unique identifier of the project. * @param requestBody * @returns any Success * @throws ApiError */ createScreenshotFromBase64(projectId: string, requestBody: { /** * The base64 encoded image data */ base64_image: string; /** * The name of the file */ file_name: string; }): CancelablePromise<{ /** * The unique identifier of the screenshot */ id: string; /** * The URL where you can access the screenshot */ url: string; /** * The URL where you can access the thumbnail of the screenshot */ thumbnail_url: string; /** * When the screenshot was created */ created_at: string; /** * The user who created the screenshot */ created_by: { email: string; name: string; }; /** * The name of the file */ file_name: string; /** * The key coordinates associated with the screenshot */ key_coordinates: Array<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; }>; /** * Get all screenshots * @param projectId The unique identifier of the project. * @param page * @param pageSize * @returns any Success * @throws ApiError */ getAllScreenshots(projectId: string, page: number, pageSize: number): CancelablePromise<{ metadata: { fetched_at: string; total_count: number; total_pages: number; current_page: number; page_size: number; }; data: Array<{ /** * The unique identifier of the screenshot */ id: string; /** * The URL where you can access the screenshot */ url: string; /** * The URL where you can access the thumbnail of the screenshot */ thumbnail_url: string; /** * When the screenshot was created */ created_at: string; /** * The user who created the screenshot */ created_by: { email: string; name: string; }; /** * The name of the file */ file_name: string; /** * The key coordinates associated with the screenshot */ key_coordinates: Array<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; }>; }>; /** * Get screenshot * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @returns any Success * @throws ApiError */ getScreenshot(projectId: string, screenshotId: string): CancelablePromise<{ /** * The unique identifier of the screenshot */ id: string; /** * The URL where you can access the screenshot */ url: string; /** * The URL where you can access the thumbnail of the screenshot */ thumbnail_url: string; /** * When the screenshot was created */ created_at: string; /** * The user who created the screenshot */ created_by: { email: string; name: string; }; /** * The name of the file */ file_name: string; /** * The key coordinates associated with the screenshot */ key_coordinates: Array<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; }>; /** * Delete screenshot * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @returns any Success * @throws ApiError */ deleteScreenshot(projectId: string, screenshotId: string): CancelablePromise; /** * Create screenshot key coordinates * Reference specific coordinates on a screenshot that relate to a key * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @param requestBody * @returns any Success * @throws ApiError */ createScreenshotKeyCoordinates(projectId: string, screenshotId: string, requestBody: { /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }): CancelablePromise<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; /** * Get all screenshot key coordinates * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @param page * @param pageSize * @returns any Success * @throws ApiError */ getAllScreenshotKeyCoordinates(projectId: string, screenshotId: string, page: number, pageSize: number): CancelablePromise<{ metadata: { fetched_at: string; total_count: number; total_pages: number; current_page: number; page_size: number; }; data: Array<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; }>; /** * Get screenshot key coordinates * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @param keyCoordinatePk * @returns any Success * @throws ApiError */ getScreenshotKeyCoordinates(projectId: string, screenshotId: string, keyCoordinatePk: string): CancelablePromise<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; /** * Update screenshot key coordinates * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @param keyCoordinatePk * @param requestBody * @returns any Success * @throws ApiError */ updateScreenshotKeyCoordinates(projectId: string, screenshotId: string, keyCoordinatePk: string, requestBody: { /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }): CancelablePromise<{ /** * The unique identifier of the screenshot key coordinates */ id: string; /** * The unique identifier of the key associated with the screenshot key coordinates */ key_id: string; /** * When the screenshot key coordinates was created */ created_at: string; /** * The user who created the screenshot key coordinates */ created_by: { email: string; name: string; }; /** * The coordinates in the image where the key is located */ coordinates_in_image: { /** * The coordinates in the image where the key is located */ 'x': number; /** * The coordinates in the image where the key is located */ 'y': number; /** * The size of the area in the image where the key is located */ height: number; /** * The size of the area in the image where the key is located */ width: number; }; }>; /** * Delete screenshot key coordinates * @param projectId The unique identifier of the project. * @param screenshotId The unique identifier of the screenshot. * @param keyCoordinatePk * @returns any Success * @throws ApiError */ deleteScreenshotKeyCoordinates(projectId: string, screenshotId: string, keyCoordinatePk: string): CancelablePromise; }