Class LabelsApi

LabelsApi - object-oriented interface

Export

LabelsApi

Hierarchy

BaseAPI
- LabelsApi

Index

Constructors

Properties

axios basePath configuration

Methods

labelsDestroy labelsList labelsPartialUpdate labelsRetrieve

Constructors

constructor

new LabelsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): LabelsApi
Parameters
- Optionalconfiguration: 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: LabelsApiLabelsDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
To delete a sublabel, please use the PATCH method of the parent label.
Parameters
- requestParameters: LabelsApiLabelsDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LabelsApi
- Defined in api-client/labels-api.ts:624

labelsList

labelsList(
requestParameters?: LabelsApiLabelsListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedLabelList, any>>
Parameters
- requestParameters: LabelsApiLabelsListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedLabelList, any>>
Throws
Memberof
LabelsApi
- Defined in api-client/labels-api.ts:636

labelsPartialUpdate

labelsPartialUpdate(
requestParameters: LabelsApiLabelsPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Label, any>>
To modify a sublabel, please use the PATCH method of the parent label.
Parameters
- requestParameters: LabelsApiLabelsPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Label, any>>
Throws
Memberof
LabelsApi
- Defined in api-client/labels-api.ts:648

labelsRetrieve

labelsRetrieve(
requestParameters: LabelsApiLabelsRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Label, any>>
Parameters
- requestParameters: LabelsApiLabelsRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Label, any>>
Throws
Memberof
LabelsApi
- Defined in api-client/labels-api.ts:660