SDK: workprojects

The workprojects 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).

workprojectsArchive

Archive a work project; refused while issues use it

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/work-projects/{workProjectId}/archive

workprojectsArchive(args: { tenantId: string; projectId: string; workProjectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<WorkProject>

workprojectsCreate

Create a project to group issues

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

workprojectsCreate(args: { tenantId: string; projectId: string; body: CreateWorkProjectRequest }, options?: CallOptions): Promise<WorkProject>

workprojectsDelete

Delete a work project: 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}/work-projects/{workProjectId}

workprojectsDelete(args: { tenantId: string; projectId: string; workProjectId: string }, options?: CallOptions): Promise<WorkProject>

workprojectsList

List an issue project’s groupings; archived=true lists the archived ones that can still be restored

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

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

workprojectsRestore

Restore an archived work project within 30 days

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/work-projects/{workProjectId}/restore

workprojectsRestore(args: { tenantId: string; projectId: string; workProjectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<WorkProject>

workprojectsUpdate

Rename a work project or change its description

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/work-projects/{workProjectId}

workprojectsUpdate(args: { tenantId: string; projectId: string; workProjectId: string; body: UpdateWorkProjectRequest }, options?: CallOptions): Promise<WorkProject>