Skip to main content
Call path: mgmt.scopes after new ModusManagement(...).

Properties

ManagementScopesOperations
required

Methods

acceptOwnershipTransfer()

Accept a pending scope ownership transfer.

Parameters

string | number
required

Returns

Promise<object>

cancelOwnershipTransfer()

Cancel a pending scope ownership transfer.

Parameters

string | number
required

Returns

Promise<object>

conversations()

Conversations for a scope.

Parameters

string | number
required
Scope id.

Returns

ScopeConversationsResource A conversations resource scoped to the scope.

create()

Create a new scope in the organization.

Parameters

CreateScopeOptions
required

Returns

Promise<object> The created scope (draft).

delete()

Delete a scope.

Parameters

string | number
required
Scope id.

Returns

Promise<void> Resolves when the scope is deleted.

deploy()

Publish the current draft of a scope.

Parameters

string | number
required
Scope id.

Returns

Promise<object> The published scope.

evaluations()

Evaluations for a scope.

Parameters

string | number
required
Scope id.

Returns

ScopeEvaluationsResource An evaluations resource scoped to the scope.

get()

Retrieve a scope with full configuration.

Parameters

string | number
required
Scope id.
{ view: VariationView }

Returns

Promise<object> The scope.

getVariation()

Retrieve a specific scope variation by uid.

Parameters

string | number
required
Scope id.
{ variationUid: string }
required

Returns

Promise<object> The scope variation.

list()

List scopes in the organization.

Parameters

Returns

Promise<Page<object>> A page of scopes.

memories()

Long-term memories for a scope.

Parameters

string | number
required
Scope id.

Returns

ScopeMemoriesResource A memories resource scoped to the scope.

patchMcpConfig()

Update MCP server configuration for a scope.

Parameters

string | number
required
Scope id.
required

Returns

Promise<void>

requestOwnershipTransfer()

Start transferring ownership of a scope to another organization member.

Parameters

string | number
required
Scope id.
{ newOwnerUserId: string }
required

Returns

Promise<object> The scope with a pending ownership transfer.

restore()

Restore a previously deleted scope.

Parameters

string | number
required
Scope id.

Returns

Promise<object> The restored scope.

supervision()

Supervision (subordinate scopes) for a scope.

Parameters

string | number
required
Scope id.

Returns

ScopeSupervisionResource A supervision resource scoped to the scope.

update()

Update a scope’s configuration. Only the fields you pass are changed. To clear a field, name it in updateMask (comma-separated field names) and leave its argument unset.

Parameters

string | number
required
Scope id.
UpdateScopeOptions

Returns

Promise<object> The updated scope.