@osaas/client-services 0.4.0 → 0.5.0

package/lib/generated/bluewave-labs-checkmate.d.ts

@@ -0,0 +1,308 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Say hello */
+        get: {
+            responses: {
+                /** The magical words! */
+                200: {
+                    schema: string;
+                };
+            };
+        };
+    };
+    '/checkmateinstance': {
+        /** List all running checkmate instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the checkmate instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new checkmate instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the checkmate instance */
+                        name: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the checkmate instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                403: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                409: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/checkmateinstance/{id}': {
+        /** Obtain status and resource URLs for an checkmate instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the checkmate instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the checkmate instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Stop and remove an checkmate instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the checkmate instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of checkmate instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the checkmate instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the checkmate instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the checkmate instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/ports/{id}': {
+        /** Return the exposed extra ports for checkmate instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the checkmate instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        externalIp: string;
+                        externalPort: number;
+                        internalPort: number;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface definitions {
+}
+export interface operations {
+}
+export interface external {
+}
+export type BluewaveLabsCheckmate = paths['/checkmateinstance/{id}']['get']['responses']['200']['schema'];
+export type BluewaveLabsCheckmateConfig = paths['/checkmateinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * Create a new Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {BluewaveLabsCheckmateConfig}} body - Service instance configuration
+ * @returns {BluewaveLabsCheckmate} - Service instance
+ * @example
+ * import { Context, createBluewaveLabsCheckmateInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createBluewaveLabsCheckmateInstance(ctx, { name: 'myinstance' });
+ * console.log(instance.url);
+ */
+export declare function createBluewaveLabsCheckmateInstance(ctx: Context, body: BluewaveLabsCheckmateConfig): Promise<BluewaveLabsCheckmate>;
+/**
+ * Remove a Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the monitor to be removed
+ */
+export declare function removeBluewaveLabsCheckmateInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the monitor to be retrieved
+ * @returns {BluewaveLabsCheckmate} - Service instance
+ */
+export declare function getBluewaveLabsCheckmateInstance(ctx: Context, name: string): Promise<BluewaveLabsCheckmate>;
+//# sourceMappingURL=bluewave-labs-checkmate.d.ts.map

package/lib/generated/bluewave-labs-checkmate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bluewave-labs-checkmate.d.ts","sourceRoot":"","sources":["../../src/generated/bluewave-labs-checkmate.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE;QACH,gBAAgB;QAChB,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,yBAAyB;gBACzB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,oBAAoB,EAAE;QACpB,2CAA2C;QAC3C,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,kDAAkD;wBAClD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;qBACH,EAAE,CAAC;iBACL,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,sCAAsC;QACtC,IAAI,EAAE;YACJ,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,CAAC,EAAE;wBACL,kDAAkD;wBAClD,IAAI,EAAE,MAAM,CAAC;qBACd,CAAC;iBACH,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,kDAAkD;wBAClD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;qBACH,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,yBAAyB,EAAE;QACzB,gEAAgE;QAChE,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,qCAAqC;oBACrC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,kDAAkD;wBAClD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;qBACH,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,4CAA4C;QAC5C,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,qCAAqC;oBACrC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,cAAc,EAAE;QACd,0CAA0C;QAC1C,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,qCAAqC;oBACrC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,qBAAqB;wBACrB,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;qBACnE,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,YAAY,EAAE;QACZ,yDAAyD;QACzD,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,UAAU,CAAC,EAAE,OAAO,CAAC;oBACrB,YAAY,CAAC,EAAE,MAAM,CAAC;iBACvB,CAAC;gBACF,IAAI,EAAE;oBACJ,qCAAqC;oBACrC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,aAAa,EAAE;QACb,4DAA4D;QAC5D,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,qCAAqC;oBACrC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,UAAU,EAAE,MAAM,CAAC;wBACnB,YAAY,EAAE,MAAM,CAAC;wBACrB,YAAY,EAAE,MAAM,CAAC;qBACtB,EAAE,CAAC;iBACL,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,WAAW;CAAG;AAE/B,MAAM,WAAW,UAAU;CAAG;AAE9B,MAAM,WAAW,QAAQ;CAAG;AAE5B,MAAM,MAAM,qBAAqB,GAC/B,KAAK,CAAC,yBAAyB,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;AAExE,MAAM,MAAM,2BAA2B,GACrC,KAAK,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,OAAO,EACL,OAAO,EAKR,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mCAAmC,CACvD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,qBAAqB,CAAC,CAYhC;AAED;;;;;;GAMG;AACH,wBAAsB,mCAAmC,CACvD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;;;;;;GAOG;AACH,wBAAsB,gCAAgC,CACpD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC,CAUhC"}

package/lib/generated/bluewave-labs-checkmate.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBluewaveLabsCheckmateInstance = exports.removeBluewaveLabsCheckmateInstance = exports.createBluewaveLabsCheckmateInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * Create a new Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {BluewaveLabsCheckmateConfig}} body - Service instance configuration
+ * @returns {BluewaveLabsCheckmate} - Service instance
+ * @example
+ * import { Context, createBluewaveLabsCheckmateInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createBluewaveLabsCheckmateInstance(ctx, { name: 'myinstance' });
+ * console.log(instance.url);
+ */
+async function createBluewaveLabsCheckmateInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('bluewave-labs-checkmate');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'bluewave-labs-checkmate', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('bluewave-labs-checkmate', instance.name, ctx);
+    return instance;
+}
+exports.createBluewaveLabsCheckmateInstance = createBluewaveLabsCheckmateInstance;
+/**
+ * Remove a Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the monitor to be removed
+ */
+async function removeBluewaveLabsCheckmateInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('bluewave-labs-checkmate');
+    await (0, client_core_1.removeInstance)(ctx, 'bluewave-labs-checkmate', name, serviceAccessToken);
+}
+exports.removeBluewaveLabsCheckmateInstance = removeBluewaveLabsCheckmateInstance;
+/**
+ * Get a Checkmate instance
+ *
+ * @description Monitor servers effortlessly with Checkmate—a powerful open-source tool for tracking server and website performance. Enjoy real-time alerts, in-depth insights, and manage over 1000 servers seamlessly!
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the monitor to be retrieved
+ * @returns {BluewaveLabsCheckmate} - Service instance
+ */
+async function getBluewaveLabsCheckmateInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('bluewave-labs-checkmate');
+    return await (0, client_core_1.getInstance)(ctx, 'bluewave-labs-checkmate', name, serviceAccessToken);
+}
+exports.getBluewaveLabsCheckmateInstance = getBluewaveLabsCheckmateInstance;
+//# sourceMappingURL=bluewave-labs-checkmate.js.map

