Function GuidesApiAxiosParamCreator

GuidesApi - axios parameter creator

Export

  • 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>;
    }

    Parameters

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

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

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

      Throws

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

      This also deletes all assets attached to the guide.

      Throws

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

      Throws

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

      Throws

Settings

Member Visibility