SDK: operator

The operator area has 8 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).

operatorDiscountsGrant

Grant a workspace the open-source or startup discount (Overlane staff)

• Request: PUT on /v1/operator/discounts

operatorDiscountsGrant(args: { body: GrantDiscountRequest }, options?: CallOptions): Promise<Discount>

operatorDiscountsList

Discounts granted to workspaces (Overlane staff)

• Request: GET on /v1/operator/discounts

operatorDiscountsList(args?: Record<string, never>, options?: CallOptions): Promise<Record<string, unknown>>

operatorDiscountsRevoke

Take a workspace’s discount back (Overlane staff)

• Request: DELETE on /v1/operator/discounts

operatorDiscountsRevoke(args?: Record<string, never>, options?: CallOptions): Promise<Record<string, unknown>>

operatorInvitationsAdd

Invite an email address or a domain to create an account (Overlane staff)

• Request: PUT on /v1/operator/invitations

operatorInvitationsAdd(args: { body: AddInvitationRequest }, options?: CallOptions): Promise<SignInInvitation>

operatorInvitationsList

Who may create an account while Overlane is invite-only (Overlane staff)

• Request: GET on /v1/operator/invitations

operatorInvitationsList(args?: Record<string, never>, options?: CallOptions): Promise<SignInInvitationList>

operatorInvitationsRemove

Take an invitation back (Overlane staff)

• Request: DELETE on /v1/operator/invitations

operatorInvitationsRemove(args?: Record<string, never>, options?: CallOptions): Promise<Record<string, unknown>>

operatorRows

Rows of one table with personal fields masked (Overlane staff)

• Request: GET on /v1/operator/tables/{table}/rows

operatorRows(args: { table: string; query?: { limit?: string; tenant?: string } }, options?: CallOptions): Promise<OperatorRows>

operatorTables

Row counts and column masking for every table (Overlane staff)

• Request: GET on /v1/operator/tables

operatorTables(args?: Record<string, never>, options?: CallOptions): Promise<OperatorTableList>