Class LabelsApi

LabelsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- LabelsApi

Index

Constructors

Properties

axios basePath configuration

Methods

labelsDestroy labelsList labelsPartialUpdate labelsRetrieve

Constructors

constructor

new LabelsApi(configuration?, basePath?, axios?): LabelsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LabelsApi
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

labelsDestroy

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

Summary
Method deletes a label. To delete a sublabel, please use the PATCH method of the parent label

Throws

Memberof
LabelsApi
- Defined in api-client/labels-api.ts:617

labelsList

labelsList(requestParameters?, options?): Promise<AxiosResponse<PaginatedLabelList, any>>
Parameters
- requestParameters: LabelsApiLabelsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedLabelList, any>>

Summary
Method returns a paginated list of labels

Throws

Memberof
LabelsApi
- Defined in api-client/labels-api.ts:629

labelsPartialUpdate

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

Summary
Methods does a partial update of chosen fields in a labelTo modify a sublabel, please use the PATCH method of the parent label

Throws

Memberof
LabelsApi
- Defined in api-client/labels-api.ts:641

labelsRetrieve

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

Summary
Method returns details of a label

Throws

Memberof
LabelsApi
- Defined in api-client/labels-api.ts:653

Generated using TypeDoc