feat: add RenameServer

Author: Shinigami92

README.md

@@ -96,4 +96,14 @@ client.v1
   .then((response) => {
     console.log("ClaimServer Response:", response);
   });
+
+client.v1
+  .RenameServer({
+    data: {
+      serverName: "Shinigami-PC localhost",
+    },
+  })
+  .then(() => {
+    // response will be an empty string if valid
+  });
 ```

src/index.ts

@@ -35,4 +35,7 @@ export type {
   VerifyAuthenticationTokenRequest,
   VerifyAuthenticationTokenResponse,
   WrongPasswordErrorResponse,
+  RenameServerRequest,
+  RenameServerResponse,
+  ServerClaimedErrorResponse,
 } from "./v1/index.js";

src/v1/ClaimServer.ts

@@ -5,11 +5,11 @@ export type ClaimServerRequest = ApiRequest<
   "ClaimServer",
   {
     /**
-     * 	New name of the Dedicated Server.
+     * New name of the Dedicated Server.
      */
     serverName: string;
     /**
-     * 	Admin Password to set on the Dedicated Server, in plaintext.
+     * Admin Password to set on the Dedicated Server, in plaintext.
      */
     adminPassword: string;
   }

src/v1/RenameServer.ts

@@ -0,0 +1,21 @@
+import type { ApiRequest } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type RenameServerRequest = ApiRequest<
+  "RenameServer",
+  {
+    /**
+     * New name of the Dedicated Server.
+     */
+    serverName: string;
+  }
+>;
+
+export type RenameServerResponse = string;
+
+export const buildRenameServer = buildApiRequest<
+  RenameServerRequest,
+  RenameServerResponse
+>("v1", {
+  function: "RenameServer",
+});

src/v1/error.ts

@@ -36,3 +36,7 @@ export interface WrongPasswordErrorResponse extends ErrorResponse {
 export interface ServerClaimedErrorResponse extends ErrorResponse {
   errorCode: "server_claimed";
 }
+
+export interface ServerNotClaimedErrorResponse extends ErrorResponse {
+  errorCode: "server_not_claimed";
+}

src/v1/index.ts

@@ -7,6 +7,7 @@ import { buildHealthCheck } from "./HealthCheck.js";
 import { buildPasswordlessLogin } from "./PasswordlessLogin.js";
 import { buildPasswordLogin } from "./PasswordLogin.js";
 import { buildQueryServerState } from "./QueryServerState.js";
+import { buildRenameServer } from "./RenameServer.js";
 import { buildVerifyAuthenticationToken } from "./VerifyAuthenticationToken.js";
 
 export function buildV1(options: InternalClientOptions) {
@@ -65,6 +66,14 @@ export function buildV1(options: InternalClientOptions) {
      * The client should drop InitialAdmin privileges after that and use returned AuthenticationToken instead, and update it's cached server game state by calling QueryServerState.
      */
     ClaimServer: buildClaimServer(options),
+    /**
+     * Renames the Dedicated Server once it has been claimed.
+     *
+     * Requires Admin privileges.
+     *
+     * Function does not return any data on success.
+     */
+    RenameServer: buildRenameServer(options),
   };
 }
 
@@ -78,4 +87,5 @@ export type * from "./HealthCheck.js";
 export type * from "./PasswordlessLogin.js";
 export type * from "./PasswordLogin.js";
 export type * from "./QueryServerState.js";
+export type * from "./RenameServer.js";
 export type * from "./VerifyAuthenticationToken.js";

test.js

@@ -77,3 +77,13 @@ client.v1
   .then((response) => {
     console.log("ClaimServer Response:", response);
   });
+
+client.v1
+  .RenameServer({
+    data: {
+      serverName: "Shinigami-PC localhost",
+    },
+  })
+  .then((response) => {
+    console.log("RenameServer Response:", typeof response);
+  });