Function GuidesApiFp

Returns {
    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>,
    >;
}

• guidesCreate:function

  • guidesCreate(
        annotationGuideWriteRequest?: AnnotationGuideWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    The new guide will be bound either to a project or a task, depending on parameters.

    Parameters

    • OptionalannotationGuideWriteRequest: AnnotationGuideWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    Throws

• guidesDestroy:function

  • guidesDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    This also deletes all assets attached to the guide.

    Parameters

    • id: number

      A unique integer value identifying this annotation guide.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• guidesPartialUpdate:function

  • guidesPartialUpdate(
        id: number,
        patchedAnnotationGuideWriteRequest?: PatchedAnnotationGuideWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this annotation guide.
    • OptionalpatchedAnnotationGuideWriteRequest: PatchedAnnotationGuideWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    Throws

• guidesRetrieve:function

  • guidesRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this annotation guide.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationGuideRead>,
    >

    Throws