@pelican.ts/sdk 0.4.16-next.3 → 0.5.1

package/dist/index.d.mts

@@ -1,7 +1,17 @@
 import { AxiosInstance } from 'axios';
 import WebSocket from 'isomorphic-ws';
 
-type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+type FileObject = {
+    name: string;
+    mode: string;
+    mode_bits: string;
+    size: number;
+    is_file: boolean;
+    is_symlink: boolean;
+    mimetype: string;
+    created_at: string;
+    modified_at: string;
+};
 
 type GenericResponse<T, N extends string = string, M = undefined> = {
     object: N;
@@ -49,16 +59,74 @@ type ServerDatabase$1 = {
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
+type ServerBackup$1 = {
+    uuid: string;
+    is_successful: boolean;
+    is_locked: boolean;
+    name: string;
+    ignored_files: string[];
+    checksum: Nullable<string>;
+    bytes: number;
+    created_at: string;
+    completed_at: Nullable<string>;
+};
+
+type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+
+/**
+ * Server limits indicate how many resources can be used by the server
+ */
 type ServerLimits = {
+    /**
+     * Memory limit in megabytes, 0 = unlimited
+     * @remarks
+     * This is not a pterodactyl's MiB, it's a MB (multiple of 1000).
+     * That means to set 8GB RAM, you should set 8000 instead of 8192
+     */
     memory: number;
+    /**
+     * Swap limit in megabytes, 0 = disabled, -1 = unlimited
+     * @see memory
+     */
     swap: number;
+    /**
+     * Disk limit in megabytes, 0 = unlimited
+     * @see memory
+     */
     disk: number;
+    /**
+     * IO is an arbitrary value indicating IO importance relative to other servers
+     */
     io: number;
+    /**
+     * CPU limit in percentage, 0 = unlimited (1 core = 100%)
+     */
     cpu: number;
+    /**
+     * CPU pinning (Optional)
+     * @usage
+     * ```
+     * 1 or 1,2,4 or 1-4
+     * ```
+     * @remarks
+     * Can be useful to pin workloads to P-cores and avoid E-cores or HT/SMT cores
+     * @see https://superuser.com/questions/122536/what-is-hyper-threading-and-how-does-it-work
+     */
     threads: Nullable<number | string>;
+    /**
+     * If OOM killer should be disabled, opposite of {@link oom_killer}
+     * @deprecated use {@link oom_killer}
+     */
     oom_disabled: boolean;
+    /**
+     * If OOM killer should be enabled, opposite of {@link oom_disabled}
+     */
     oom_killer: boolean;
 };
+/**
+ * Feature limits indicate how many features can user enable by themselves. It doesn't include features assigned
+ * by admins
+ */
 type FeatureLimits = {
     databases: number;
     allocations: number;
@@ -79,40 +147,6 @@ type StartupMeta = {
     raw_startup_command: string;
 };
 
-type ServerBackup$1 = {
-    uuid: string;
-    is_successful: boolean;
-    is_locked: boolean;
-    name: string;
-    ignored_files: string[];
-    checksum: Nullable<string>;
-    bytes: number;
-    created_at: string;
-    completed_at: Nullable<string>;
-};
-
-type EggVariable = {
-    name: string;
-    description: string;
-    env_variable: string;
-    default_value: string;
-    server_value: string;
-    is_editable: boolean;
-    rules: string;
-};
-
-type FileObject = {
-    name: string;
-    mode: string;
-    mode_bits: string;
-    size: number;
-    is_file: boolean;
-    is_symlink: boolean;
-    mimetype: string;
-    created_at: string;
-    modified_at: string;
-};
-
 type Schedule = {
     id: number;
     name: string;
@@ -145,101 +179,14 @@ type ScheduleTask = {
     updated_at: Nullable<string>;
 };
 
-type SocketEventPayloadMap = {
-    [SOCKET_EVENT.AUTH_SUCCESS]: undefined;
-    [SOCKET_EVENT.STATUS]: PowerState;
-    [SOCKET_EVENT.CONSOLE_OUTPUT]: string;
-    [SOCKET_EVENT.STATS]: StatsWsJson;
-    [SOCKET_EVENT.DAEMON_ERROR]: undefined;
-    [SOCKET_EVENT.DAEMON_MESSAGE]: string;
-    [SOCKET_EVENT.INSTALL_OUTPUT]: string;
-    [SOCKET_EVENT.INSTALL_STARTED]: undefined;
-    [SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
-    [SOCKET_EVENT.TRANSFER_LOGS]: string;
-    [SOCKET_EVENT.TRANSFER_STATUS]: string;
-    [SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
-    [SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
-    [SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
-    [SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
-    [SOCKET_EVENT.JWT_ERROR]: string;
-};
-type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
-type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
-type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
-declare class ServerWebsocket {
-    private readonly r;
-    private readonly serverId;
-    private socket?;
-    private currentToken?;
-    private readonly bus;
-    private debugLogging;
-    private stripColors;
-    private detachMessageListener?;
-    constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
-    on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
-    deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
-    private emit;
-    connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
-    onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
-    onSocketError(handler: (event: ErrorEventLike) => void): void;
-    makeResumable(disconnectsToo: boolean): void;
-    private attachMessageListener;
-    private handleIncomingMessage;
-    private parseMessage;
-    private normalisePayload;
-    private dispatchMessage;
-    private refreshCredentials;
-    private authenticate;
-    disconnect(): void;
-    requestStats(): void;
-    requestLogs(): void;
-    private send;
-    getStats(): Promise<StatsWsJson>;
-    getLogs(): Promise<string[]>;
-    sendPoweraction(action: ServerSignalOption): void;
-    sendCommand(cmd: string): void;
-}
-
-/**
- * Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
- */
-declare enum SOCKET_EVENT {
-    AUTH_SUCCESS = "auth success",
-    DAEMON_MESSAGE = "daemon message",
-    DAEMON_ERROR = "daemon error",
-    INSTALL_OUTPUT = "install output",
-    INSTALL_STARTED = "install started",
-    INSTALL_COMPLETED = "install completed",
-    CONSOLE_OUTPUT = "console output",
-    STATUS = "status",
-    STATS = "stats",
-    TRANSFER_LOGS = "transfer logs",
-    TRANSFER_STATUS = "transfer status",
-    BACKUP_COMPLETED = "backup completed",
-    BACKUP_RESTORE_COMPLETED = "backup restore completed",
-    TOKEN_EXPIRING = "token expiring",
-    TOKEN_EXPIRED = "token expired",
-    JWT_ERROR = "jwt error"
-}
-type BackupCompletedJson = {
-    checksum: string;
-    checksum_type: "sha1";
-    file_size: number;
-    is_successful: boolean;
-    uuid: string;
-};
-type PowerState = "starting" | "stopping" | "running" | "offline";
-type StatsWsJson = {
-    memory_bytes: number;
-    memory_limit_bytes: number;
-    cpu_absolute: number;
-    network: {
-        rx_bytes: number;
-        tx_bytes: number;
-    };
-    state: PowerState;
-    uptime: number;
-    disk_bytes: number;
+type EggVariable = {
+    name: string;
+    description: string;
+    env_variable: string;
+    default_value: string;
+    server_value: string;
+    is_editable: boolean;
+    rules: string;
 };
 
 type ServerAllocation$1 = {
@@ -284,7 +231,7 @@ type Server$1 = {
     docker_image: string;
     egg_features: Nullable<string[]>;
     feature_limits: FeatureLimits;
-    status: Nullable<unknown>;
+    status: Nullable<ServerStats["current_state"]>;
     is_suspended: boolean;
     is_installing: boolean;
     is_transferring: boolean;
@@ -352,12 +299,109 @@ type Permission = {
     keys: Record<string, string>;
 };
 
+type SocketEventPayloadMap = {
+    [SOCKET_EVENT.AUTH_SUCCESS]: undefined;
+    [SOCKET_EVENT.STATUS]: PowerState;
+    [SOCKET_EVENT.CONSOLE_OUTPUT]: string;
+    [SOCKET_EVENT.STATS]: StatsWsJson;
+    [SOCKET_EVENT.DAEMON_ERROR]: undefined;
+    [SOCKET_EVENT.DAEMON_MESSAGE]: string;
+    [SOCKET_EVENT.INSTALL_OUTPUT]: string;
+    [SOCKET_EVENT.INSTALL_STARTED]: undefined;
+    [SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
+    [SOCKET_EVENT.TRANSFER_LOGS]: string;
+    [SOCKET_EVENT.TRANSFER_STATUS]: string;
+    [SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
+    [SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
+    [SOCKET_EVENT.JWT_ERROR]: string;
+};
+type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
+type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
+type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
+declare class ServerWebsocket {
+    private readonly r;
+    private readonly serverId;
+    private socket?;
+    private currentToken?;
+    private readonly bus;
+    private debugLogging;
+    private stripColors;
+    private detachMessageListener?;
+    constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
+    on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
+    deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
+    private emit;
+    connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
+    onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
+    onSocketError(handler: (event: ErrorEventLike) => void): void;
+    makeResumable(disconnectsToo: boolean): void;
+    private attachMessageListener;
+    private handleIncomingMessage;
+    private parseMessage;
+    private normalisePayload;
+    private dispatchMessage;
+    private refreshCredentials;
+    private authenticate;
+    disconnect(): void;
+    requestStats(): void;
+    requestLogs(): void;
+    private send;
+    getStats(): Promise<StatsWsJson>;
+    getLogs(): Promise<string[]>;
+    sendPoweraction(action: ServerSignalOption): void;
+    sendCommand(cmd: string): void;
+}
+
+/**
+ * Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
+ */
+declare enum SOCKET_EVENT {
+    AUTH_SUCCESS = "auth success",
+    DAEMON_MESSAGE = "daemon message",
+    DAEMON_ERROR = "daemon error",
+    INSTALL_OUTPUT = "install output",
+    INSTALL_STARTED = "install started",
+    INSTALL_COMPLETED = "install completed",
+    CONSOLE_OUTPUT = "console output",
+    STATUS = "status",
+    STATS = "stats",
+    TRANSFER_LOGS = "transfer logs",
+    TRANSFER_STATUS = "transfer status",
+    BACKUP_COMPLETED = "backup completed",
+    BACKUP_RESTORE_COMPLETED = "backup restore completed",
+    TOKEN_EXPIRING = "token expiring",
+    TOKEN_EXPIRED = "token expired",
+    JWT_ERROR = "jwt error"
+}
+type BackupCompletedJson = {
+    checksum: string;
+    checksum_type: "sha1";
+    file_size: number;
+    is_successful: boolean;
+    uuid: string;
+};
+type PowerState = "starting" | "stopping" | "running" | "offline";
+type StatsWsJson = {
+    memory_bytes: number;
+    memory_limit_bytes: number;
+    cpu_absolute: number;
+    network: {
+        rx_bytes: number;
+        tx_bytes: number;
+    };
+    state: PowerState;
+    uptime: number;
+    disk_bytes: number;
+};
+
 declare class Account$1 {
     private readonly r;
     constructor(requester: AxiosInstance);
     info: () => Promise<User>;
     updateEmail: (newEmail: string, password: string) => Promise<void>;
-    updatePassword: (newPassword: string) => Promise<void>;
+    updatePassword: (currentPassword: string, newPassword: string) => Promise<void>;
     apiKeys: {
         list: () => Promise<APIKey[]>;
         create: (description: string, allowed_ips?: string[]) => Promise<APIKey & {
@@ -567,6 +611,9 @@ declare class Account {
     readonly language: string;
     readonly image: string;
     readonly admin: boolean;
+    /**
+     * Has currently no significance
+     */
     readonly root_admin: boolean;
     private $has2faEnabled;
     get has2faEnabled(): boolean;
@@ -574,7 +621,7 @@ declare class Account {
     readonly updatedAt: Date;
     constructor(client: Client$1, user: User);
     updateEmail: (newEmail: string, password: string) => Promise<void>;
-    updatePassword: (newPassword: string) => Promise<void>;
+    updatePassword: (currentPassword: string, newPassword: string) => Promise<void>;
     listApiKeys: () => Promise<APIKey[]>;
     createApiKey: (description: string, allowed_ips?: string[]) => Promise<APIKey & {
         secret_token: string;
@@ -585,6 +632,19 @@ declare class Account {
     deleteSshKey: (fingerprint: string) => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server Allocation
+ *
+ * @class
+ * @example
+ * You can create allocation from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const allocData = await client.account.server(...).allocations.list()
+ * const alloc = new ServerAllocation(client, allocData[0])
+ * ```
+ */
 declare class ServerAllocation {
     private readonly client;
     readonly alias: Nullable<string>;
@@ -596,11 +656,34 @@ declare class ServerAllocation {
     get notes(): Nullable<string>;
     readonly port: number;
     constructor(client: ServerClient, alloc: ServerAllocation$1);
+    /**
+     * Set description for this allocation
+     * @param notes
+     */
     setNotes: (notes: string) => Promise<void>;
+    /**
+     * Make port primary
+     */
     makeDefault: () => Promise<void>;
+    /**
+     * Remove allocation (if user is allowed to manage allocations by themselves)
+     */
     unassign: () => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server Backup
+ *
+ * @class
+ * @example
+ * You can create account from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const backupData = await client.account.server(...).backups.info(...)
+ * const backup = new ServerBackup(client, backupData)
+ * ```
+ */
 declare class ServerBackup {
     private readonly client;
     readonly bytes: number;
@@ -621,6 +704,19 @@ declare class ServerBackup {
     restore: (truncate: boolean) => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server Database
+ *
+ * @class
+ * @example
+ * You can create account from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const dbData = await client.account.server(...).databases.info(...)
+ * const database = new ServerDatabase(client, dbData)
+ * ```
+ */
 declare class ServerDatabase {
     private readonly client;
     readonly allowConnectionsFrom: string;
@@ -633,10 +729,26 @@ declare class ServerDatabase {
     get password(): string | undefined;
     readonly username: string;
     constructor(client: ServerClient, database: ServerDatabase$1);
+    /**
+     * Reset password to a random one, password will be updated in this ServerDatabase instance
+     */
     rotatePassword: () => Promise<void>;
     delete: () => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server File/Folder
+ *
+ * @class
+ * @example
+ * You can create account from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const filesData = await client.account.server(...).files.list(FOLDER)
+ * const server = new ServerFile(client, filesData[0], FOLDER)
+ * ```
+ */
 declare class ServerFile {
     private readonly client;
     private readonly dir;
@@ -651,6 +763,12 @@ declare class ServerFile {
     readonly name: string;
     readonly size: number;
     constructor(client: ServerClient, file: FileObject, dir?: string);
+    /**
+     * Is this file an archive
+     *
+     * @remarks
+     * It uses extension check instead of mimetype as Pelican currently has some issue with mimetypes
+     */
     get isArchive(): boolean;
     /**
      * Return the contents of a file. To read binary file (non-editable) use {@link download} instead
@@ -667,10 +785,26 @@ declare class ServerFile {
     chmod: (mode: number) => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server Schedule
+ *
+ * @class
+ * @example
+ * You can create account from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const schedData = await client.account.server(...).schedules.list()
+ * const server = new ServerSchedule(client, schedData[0])
+ * ```
+ */
 declare class ServerSchedule {
     private readonly client;
     readonly createdAt: Date;
     private $cron;
+    /**
+     * CRON representation of schedule
+     */
     get cron(): {
         day_of_week: string;
         day_of_month: string;
@@ -679,14 +813,23 @@ declare class ServerSchedule {
     };
     readonly id: number;
     private $isActive;
+    /**
+     * Is this schedule enabled
+     */
     get isActive(): boolean;
     private $isProcessing;
+    /**
+     * Is this schedule currently running
+     */
     get isProcessing(): boolean;
     readonly lastRunAt: Nullable<Date>;
     private $name;
     get name(): string;
     readonly nextRunAt: Date;
     private $onlyWhenOnline;
+    /**
+     * Should schedule run only if server is online
+     */
     get onlyWhenOnline(): boolean;
     readonly tasks: ServerScheduleTask[];
     private $updatedAt;
@@ -709,18 +852,36 @@ declare class ServerScheduleTask {
     private readonly client;
     private readonly scheduleId;
     private $action;
+    /**
+     * Task action (command would likely need server to be online)
+     */
     get action(): "command" | "power" | "backup" | "delete_files";
     private $continueOnFailure;
+    /**
+     * Should we fail on error or continue with other tasks?
+     */
     get continueOnFailure(): boolean;
     readonly createdAt: Date;
     readonly id: number;
     private $isQueued;
+    /**
+     * Is this task queued right now?
+     */
     get isQueued(): boolean;
     private $payload;
+    /**
+     * Whatever task should do: command to execute, power action or list of files to backup
+     */
     get payload(): string;
     private $sequenceId;
+    /**
+     * Order of this task in defined schedule
+     */
     get sequenceId(): number;
     private $timeOffset;
+    /**
+     * Time offset in seconds relative to schedule start time
+     */
     get timeOffset(): number;
     private $updatedAt;
     get updatedAt(): Nullable<Date>;
@@ -729,6 +890,19 @@ declare class ServerScheduleTask {
     update: (opts: PartialBy<Pick<ScheduleTask, "action" | "payload" | "time_offset" | "sequence_id" | "continue_on_failure">, "payload" | "sequence_id" | "continue_on_failure">) => Promise<void>;
 }
 
+/**
+ * Instance of a Humane Pelican Server Subuser
+ *
+ * @class
+ * @example
+ * You can create account from a raw client
+ * ```ts
+ * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
+ * const client = new PelicanAPIClient(...)
+ * const userData = await client.account.server(...).users.info(...)
+ * const user = new ServerUser(client, userData)
+ * ```
+ */
 declare class ServerUser {
     private readonly client;
     readonly uuid: string;
@@ -737,6 +911,10 @@ declare class ServerUser {
     readonly language: string;
     readonly image: string;
     readonly admin: boolean;
+    /**
+     * Currently unused
+     * @deprecated
+     */
     readonly root_admin: boolean;
     readonly has2faEnabled: boolean;
     readonly createdAt: Date;
@@ -752,7 +930,7 @@ declare class ServerUser {
  *
  * @class
  * @example
- * You can create account from a raw client
+ * You can create server from a raw client
  * ```ts
  * import {PelicanAPIClient} from "@pelican.ts/sdk/api"
  * const client = new PelicanAPIClient(...)
@@ -779,7 +957,8 @@ declare class Server {
     get name(): string;
     /**
      * Node name used by this server
-     * @
+     * @remarks
+     * This is the name of the node used by this server, not the ID
      */
     readonly node: string;
     readonly isNodeUnderMaintenance: boolean;
@@ -791,6 +970,9 @@ declare class Server {
     private $description;
     get description(): string;
     readonly limits: ServerLimits;
+    /**
+     * It's a Startup command used to start the server
+     */
     readonly invocation: string;
     private $dockerImage;
     get dockerImage(): string;
@@ -801,11 +983,20 @@ declare class Server {
     readonly isInstalling: boolean;
     readonly isTransferring: boolean;
     readonly allocations: ServerAllocation[];
+    /**
+     * Egg variables
+     */
     readonly variables: EggVariable[];
+    /**
+     * Egg used by this server, available only if request had include=egg
+     */
     readonly egg?: {
         uuid: string;
         name: string;
     };
+    /**
+     * Server subusers, available only if request had include=subusers
+     */
     readonly subusers?: ServerUser[];
     constructor(client: ServerClient, server: Server$1);
     rename: (name: string) => Promise<void>;
@@ -824,23 +1015,45 @@ declare class Server {
         include?: "password"[];
         page?: number;
     }) => Promise<ServerDatabase[]>;
+    /**
+     * Create a database
+     * @param database - optional database name (leave blank for autogenerated)
+     * @param remote - allow connections from (ip, % or anything db-wise)
+     *
+     * @remarks
+     * I have no idea why API endpoint doesn't allow to select database host
+     */
     createDatabase: (database: string, remote: string) => Promise<ServerDatabase>;
     getSchedules: () => Promise<ServerSchedule[]>;
     createSchedule: (...opts: Parameters<ServerSchedules["create"]>) => Promise<ServerSchedule>;
     getBackups: (page?: number) => Promise<ServerBackup[]>;
     createBackup: (...args: Parameters<ServerBackups["create"]>) => Promise<ServerBackup>;
     getAllocations: () => Promise<ServerAllocation[]>;
+    /**
+     * Create new allocation (if user is allowed to manage allocations by themselves)
+     */
     createAllocation: () => Promise<ServerAllocation>;
     getFiles: (path?: string) => Promise<ServerFile[]>;
     createFolder: (...opts: Parameters<ServerFiles["createFolder"]>) => Promise<void>;
     uploadFile: (...opts: Parameters<ServerFiles["upload"]>) => Promise<void>;
     uploadFileGetUrl: (...opts: Parameters<ServerFiles["uploadGetUrl"]>) => Promise<string>;
+    /**
+     * Make wings agent download file or archive folder from specified URL instead of uploading directly
+     */
     pullFileFromRemote: (...opts: Parameters<ServerFiles["pullFromRemote"]>) => Promise<void>;
     compressMultipleFiles: (...opts: Parameters<ServerFiles["compress"]>) => Promise<FileObject>;
     renameMultipleFiles: (...opts: Parameters<ServerFiles["rename"]>) => Promise<void>;
     deleteMultipleFiles: (...opts: Parameters<ServerFiles["delete"]>) => Promise<void>;
     getUsers: () => Promise<ServerUser[]>;
+    /**
+     * Create a subuser
+     * @param email
+     * @param permissions
+     */
     createUser: (email: string, permissions: SubuserPermission[] | string[]) => Promise<ServerUser>;
+    /**
+     * Get server egg variables and startup commands
+     */
     getStartupInfo: () => Promise<CustomListResponse<StartupParams, StartupMeta>>;
     setStartupVariable: (key: string, value: string) => Promise<StartupParams>;
 }
@@ -872,17 +1085,17 @@ declare class Client {
      * List servers
      *
      * @param opts Filtering options (all optional)
+     *
+     * @remarks
+     * `type` — Server access type (Default: accessible)
+     *
+     * Variants:
+     * - `accessible` — your servers and servers you have access to as a subuser
+     * - `mine` — only your servers
+     * - `admin` — only servers you have admin access to (excluding yours)
+     * - `admin-all` — all servers you have admin access to
      */
     listServers: (opts?: {
-        /**
-         * Server access type (Default: accessible)
-         *
-         * Variants:
-         * - `accessible` — your servers and servers you have access to as a subuser
-         * - `mine` — only your servers
-         * - `admin` — only servers you have admin access to (excluding yours)
-         * - `admin-all` — all servers you have admin access to
-         */
         type?: "accessible" | "mine" | "admin" | "admin-all";
         page?: number;
         per_page?: number;