cvat-sdk/dist/api-client/guides-api.d.ts

CVAT SDK is a Javascript library. It provides you access to Javascript functions and objects that simplify server interaction and provide additional functionality like data validation and serialization.

import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { AnnotationGuideRead } from '../models';
import type { AnnotationGuideWriteRequest } from '../models';
import type { PatchedAnnotationGuideWriteRequest } from '../models';
export declare const GuidesApiAxiosParamCreator: (configuration?: Configuration) => {
    guidesCreate: (annotationGuideWriteRequest?: AnnotationGuideWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    guidesDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    guidesPartialUpdate: (id: number, patchedAnnotationGuideWriteRequest?: PatchedAnnotationGuideWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    guidesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
export declare const GuidesApiFp: (configuration?: Configuration) => {
    guidesCreate(annotationGuideWriteRequest?: AnnotationGuideWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotationGuideRead>>;
    guidesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    guidesPartialUpdate(id: number, patchedAnnotationGuideWriteRequest?: PatchedAnnotationGuideWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotationGuideRead>>;
    guidesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotationGuideRead>>;
};
export declare const GuidesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    guidesCreate(requestParameters?: GuidesApiGuidesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnnotationGuideRead>;
    guidesDestroy(requestParameters: GuidesApiGuidesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    guidesPartialUpdate(requestParameters: GuidesApiGuidesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnnotationGuideRead>;
    guidesRetrieve(requestParameters: GuidesApiGuidesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnnotationGuideRead>;
};
export interface GuidesApiGuidesCreateRequest {
    readonly annotationGuideWriteRequest?: AnnotationGuideWriteRequest;
}
export interface GuidesApiGuidesDestroyRequest {
    readonly id: number;
}
export interface GuidesApiGuidesPartialUpdateRequest {
    readonly id: number;
    readonly patchedAnnotationGuideWriteRequest?: PatchedAnnotationGuideWriteRequest;
}
export interface GuidesApiGuidesRetrieveRequest {
    readonly id: number;
}
export declare class GuidesApi extends BaseAPI {
    guidesCreate(requestParameters?: GuidesApiGuidesCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnnotationGuideRead, any>>;
    guidesDestroy(requestParameters: GuidesApiGuidesDestroyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    guidesPartialUpdate(requestParameters: GuidesApiGuidesPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnnotationGuideRead, any>>;
    guidesRetrieve(requestParameters: GuidesApiGuidesRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnnotationGuideRead, any>>;
}