SDK: cycles

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

cyclesArchive

Archive a cycle; refused while issues use it

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/cycles/{cycleId}/archive

cyclesArchive(args: { tenantId: string; projectId: string; cycleId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Cycle>

cyclesCreate

Create a cycle

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

cyclesCreate(args: { tenantId: string; projectId: string; body: CreateCycleRequest }, options?: CallOptions): Promise<Cycle>

cyclesDelete

Delete a cycle: 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}/cycles/{cycleId}

cyclesDelete(args: { tenantId: string; projectId: string; cycleId: string }, options?: CallOptions): Promise<Cycle>

cyclesList

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

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

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

cyclesRestore

Restore an archived cycle within 30 days

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/cycles/{cycleId}/restore

cyclesRestore(args: { tenantId: string; projectId: string; cycleId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Cycle>

cyclesUpdate

Rename a cycle or move its dates

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/cycles/{cycleId}

cyclesUpdate(args: { tenantId: string; projectId: string; cycleId: string; body: UpdateCycleRequest }, options?: CallOptions): Promise<Cycle>