Skip to content

SDK: rules

The rules methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types.

Updated View as MarkdownOpen in ChatGPTOpen in Claude

The rules area has 2 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).

rulesGet

The rules text the project’s task payloads use

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/rules
rulesGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ProjectRules>

rulesPut

Set the rules text the project’s task payloads use (the text of the rules source file)

  • Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/rules
rulesPut(args: { tenantId: string; projectId: string; body: SetRulesRequest }, options?: CallOptions): Promise<ProjectRules>
Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.