package/lib/generated/bluewave-labs-checkmate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bluewave-labs-checkmate.js","sourceRoot":"","sources":["../../src/generated/bluewave-labs-checkmate.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAqRH,oDAM4B;AAE5B;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,mCAAmC,CACvD,GAAY,EACZ,IAAiC;IAEjC,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,yBAAyB,CAC1B,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,yBAAyB,EACzB,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,yBAAyB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC1E,OAAO,QAAQ,CAAC;AAClB,CAAC;AAfD,kFAeC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,mCAAmC,CACvD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,yBAAyB,CAC1B,CAAC;IACF,MAAM,IAAA,4BAAc,EAClB,GAAG,EACH,yBAAyB,EACzB,IAAI,EACJ,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAbD,kFAaC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,gCAAgC,CACpD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,yBAAyB,CAC1B,CAAC;IACF,OAAO,MAAM,IAAA,yBAAW,EACtB,GAAG,EACH,yBAAyB,EACzB,IAAI,EACJ,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAbD,4EAaC"}

package/lib/generated/dicedb-dice.d.ts

@@ -0,0 +1,308 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Say hello */
+        get: {
+            responses: {
+                /** The magical words! */
+                200: {
+                    schema: string;
+                };
+            };
+        };
+    };
+    '/diceinstance': {
+        /** List all running dice instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the dice instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new dice instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the dice instance */
+                        name: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the dice instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                403: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                409: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/diceinstance/{id}': {
+        /** Obtain status and resource URLs for an dice instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the dice instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the dice instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Stop and remove an dice instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the dice instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of dice instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the dice instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the dice instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the dice instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/ports/{id}': {
+        /** Return the exposed extra ports for dice instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the dice instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        externalIp: string;
+                        externalPort: number;
+                        internalPort: number;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface definitions {
+}
+export interface operations {
+}
+export interface external {
+}
+export type DicedbDice = paths['/diceinstance/{id}']['get']['responses']['200']['schema'];
+export type DicedbDiceConfig = paths['/diceinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * Create a new Dice DB instance
+ *
+ * @description Experience real-time data management with DiceDB, the open-source, redis-compliant, reactive cache. Its scalable and multithreaded architecture enhances modern hardware utilization, perfect for cutting-edge applications.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {DicedbDiceConfig}} body - Service instance configuration
+ * @returns {DicedbDice} - Service instance
+ * @example
+ * import { Context, createDicedbDiceInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createDicedbDiceInstance(ctx, { name: 'myinstance' });
+ * console.log(instance.url);
+ */
+export declare function createDicedbDiceInstance(ctx: Context, body: DicedbDiceConfig): Promise<DicedbDice>;
+/**
+ * Remove a Dice DB instance
+ *
+ * @description Experience real-time data management with DiceDB, the open-source, redis-compliant, reactive cache. Its scalable and multithreaded architecture enhances modern hardware utilization, perfect for cutting-edge applications.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the dice to be removed
+ */
+export declare function removeDicedbDiceInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a Dice DB instance
+ *
+ * @description Experience real-time data management with DiceDB, the open-source, redis-compliant, reactive cache. Its scalable and multithreaded architecture enhances modern hardware utilization, perfect for cutting-edge applications.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the dice to be retrieved
+ * @returns {DicedbDice} - Service instance
+ */
+export declare function getDicedbDiceInstance(ctx: Context, name: string): Promise<DicedbDice>;
+//# sourceMappingURL=dicedb-dice.d.ts.map