Class SessionsApi

Hierarchy

BaseResourceAPI<Session>
- SessionsApi

Index

Methods

Methods

create

create(items: SessionCreate[]): Promise<SessionCreateResultItem[]>

- Defined in packages/stable/src/api/sessions/sessionsApi.ts:22
Create a session
```
client.sessions.create([{ clientId: 'client-id', clientSecret: 'client-secret' }])
```
Parameters
- items: SessionCreate[]
Returns Promise<SessionCreateResultItem[]>

list

list(query?: SessionFilterQuery): CursorAndAsyncIterator<Session>

- Defined in packages/stable/src/api/sessions/sessionsApi.ts:39
List sessions
```
client.sessions.list({ filter: { status: 'ACTIVE' } })
```
Parameters
- Optional query: SessionFilterQuery
Returns CursorAndAsyncIterator<Session>

retrieve

retrieve(ids: InternalId[]): Promise<Session[]>

- Defined in packages/stable/src/api/sessions/sessionsApi.ts:54
Retrieve sessions with given IDs
```
client.sessions.retrieve([{ id: 1 }])
```
Parameters
- ids: InternalId[]
Returns Promise<Session[]>

revoke

revoke(ids: InternalId[]): Promise<Session[]>

- Defined in packages/stable/src/api/sessions/sessionsApi.ts:65
Revoke access to a session
```
client.sessions.revoke([{ id: 1 }])
```
Parameters
- ids: InternalId[]
Returns Promise<Session[]>