Function LabelsApiFp

Returns {
    labelsDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    labelsList(xOrganization?, color?, filter?, jobId?, name?, org?, orgId?, page?, pageSize?, parent?, parentId?, projectId?, search?, sort?, taskId?, type?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedLabelList>)>;
    labelsPartialUpdate(id, patchedLabelRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<Label>)>;
    labelsRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<Label>)>;
}

• labelsDestroy:function

  • labelsDestroy(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this label.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

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

    Throws

• labelsList:function

  • labelsList(xOrganization?, color?, filter?, jobId?, name?, org?, orgId?, page?, pageSize?, parent?, parentId?, projectId?, search?, sort?, taskId?, type?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedLabelList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional color: string

      A simple equality filter for the color field

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;name&#39;, &#39;parent&#39;, &#39;id&#39;, &#39;type&#39;, &#39;color&#39;, &#39;parent_id&#39;].

    • Optional jobId: number

      A simple equality filter for job id

    • Optional name: string

      A simple equality filter for the name field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional parent: string

      A simple equality filter for the parent field

    • Optional parentId: number

      A simple equality filter for the parent_id field

    • Optional projectId: number

      A simple equality filter for project id

    • Optional search: string

      A search term. Available search_fields: (&#39;name&#39;, &#39;parent&#39;)

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;name&#39;, &#39;parent&#39;, &#39;id&#39;, &#39;type&#39;, &#39;color&#39;, &#39;parent_id&#39;]

    • Optional taskId: number

      A simple equality filter for task id

    • Optional type: LabelsListTypeEnum

      A simple equality filter for the type field

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedLabelList>)>

    Summary

    Method returns a paginated list of labels

    Throws

• labelsPartialUpdate:function

  • labelsPartialUpdate(id, patchedLabelRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Label>)>

  • Parameters

    • id: number

      A unique integer value identifying this label.

    • Optional patchedLabelRequest: PatchedLabelRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => 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(id, options?): Promise<((axios?, basePath?) => AxiosPromise<Label>)>

  • Parameters

    • id: number

      A unique integer value identifying this label.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Label>)>

    Summary

    Method returns details of a label

    Throws