Class OrganizationsClient

Organization CRUD, membership management, and org-scoped fan-out reads.

Index

Constructors

Methods

adopt create delete get getGatewaySummary listApplications listDevices listOrphaned listUsers removeUser update updateUserRole

Constructors

constructor

new OrganizationsClient(call: Caller): OrganizationsClient
Parameters
- call: Caller
Returns OrganizationsClient
- Defined in src/resources/organizations.ts:38

Methods

adopt

adopt(
req: AdoptOrganizationRequest,
opts?: RequestOptions,
): Promise<OrganizationData>
Adopt an orphaned organization.
Parameters
- req: AdoptOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
- Defined in src/resources/organizations.ts:87

create

create(
req: CreateOrganizationRequest,
opts?: RequestOptions,
): Promise<OrganizationData>
Create an organization.
Parameters
- req: CreateOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
Throws
ValidationError if the request body is rejected.
- Defined in src/resources/organizations.ts:44

delete

delete(organizationId: string, opts?: RequestOptions): Promise<void>
Delete an organization.
Parameters
- organizationId: string
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the organization does not exist.
- Defined in src/resources/organizations.ts:79

get

get(organizationId: string, opts?: RequestOptions): Promise<OrganizationData>
Fetch an organization by id.
Parameters
- organizationId: string
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
Throws
NotFoundError if the organization does not exist.
- Defined in src/resources/organizations.ts:56

getGatewaySummary

getGatewaySummary(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<OrganizationGatewaySummaryResponse>
Org-wide gateway roll-up: every gateway the org's applications route through, deduped across apps, with real WS-heartbeat health and the count of apps routed through each. Powers the dashboard gateway card. Managed gateways surface only through this app-ownership-derived projection, never as browsable devices.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<OrganizationGatewaySummaryResponse>
{ gateways, counts: { healthy, degraded } }. An org with no published apps returns empty gateways and zeroed counts.
- Defined in src/resources/organizations.ts:202

listApplications

listApplications(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<ApplicationData[]>
List every application in the organization.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<ApplicationData[]>
- Defined in src/resources/organizations.ts:184

listDevices

listDevices(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<DeviceData[]>
List every device in the organization.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<DeviceData[]>
- Defined in src/resources/organizations.ts:164

listOrphaned

listOrphaned(opts?: RequestOptions): Promise<OrganizationData[]>
List orphaned organizations available to adopt.
Parameters
- Optionalopts: RequestOptions
Returns Promise<OrganizationData[]>
- Defined in src/resources/organizations.ts:96

listUsers

listUsers(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<OrganizationUserData[]>
List the organization's member users. Each entry carries the user's role in this organization (OWNER/EDITOR/READ_ONLY), read from the org's USER membership edges.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<OrganizationUserData[]>
- Defined in src/resources/organizations.ts:111

removeUser

removeUser(
params: { organizationId: string; userEmail: string },
opts?: RequestOptions,
): Promise<void>
Remove a user from the organization. Adding members is invites-only (see invites.create) — there is no add-member route by design.
Parameters
- params: { organizationId: string; userEmail: string }
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the organization or member does not exist.
- Defined in src/resources/organizations.ts:127

update

update(
req: UpdateOrganizationRequest,
opts?: RequestOptions,
): Promise<OrganizationData>
Update an organization; returns the updated row.
Parameters
- req: UpdateOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
Throws
NotFoundError if the organization does not exist.
- Defined in src/resources/organizations.ts:67

updateUserRole

updateUserRole(
    params: {
        organizationId: string;
        role: OrganizationUserRole;
        userEmail: string;
    },
    opts?: RequestOptions,
): Promise<Omit<UpdateOrganizationUserRoleResponse, "message">>
Change a member's role within the organization; returns the updated membership (userEmail, organizationId, role).
Parameters
- params: { organizationId: string; role: OrganizationUserRole; userEmail: string }
- Optionalopts: RequestOptions
Returns Promise<Omit<UpdateOrganizationUserRoleResponse, "message">>
Throws
NotFoundError if the organization or member does not exist.
- Defined in src/resources/organizations.ts:146

Class OrganizationsClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OrganizationsClient

Methods

adopt

Parameters

Returns Promise<OrganizationData>

create

Parameters

Returns Promise<OrganizationData>

Throws

delete

Parameters

Returns Promise<void>

Throws

get

Parameters

Returns Promise<OrganizationData>

Throws

getGatewaySummary

Parameters

Returns Promise<OrganizationGatewaySummaryResponse>

listApplications

Parameters

Returns Promise<ApplicationData[]>

listDevices

Parameters

Returns Promise<DeviceData[]>

listOrphaned

Parameters

Returns Promise<OrganizationData[]>

listUsers

Parameters

Returns Promise<OrganizationUserData[]>

removeUser

Parameters

Returns Promise<void>

Throws

update

Parameters

Returns Promise<OrganizationData>

Throws

updateUserRole

Parameters

Returns Promise<Omit<UpdateOrganizationUserRoleResponse, "message">>

Throws

Settings

On This Page