Class SubusersAPI

Handles interfacing with the Subusers API

Index

Constructors

Properties

Methods

Create Delete GetAllPermissions GetDetails List Update

Constructors

constructor

new SubusersAPI(core): SubusersAPI
Parameters
- core: WispAPICore
Returns SubusersAPI
- Defined in wisp_api/apis/subusers.ts:63

Properties

`Private` core

core: WispAPICore

Methods

Create

Create(email, permissions): Promise<Subuser>
Creates a new Subuser
Parameters
- email: string
  The email for the Subuser
- permissions: Permission[]
  The Permissions to grant to the Subuser
Returns Promise<Subuser>
- Defined in wisp_api/apis/subusers.ts:115

Delete

Delete(id): Promise<void>
Deletes the Subuser
Parameters
- id: string
  The ID of the Subuser
Returns Promise<void>
- Defined in wisp_api/apis/subusers.ts:156

GetAllPermissions

GetAllPermissions(): Promise<GetAllSubuserPermissionsResponse>
Get all permissions available to Subusers

Returns Promise<GetAllSubuserPermissionsResponse>
- Defined in wisp_api/apis/subusers.ts:99

GetDetails

GetDetails(id): Promise<Subuser>
Retrieves the details for the Subuser
Parameters
- id: string
  The ID of the Subuser
Returns Promise<Subuser>
- Defined in wisp_api/apis/subusers.ts:86

List

List(): Promise<GetSubusersResponse>
Lists all Subusers for the Server

Returns Promise<GetSubusersResponse>
- Defined in wisp_api/apis/subusers.ts:71

Update

Update(id, email, permissions): Promise<Subuser>
Updates the Subuser
Parameters
- id: string
  The ID of the Subuser
- email: string
  The new email of the Subuser
- permissions: Permission[]
  The new permissions for the Subuser
Returns Promise<Subuser>
- Defined in wisp_api/apis/subusers.ts:137

Generated using TypeDoc