Class Workspaces

Nylas Workspaces API

Workspaces group grants in a Nylas application by email domain. Grants can be auto-grouped by matching email domain or manually assigned and removed.

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch autoGroup create destroy find list manualAssign update

Constructors

constructor

new Workspaces(apiClient: APIClient): Workspaces
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Workspaces
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:195

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:209

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:169

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:224

`Protected`_getStream

_getStream(
__namedParameters: FindParams<void>,
): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:237

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:149

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:199

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:203

autoGroup

autoGroup(
__namedParameters?: AutoGroupWorkspacesParams & Overrides,
): Promise<NylasResponse<AutoGroupWorkspacesResponse>>
Start a background job that auto-groups grants into workspaces by email domain.
Parameters
- __namedParameters: AutoGroupWorkspacesParams & Overrides = {}
Returns Promise<NylasResponse<AutoGroupWorkspacesResponse>>
The auto-group job response.
- Defined in src/resources/workspaces.ts:164

create

create(
__namedParameters: CreateWorkspaceParams & Overrides,
): Promise<NylasResponse<Workspace>>
Create a workspace.
Parameters
- __namedParameters: CreateWorkspaceParams & Overrides
Returns Promise<NylasResponse<Workspace>>
The created workspace.
- Defined in src/resources/workspaces.ts:117

destroy

destroy(
__namedParameters: DestroyWorkspaceParams & Overrides,
): Promise<NylasBaseResponse>
Delete a workspace.
Parameters
- __namedParameters: DestroyWorkspaceParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response.
- Defined in src/resources/workspaces.ts:150

find

find(
__namedParameters: FindWorkspaceParams & Overrides,
): Promise<NylasResponse<Workspace>>
Return a workspace.
Parameters
- __namedParameters: FindWorkspaceParams & Overrides
Returns Promise<NylasResponse<Workspace>>
The workspace.
- Defined in src/resources/workspaces.ts:103

list

list(
__namedParameters?: ListWorkspacesParams & Overrides,
): AsyncListResponse<NylasListResponse<Workspace>>
Return all workspaces for the application.

The list endpoint is not paginated and returns every workspace as a flat array.
Parameters
- __namedParameters: ListWorkspacesParams & Overrides = {}
Returns AsyncListResponse<NylasListResponse<Workspace>>
The list of workspaces.
- Defined in src/resources/workspaces.ts:86

manualAssign

manualAssign(
__namedParameters: ManualAssignWorkspaceParams & Overrides,
): Promise<NylasResponse<ManualAssignWorkspaceResponse>>
Manually assign grants to and/or remove grants from a workspace.
Parameters
- __namedParameters: ManualAssignWorkspaceParams & Overrides
Returns Promise<NylasResponse<ManualAssignWorkspaceResponse>>
The assignment response.
- Defined in src/resources/workspaces.ts:181

update

update(
__namedParameters: UpdateWorkspaceParams & Overrides,
): Promise<NylasResponse<Workspace>>
Update a workspace.

Issued as PATCH; the workspace must be addressed by its UUID.
Parameters
- __namedParameters: UpdateWorkspaceParams & Overrides
Returns Promise<NylasResponse<Workspace>>
The updated workspace.
- Defined in src/resources/workspaces.ts:134