Function GuidesApiFactory

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

• guidesCreate:function

  • guidesCreate(
        requestParameters?: GuidesApiGuidesCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationGuideRead>

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

    Parameters

    • requestParameters: GuidesApiGuidesCreateRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Throws

• guidesDestroy:function

  • guidesDestroy(
        requestParameters: GuidesApiGuidesDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    This also deletes all assets attached to the guide.

    Parameters

    • requestParameters: GuidesApiGuidesDestroyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• guidesPartialUpdate:function

  • guidesPartialUpdate(
        requestParameters: GuidesApiGuidesPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationGuideRead>

    Parameters

    • requestParameters: GuidesApiGuidesPartialUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Throws

• guidesRetrieve:function

  • guidesRetrieve(
        requestParameters: GuidesApiGuidesRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationGuideRead>

    Parameters

    • requestParameters: GuidesApiGuidesRetrieveRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Throws