RequestAction

Defined in: transport/RequestAction.ts:10

Logical operation an SDK call wants to perform, independent of the underlying wire protocol.

Each transport translates a RequestAction into its native verb: HTTP methods (see actionToHttpMethod), WebSocket message types (see actionToWsEvent), or gRPC method names (see actionToGrpcMethod).

Enumeration Members

GET

GET: "GET"

Defined in: transport/RequestAction.ts:12

Fetch a single resource by id.

CREATE

CREATE: "CREATE"

Defined in: transport/RequestAction.ts:14

Create a new resource.

UPDATE

UPDATE: "UPDATE"

Defined in: transport/RequestAction.ts:16

Update an existing resource.

DELETE

DELETE: "DELETE"

Defined in: transport/RequestAction.ts:18

Delete an existing resource.

LIST

LIST: "LIST"

Defined in: transport/RequestAction.ts:21

List resources of a given type (paginated).

QUERY

QUERY: "QUERY"

Defined in: transport/RequestAction.ts:23

Run a search/filter query.

SUBSCRIBE: "SUBSCRIBE"

Defined in: transport/RequestAction.ts:25

Subscribe to a server-pushed event stream.

UNSUBSCRIBE

UNSUBSCRIBE: "UNSUBSCRIBE"

Defined in: transport/RequestAction.ts:27

Unsubscribe from a previously opened stream.

SEND

SEND: "SEND"

Defined in: transport/RequestAction.ts:29

Send a one-shot message (e.g. RPC-style call).

BATCH_CREATE

BATCH_CREATE: "BATCH_CREATE"

Defined in: transport/RequestAction.ts:32

Bulk create — atomically insert many resources.

BATCH_UPDATE

BATCH_UPDATE: "BATCH_UPDATE"

Defined in: transport/RequestAction.ts:34

Bulk update — atomically modify many resources.

BATCH_DELETE

BATCH_DELETE: "BATCH_DELETE"

Defined in: transport/RequestAction.ts:36

Bulk delete — atomically remove many resources.

LOGIN: "LOGIN"

Defined in: transport/RequestAction.ts:39

Authenticate with credentials and start a session.

REGISTER

REGISTER: "REGISTER"

Defined in: transport/RequestAction.ts:41

Create a new account.

LOGOUT

LOGOUT: "LOGOUT"

Defined in: transport/RequestAction.ts:43

End the current session.

REFRESH

REFRESH: "REFRESH"

Defined in: transport/RequestAction.ts:45

Exchange a refresh token for a new access token.