SDK: signals

The signals area has 4 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).

signalsDocuments

Send an audit or plan document: each unchecked item opens one task, and an item that is ticked or removed closes its task

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

signalsDocuments(args: { tenantId: string; projectId: string; body: EngineDocumentRequest }, options?: CallOptions): Promise<EngineDocumentResult>

signalsList

The signals the task engine tracks, each with the task it opened and why it closed; state=open or state=cleared narrows the list

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

signalsList(args: { tenantId: string; projectId: string; query?: { state?: string } }, options?: CallOptions): Promise<EngineSignalList>

signalsSettingsGet

Whether the task engine opens tasks on its own for this project: automatic, supervised (opened paused with a reason) or manual (the signal is recorded and nothing opens)

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

signalsSettingsGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<TaskCreationSettings>

signalsSettingsPut

Set task creation for this project (task policy class)

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/signals/settings

signalsSettingsPut(args: { tenantId: string; projectId: string; body: SetTaskCreationRequest }, options?: CallOptions): Promise<TaskCreationSettings>