SDK: labels

The labels area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

labelsArchive

Archive a label; refused while issues use it

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}/archive

labelsArchive(args: { tenantId: string; projectId: string; labelId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Label>

labelsCreate

Create a label

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/labels

labelsCreate(args: { tenantId: string; projectId: string; body: CreateLabelRequest }, options?: CallOptions): Promise<Label>

labelsDelete

Delete a label: it is archived and can be restored for 30 days, then removed; refused while issues use it

• Request: DELETE on /v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}

labelsDelete(args: { tenantId: string; projectId: string; labelId: string }, options?: CallOptions): Promise<Label>

labelsList

List labels; archived=true lists the archived ones that can still be restored

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/labels

labelsList(args: { tenantId: string; projectId: string; query?: { archived?: string } }, options?: CallOptions): Promise<LabelList>

labelsRestore

Restore an archived label within 30 days

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}/restore

labelsRestore(args: { tenantId: string; projectId: string; labelId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Label>

labelsUpdate

Rename a label or change its colour

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}

labelsUpdate(args: { tenantId: string; projectId: string; labelId: string; body: UpdateLabelRequest }, options?: CallOptions): Promise<Label>