Function GuidesApiAxiosParamCreator

Returns {
    guidesCreate: ((annotationGuideWriteRequest?, options?) => Promise<RequestArgs>);
    guidesDestroy: ((id, options?) => Promise<RequestArgs>);
    guidesPartialUpdate: ((id, patchedAnnotationGuideWriteRequest?, options?) => Promise<RequestArgs>);
    guidesRetrieve: ((id, options?) => Promise<RequestArgs>);
}

• guidesCreate: ((annotationGuideWriteRequest?, options?) => Promise<RequestArgs>)

  • • (annotationGuideWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • Optional annotationGuideWriteRequest: AnnotationGuideWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method creates a new annotation guide binded to a project or to a task

      Throws

• guidesDestroy: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this annotation guide.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes a specific annotation guide and all attached assets

      Throws

• guidesPartialUpdate: ((id, patchedAnnotationGuideWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedAnnotationGuideWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this annotation guide.

      • Optional patchedAnnotationGuideWriteRequest: PatchedAnnotationGuideWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in an annotation guide

      Throws

• guidesRetrieve: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this annotation guide.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of a specific annotation guide

      Throws