ESPRMAdminGroup
Defined in: src/ESPRMAdminGroup.ts:11
Shell class for admin group management operations. Methods are added via prototype augmentation in methods/ESPRMAdminGroup/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminGroup():
ESPRMAdminGroup
Returns
Section titled “Returns”ESPRMAdminGroup
Methods
Section titled “Methods”createGroup()
Section titled “createGroup()”createGroup(
params):Promise<CreateAdminGroupResponse>
Defined in: src/methods/ESPRMAdminGroup/CreateGroup.ts:27
Creates a new admin node group.
Parameters
Section titled “Parameters”params
Section titled “params”The group creation parameters including the group name.
Returns
Section titled “Returns”Promise<CreateAdminGroupResponse>
The response containing the created group details.
deleteGroup()
Section titled “deleteGroup()”deleteGroup(
groupId):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminGroup/DeleteGroup.ts:26
Deletes an admin node group by its ID.
Parameters
Section titled “Parameters”groupId
Section titled “groupId”string
The ID of the group to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getGroups()
Section titled “getGroups()”getGroups(
params?):Promise<GetAdminGroupsResponse>
Defined in: src/methods/ESPRMAdminGroup/GetGroups.ts:22
Retrieves admin node groups with optional filtering parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the group list.
Returns
Section titled “Returns”Promise<GetAdminGroupsResponse>
The list of admin groups matching the specified criteria.
updateGroup()
Section titled “updateGroup()”updateGroup(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminGroup/UpdateGroup.ts:27
Updates an existing admin node group.
Parameters
Section titled “Parameters”params
Section titled “params”The group update parameters including the group ID.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.