jspteroapi
Version:
A pterodactyl v1 api using undici
78 lines (77 loc) • 3.44 kB
TypeScript
import { SubUser, SubUserAttributes, SubuserPermission } from 'client/interfaces/SubUser';
import { Client } from '../index';
export declare class subUserMethods {
private readonly client;
constructor(client: Client);
/**
* @param serverId - ID of the server to get (In the settings tab of server/in link)
* @returns SubUser[]
* @example
* ```ts
* const res = await client.getAllSubUsers('c2f5a3b6') // res = SubUser[]
* ```
* @example
* ```ts
* client.getAllSubUsers('c2f5a3b6').then((res) => console.log(res)) // res = SubUser[]
* ```
*/
getAllSubUsers: (serverId: string) => Promise<SubUser[]>;
/**
* @param serverId - ID of the server to get (In the settings tab of server/in link)
* @param subUserId - UUID of the subuser to get
* @returns SubUserAttributes
* @example
* ```ts
* const res = await client.getSubUserInfo('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4') // res = SubUserAttributes
* ```
* @example
* ```ts
* client.getSubUserInfo('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4').then((res) => console.log(res)) // res = SubUserAttributes
* ```
*/
getSubUserInfo: (serverId: string, subUserId: string) => Promise<SubUserAttributes>;
/**
* @param serverId - ID of the server to get (In the settings tab of server/in link)
* @param email - Email of the subuser
* @param permission - Permission of the subuser
* @returns SubUserAttributes
* @example
* ```ts
* const res = await client.createSubUser('c2f5a3b6', 'api@gmail.com', ['control.console']) // res = SubUserAttributes
* ```
* @example
* ```ts
* client.createSubUser('c2f5a3b6', 'api@gmail.com', ['control.console']).then((res) => console.log(res)) // res = SubUserAttributes
* ```
*/
createSubUser: (serverId: string, email: string, permissions: SubuserPermission[]) => Promise<SubUserAttributes>;
/**
* @param serverId - ID of the server to get (In the settings tab of server/in link)
* @param subUserId - UUID of the subuser to get
* @param permission - Permission of the subuser
* @returns SubUserAttributes
* @example
* ```ts
* const res = await client.updateSubUserPermissions('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4', ['control.console']) // res = SubUserAttributes
* ```
* @example
* ```ts
* client.updateSubUserPermissions('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4', ['control.console']).then((res) => console.log(res)) // res = SubUserAttributes
* ```
*/
updateSubUserPermissions: (serverId: string, subUserId: string, permissions: SubuserPermission[]) => Promise<SubUserAttributes>;
/**
* @param serverId - ID of the server to get (In the settings tab of server/in link)
* @param subUserId - UUID of the subuser to get
* @returns If successful returns Successfuly deleted SubUser!
* @example
* ```ts
* const res = await client.deleteSubUser('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4') // res = Successfuly deleted SubUser!
* ```
* @example
* ```ts
* client.deleteSubUser('c2f5a3b6', '60a7aec3-e17d-4aa9-abb3-56d944d204b4').then((res) => console.log(res)) // res = Successfuly deleted SubUser!
* ```
*/
deleteSubUser: (serverId: string, subUserId: string) => Promise<string>;
}