SDK: issues

The issues area has 10 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).

issuesArchive

Archive an issue: hidden from lists, restorable for 30 days, then removed; refused while its task holds a lease

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/issues/{issueId}/archive

issuesArchive(args: { tenantId: string; projectId: string; issueId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Issue>

issuesAssign

Assign an issue to a person, agent or bot; agents and bots get the issue’s one task

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/issues/{issueId}/assign

issuesAssign(args: { tenantId: string; projectId: string; issueId: string; body: AssignIssueRequest }, options?: CallOptions): Promise<AssignResult>

issuesCreate

Create an issue

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

issuesCreate(args: { tenantId: string; projectId: string; body: CreateIssueRequest }, options?: CallOptions): Promise<Issue>

issuesEvents

The audit trail of an issue

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/issues/{issueId}/events

issuesEvents(args: { tenantId: string; projectId: string; issueId: string }, options?: CallOptions): Promise<IssueEventList>

issuesGet

Read an issue

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

issuesGet(args: { tenantId: string; projectId: string; issueId: string }, options?: CallOptions): Promise<Issue>

issuesImport

Import issues from a Linear, Jira or GitHub Projects export

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/issues-import

issuesImport(args: { tenantId: string; projectId: string; body: ImportRequest }, options?: CallOptions): Promise<ImportReport>

issuesList

List a project’s issues; archived=true lists the archived ones that can still be restored

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

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

issuesPull

Pull issues from a connected Linear workspace or GitHub repository; read only at the tracker, idempotent by the tracker’s own ID, with dryRun to check first

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/issues-pull

issuesPull(args: { tenantId: string; projectId: string; body: PullIssuesRequest }, options?: CallOptions): Promise<ImportReport>

issuesRestore

Restore an archived issue within 30 days

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/issues/{issueId}/restore

issuesRestore(args: { tenantId: string; projectId: string; issueId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Issue>

issuesUpdate

Change an issue’s fields; status can never be set to done

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/issues/{issueId}

issuesUpdate(args: { tenantId: string; projectId: string; issueId: string; body: UpdateIssueRequest }, options?: CallOptions): Promise<Issue>