Class GuidesApi

GuidesApi - object-oriented interface

Export

GuidesApi

Hierarchy

BaseAPI
- GuidesApi

Index

Constructors

Properties

axios basePath configuration

Methods

guidesCreate guidesDestroy guidesPartialUpdate guidesRetrieve

Constructors

constructor

new GuidesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): GuidesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns GuidesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

guidesCreate

guidesCreate(
requestParameters?: GuidesApiGuidesCreateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AnnotationGuideRead, any>>
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 Promise<AxiosResponse<AnnotationGuideRead, any>>
Throws
Memberof
GuidesApi
- Defined in api-client/guides-api.ts:429

guidesDestroy

guidesDestroy(
requestParameters: GuidesApiGuidesDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
This also deletes all assets attached to the guide.
Parameters
- requestParameters: GuidesApiGuidesDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
GuidesApi
- Defined in api-client/guides-api.ts:441

guidesPartialUpdate

guidesPartialUpdate(
requestParameters: GuidesApiGuidesPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AnnotationGuideRead, any>>
Parameters
- requestParameters: GuidesApiGuidesPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AnnotationGuideRead, any>>
Throws
Memberof
GuidesApi
- Defined in api-client/guides-api.ts:453

guidesRetrieve

guidesRetrieve(
requestParameters: GuidesApiGuidesRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AnnotationGuideRead, any>>
Parameters
- requestParameters: GuidesApiGuidesRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AnnotationGuideRead, any>>
Throws
Memberof
GuidesApi
- Defined in api-client/guides-api.ts:465