hcloud-sdk 17.0.0 → 19.0.0

package/lib/service/idp/user/settings/twoFactor/totp/index.d.ts

@@ -1,32 +1,42 @@
-import Base from "../../../../../../Base";
+import Base, { MaybeRaw } from "../../../../../../Base";
 import { ActivatedTotp, DeactivatedTotp, UserTotp } from "../../../../../../interfaces/idp/user/Totp";
 export declare class IdpTotp extends Base {
     /**
      * Creates a new TOTP for the requesting User.
      * @returns A deactivated TOTP object containing all necessary data to create a QR code
      */
-    createTotp(): Promise<DeactivatedTotp>;
+    createTotp<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, DeactivatedTotp>>;
     /**
      * Activates a previously created TOTP.
      * @returns Object containing a list of recover codes in case of TOTP authenticator loss
      */
-    activateTotp(token: string): Promise<ActivatedTotp>;
+    activateTotp<R extends boolean = false>(token: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ActivatedTotp>>;
     /**
      * Verifies a TOTP.
      * @param userTotp TOTP to verify
      */
-    verifyTotp(userTotp: UserTotp): Promise<void>;
+    verifyTotp<R extends boolean = false>(userTotp: UserTotp, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Deactivates (deletes) a previously activated TOTP.
      * @param token TOTP to deactivate
      */
-    deactivateTotp(token: string): Promise<void>;
+    deactivateTotp<R extends boolean = false>(token: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Deactivates (deletes) a previously activated TOTP by using a recovery code.
      * @param email Email of the User
      * @param password Password
      * @param code Recovery code
      */
-    deactivateTotpByRecoverCode(email: string, password: string, code: string): Promise<void>;
+    deactivateTotpByRecoverCode<R extends boolean = false>(email: string, password: string, code: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/idp/user/settings/twoFactor/totp/index.js

@@ -8,48 +8,53 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdpTotp = void 0;
-const Base_1 = require("../../../../../../Base");
+const Base_1 = __importDefault(require("../../../../../../Base"));
 class IdpTotp extends Base_1.default {
     /**
      * Creates a new TOTP for the requesting User.
      * @returns A deactivated TOTP object containing all necessary data to create a QR code
      */
-    createTotp() {
+    createTotp(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/user/settings/security/2fa/totp`));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Activates a previously created TOTP.
      * @returns Object containing a list of recover codes in case of TOTP authenticator loss
      */
-    activateTotp(token) {
+    activateTotp(token, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.patch(this.getEndpoint(`/v1/user/settings/security/2fa/totp/activate`), { token });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Verifies a TOTP.
      * @param userTotp TOTP to verify
      */
-    verifyTotp(userTotp) {
+    verifyTotp(userTotp, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.patch(this.getEndpoint(`/v1/login/verify/totp`), {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/login/verify/totp`), {
                 userTotp,
             });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
      * Deactivates (deletes) a previously activated TOTP.
      * @param token TOTP to deactivate
      */
-    deactivateTotp(token) {
+    deactivateTotp(token, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/user/settings/security/2fa/totp`), { data: { token } });
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/user/settings/security/2fa/totp`), { data: { token } });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -58,11 +63,12 @@ class IdpTotp extends Base_1.default {
      * @param password Password
      * @param code Recovery code
      */
-    deactivateTotpByRecoverCode(email, password, code) {
+    deactivateTotpByRecoverCode(email, password, code, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/user/recover/totp`), {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/user/recover/totp`), {
                 data: { email, password, code },
             });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/mailer/index.d.ts

@@ -1,4 +1,4 @@
-import Base from "../../Base";
+import Base, { MaybeRaw } from "../../Base";
 import { Version } from "../../interfaces/global";
 import MailerInternal from "./internal";
 export default class Mailer extends Base {
@@ -8,6 +8,8 @@ export default class Mailer extends Base {
      * Requests the endpoint version
      * @returns Version object
      */
-    version(): Promise<Version>;
+    version<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Version>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/mailer/index.js

@@ -8,9 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Base_1 = require("../../Base");
-const internal_1 = require("./internal");
+const Base_1 = __importDefault(require("../../Base"));
+const internal_1 = __importDefault(require("./internal"));
 class Mailer extends Base_1.default {
     get internal() {
         if (this._internal === undefined) {
@@ -22,10 +25,10 @@ class Mailer extends Base_1.default {
      * Requests the endpoint version
      * @returns Version object
      */
-    version() {
+    version(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint("/v1/version"), {});
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/mailer/internal/index.d.ts

@@ -1,5 +1,5 @@
-import Base from "../../../Base";
-import { HtmlMail, MailjetMailDTO, MustacheMail, TemplateMail } from "../../../interfaces/mailer";
+import Base, { MaybeRaw } from "../../../Base";
+import { HtmlMail, MailjetMailDTO, MailjetResponse, MustacheMail, TemplateMail } from "../../../interfaces/mailer";
 export default class MailerInternal extends Base {
     /**
      * Sends a new mail based on a mailjet template.
@@ -7,7 +7,9 @@ export default class MailerInternal extends Base {
      * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
      * @param mail MailjetMailDTO
      */
-    sendMailMailjet(mail: MailjetMailDTO): Promise<void>;
+    sendMailMailjet<R extends boolean = false>(mail: MailjetMailDTO, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, MailjetResponse>>;
     /**
      * Sends a new mail based on a mustache html body.
      *
@@ -15,7 +17,9 @@ export default class MailerInternal extends Base {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailMustache(mail: MustacheMail): Promise<void>;
+    sendMailMustache<R extends boolean = false>(mail: MustacheMail, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Sends a new mail based on a html body.
      *
@@ -23,7 +27,9 @@ export default class MailerInternal extends Base {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailHtml(mail: HtmlMail): Promise<void>;
+    sendMailHtml<R extends boolean = false>(mail: HtmlMail, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Sends a new mail based on an existing template.
      *
@@ -31,6 +37,8 @@ export default class MailerInternal extends Base {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailTemplate(mail: TemplateMail): Promise<void>;
+    sendMailTemplate<R extends boolean = false>(mail: TemplateMail, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/mailer/internal/index.js

@@ -8,8 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Base_1 = require("../../../Base");
+const Base_1 = __importDefault(require("../../../Base"));
 class MailerInternal extends Base_1.default {
     /**
      * Sends a new mail based on a mailjet template.
@@ -17,10 +20,10 @@ class MailerInternal extends Base_1.default {
      * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
      * @param mail MailjetMailDTO
      */
-    sendMailMailjet(mail) {
+    sendMailMailjet(mail, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint("/v1/send/mailjet"), mail);
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -30,10 +33,10 @@ class MailerInternal extends Base_1.default {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailMustache(mail) {
+    sendMailMustache(mail, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint("/v1/send/mustache"), mail);
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -43,10 +46,10 @@ class MailerInternal extends Base_1.default {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailHtml(mail) {
+    sendMailHtml(mail, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint("/v1/send/html"), mail);
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -56,10 +59,10 @@ class MailerInternal extends Base_1.default {
      * @param mail TemplateMail
      * @deprecated in favor of sendMailMailjet
      */
-    sendMailTemplate(mail) {
+    sendMailTemplate(mail, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint("/v1/send/template"), mail);
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/mothership/index.d.ts

@@ -1,6 +1,6 @@
-import Base from "../../Base";
+import Base, { MaybeRaw } from "../../Base";
 import { PaginatedResponse, SearchParams, Version } from "../../interfaces/global";
-import { Agent, TargetAgent } from "../../interfaces/mothership";
+import { Agent, Stats, TargetAgent } from "../../interfaces/mothership";
 type RecurrentInfo = Pick<Agent, "uptime" | "cpuUtilization" | "memoryUsed" | "status">;
 type HelloInfo = RecurrentInfo & {
     nickname?: string;
@@ -13,7 +13,9 @@ export default class MothershipService extends Base {
      * Requests the endpoint version
      * @returns Version object
      */
-    version(): Promise<Version>;
+    version<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Version>>;
     /**
      * Say hello as an agent to the mothership
      *
@@ -22,10 +24,12 @@ export default class MothershipService extends Base {
      * @param info Information about the agent's uuid, hardware and nickname
      * @return an Agent object
      */
-    hello(uuid: string, uuidSignature: string, info: HelloInfo): Promise<{
+    hello<R extends boolean = false>(uuid: string, uuidSignature: string, info: HelloInfo, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, {
         agent: Agent;
         token: string;
-    }>;
+    }>>;
     /**
      * Say hello again as an agent to the mothership.
      *
@@ -36,7 +40,9 @@ export default class MothershipService extends Base {
      * @param info Information about the agent's system resources.
      * @return an Agent object
      */
-    helloAgain(info: RecurrentInfo): Promise<Agent>;
+    helloAgain<R extends boolean = false>(info: RecurrentInfo, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Agent>>;
     /**
      * Register an agent to the mothership.
      *
@@ -47,9 +53,11 @@ export default class MothershipService extends Base {
      * @param publicKey the public key of the agent that will be used for cryptography. The agent should remember its private key.
      * @return an object holding a secret encrypted with the public key. The agent must decrypt it using its private key in order to use the /hello endpoint.
      */
-    register(uuid: string, info: Pick<Agent, Exclude<keyof Agent, "uuid" | "createDate" | "modifyDate" | "_id" | "ip">>, publicKey: string | Buffer): Promise<{
+    register<R extends boolean = false>(uuid: string, info: Pick<Agent, Exclude<keyof Agent, "uuid" | "createDate" | "modifyDate" | "_id" | "ip">>, publicKey: string | Buffer, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, {
         secret: string;
-    }>;
+    }>>;
     /**
      * Connect to an organization.
      *
@@ -61,7 +69,9 @@ export default class MothershipService extends Base {
      * @param memberToken JWT assigned to a member of the organization
      * @param email Email of the user owner of the JWT
      */
-    connect(orgName: string, memberToken: string, email: string): Promise<void>;
+    connect<R extends boolean = false>(orgName: string, memberToken: string, email: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Disconnect from an organization.
      *
@@ -72,7 +82,9 @@ export default class MothershipService extends Base {
      * @param orgName Name of the organization
      * @param email Email of the user
      */
-    disconnect(orgName: string, email: string): Promise<void>;
+    disconnect<R extends boolean = false>(orgName: string, email: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Disconnect as a target.
      *
@@ -82,16 +94,26 @@ export default class MothershipService extends Base {
      *
      * @param email Email of the target
      */
-    disconnectTarget(email: string): Promise<void>;
+    disconnectTarget<R extends boolean = false>(email: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Search among the available targets for a given organization.
      *
      * @param orgName Name of the organization
      * @returns Object containing an array of retrieved agents and the total number of available found in the database (independent of limit and page)
      */
-    searchAvailableTargets({ orgName, filters, sorting, limit, page, }: SearchParams & {
+    searchAvailableTargets<R extends boolean = false>({ orgName, filters, sorting, limit, page }: SearchParams & {
         orgName: string;
-    }): Promise<PaginatedResponse<TargetAgent>>;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<TargetAgent>>>;
+    /**
+     * Retrieves usage statistics for a specific organization.
+     * @param orgName Name of the organization
+     * @returns Statistics information
+     */
+    getStats(orgName: string): Promise<Stats>;
     protected getEndpoint(endpoint: string): string;
 }
 export {};

package/lib/service/mothership/index.js

@@ -8,8 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Base_1 = require("../../Base");
+const Base_1 = __importDefault(require("../../Base"));
 const paginatedResponseHelper_1 = require("../../helper/paginatedResponseHelper");
 const searchFilter_1 = require("../../helper/searchFilter");
 class MothershipService extends Base_1.default {
@@ -17,10 +20,10 @@ class MothershipService extends Base_1.default {
      * Requests the endpoint version
      * @returns Version object
      */
-    version() {
+    version(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint("/v1/version"));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -31,14 +34,15 @@ class MothershipService extends Base_1.default {
      * @param info Information about the agent's uuid, hardware and nickname
      * @return an Agent object
      */
-    hello(uuid, uuidSignature, info) {
+    hello(uuid, uuidSignature, info, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint("/v1/hello"), info, {
                 headers: {
                     Authorization: `Bearer ${uuid}.${uuidSignature}`,
                 },
             });
-            return { agent: resp.data, token: resp.headers.authorization };
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw)
+                ? Object.assign(Object.assign({}, resp), { data: { agent: resp.data, token: resp.headers.authorization } }) : { agent: resp.data, token: resp.headers.authorization });
         });
     }
     /**
@@ -51,10 +55,10 @@ class MothershipService extends Base_1.default {
      * @param info Information about the agent's system resources.
      * @return an Agent object
      */
-    helloAgain(info) {
+    helloAgain(info, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.patch(this.getEndpoint("/v1/hello/again"), info);
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -67,13 +71,13 @@ class MothershipService extends Base_1.default {
      * @param publicKey the public key of the agent that will be used for cryptography. The agent should remember its private key.
      * @return an object holding a secret encrypted with the public key. The agent must decrypt it using its private key in order to use the /hello endpoint.
      */
-    register(uuid, info, publicKey) {
+    register(uuid, info, publicKey, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof publicKey !== "string") {
                 publicKey = publicKey.toString("hex");
             }
             const resp = yield this.axios.post(this.getEndpoint("/v1/register"), Object.assign({ uuid, publicKey }, info));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -87,9 +91,10 @@ class MothershipService extends Base_1.default {
      * @param memberToken JWT assigned to a member of the organization
      * @param email Email of the user owner of the JWT
      */
-    connect(orgName, memberToken, email) {
+    connect(orgName, memberToken, email, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/connect`), { memberToken, email });
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/connect`), { memberToken, email });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -102,9 +107,10 @@ class MothershipService extends Base_1.default {
      * @param orgName Name of the organization
      * @param email Email of the user
      */
-    disconnect(orgName, email) {
+    disconnect(orgName, email, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/connect/${email}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/connect/${email}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -116,9 +122,10 @@ class MothershipService extends Base_1.default {
      *
      * @param email Email of the target
      */
-    disconnectTarget(email) {
+    disconnectTarget(email, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/connect/${email}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/connect/${email}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -127,8 +134,8 @@ class MothershipService extends Base_1.default {
      * @param orgName Name of the organization
      * @returns Object containing an array of retrieved agents and the total number of available found in the database (independent of limit and page)
      */
-    searchAvailableTargets(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0, }) {
+    searchAvailableTargets(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }, raw) {
             const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => {
                 return new searchFilter_1.SearchFilterDTO(f);
             });
@@ -138,7 +145,18 @@ class MothershipService extends Base_1.default {
             }, {
                 params: { limit, page },
             });
-            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
+        });
+    }
+    /**
+     * Retrieves usage statistics for a specific organization.
+     * @param orgName Name of the organization
+     * @returns Statistics information
+     */
+    getStats(orgName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/stats`));
+            return resp.data;
         });
     }
     getEndpoint(endpoint) {

package/lib/service/nats/index.d.ts

@@ -45,5 +45,12 @@ declare class Nats extends Base {
     requestAndWaitForResponse(subject: string, type: NatsMessageType, objectType: NatsObjectType, object: unknown, options?: RequestOptions): Promise<Msg | undefined>;
     respond(msg: Msg | RawMsg, data: unknown): void;
     protected getEndpoint(endpoint: string): string;
+    /**
+     * Gracefully closes the NATS connection.
+     * * This method uses 'drain' to ensure that all outgoing messages are sent
+     * and all buffered incoming messages are processed by their respective subscribers before the connection is physically closed
+     * * @returns {Promise<void>} A promise that resolves when the connection is fully drained and closed
+     */
+    disconnect(): Promise<void>;
 }
 export default Nats;