Class GuidesApi

GuidesApi - object-oriented interface

Export

Hierarchy

BaseAPI
- GuidesApi

Index

Constructors

Properties

axios basePath configuration

Methods

guidesCreate guidesDestroy guidesPartialUpdate guidesRetrieve

Constructors

constructor

new GuidesApi(configuration?, basePath?, axios?): GuidesApi
Parameters
- Optional configuration: 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?, options?): Promise<AxiosResponse<AnnotationGuideRead, any>>
Parameters
- requestParameters: GuidesApiGuidesCreateRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AnnotationGuideRead, any>>

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

Throws

Memberof
GuidesApi
- Defined in api-client/guides-api.ts:421

guidesDestroy

guidesDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: GuidesApiGuidesDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a specific annotation guide and all attached assets

Throws

Memberof
GuidesApi
- Defined in api-client/guides-api.ts:433

guidesPartialUpdate

guidesPartialUpdate(requestParameters, options?): Promise<AxiosResponse<AnnotationGuideRead, any>>
Parameters
- requestParameters: GuidesApiGuidesPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AnnotationGuideRead, any>>

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

Throws

Memberof
GuidesApi
- Defined in api-client/guides-api.ts:445

guidesRetrieve

guidesRetrieve(requestParameters, options?): Promise<AxiosResponse<AnnotationGuideRead, any>>
Parameters
- requestParameters: GuidesApiGuidesRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AnnotationGuideRead, any>>

Summary
Method returns details of a specific annotation guide

Throws

Memberof
GuidesApi
- Defined in api-client/guides-api.ts:457

Generated using TypeDoc