Function LabelsApiFactory

Returns {
    labelsDestroy(requestParameters, options?) => AxiosPromise<void>;
    labelsList(requestParameters?, options?) => AxiosPromise<PaginatedLabelList>;
    labelsPartialUpdate(requestParameters, options?) => AxiosPromise<Label>;
    labelsRetrieve(requestParameters, options?) => AxiosPromise<Label>;
}

• labelsDestroy:function

  • labelsDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LabelsApiLabelsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

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

    Throws

• labelsList:function

  • labelsList(requestParameters?, options?): AxiosPromise<PaginatedLabelList>

  • Parameters

    • requestParameters: LabelsApiLabelsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedLabelList>

    Summary

    Method returns a paginated list of labels

    Throws

• labelsPartialUpdate:function

  • labelsPartialUpdate(requestParameters, options?): AxiosPromise<Label>

  • Parameters

    • requestParameters: LabelsApiLabelsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Label>

    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

• labelsRetrieve:function

  • labelsRetrieve(requestParameters, options?): AxiosPromise<Label>

  • Parameters

    • requestParameters: LabelsApiLabelsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Label>

    Summary

    Method returns details of a label

    Throws