@osaas/client-services 0.2.0

package/lib/generated/ateliere-live-public-orchestration-gui.d.ts

@@ -0,0 +1,309 @@
+/**
+ * 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;
+                };
+            };
+        };
+    };
+    '/orchestration-guiinstance': {
+        /** List all running orchestration-gui instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the orchestration-gui 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;
+                            };
+                        };
+                        MongoDbUri: string;
+                        ApiUrl: string;
+                        ApiCredentials: string;
+                        NextAuthSecret?: string;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new orchestration-gui instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the orchestration-gui instance */
+                        name: string;
+                        MongoDbUri: string;
+                        ApiUrl: string;
+                        ApiCredentials: string;
+                        NextAuthSecret?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the orchestration-gui 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;
+                            };
+                        };
+                        MongoDbUri: string;
+                        ApiUrl: string;
+                        ApiCredentials: string;
+                        NextAuthSecret?: 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;
+                    };
+                };
+            };
+        };
+    };
+    '/orchestration-guiinstance/{id}': {
+        /** Obtain status and resource URLs for an orchestration-gui instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the orchestration-gui instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the orchestration-gui 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;
+                            };
+                        };
+                        MongoDbUri: string;
+                        ApiUrl: string;
+                        ApiCredentials: string;
+                        NextAuthSecret?: 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 orchestration-gui instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the orchestration-gui 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 orchestration-gui instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the orchestration-gui 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 orchestration-gui instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the orchestration-gui 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 orchestration-gui instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the orchestration-gui 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 AteliereLivePublicOrchestrationGui = paths['/orchestration-guiinstance/{id}']['get']['responses']['200']['schema'];
+export type AteliereLivePublicOrchestrationGuiConfig = paths['/orchestration-guiinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * Ateliere Live GUI
+ *
+ * Ateliere Live GUI is a cutting-edge tool for streamlined development. With Node.js 18.x compatibility and easy Ubuntu installation, it ensures a seamless workflow. Explore the external documentation for enhanced productivity. Get your hands on this game-changer today!
+ *
+ * Create a new orchestration-gui
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {AteliereLivePublicOrchestrationGuiConfig}} body - Service instance configuration
+ * @returns {AteliereLivePublicOrchestrationGui} - Service instance
+ * @example
+ * import { Context, createAteliereLivePublicOrchestrationGuiInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createAteliereLivePublicOrchestrationGuiInstance(ctx, { name: 'my-instance' });
+ * console.log(instance.url);
+ */
+export declare function createAteliereLivePublicOrchestrationGuiInstance(ctx: Context, body: AteliereLivePublicOrchestrationGuiConfig): Promise<AteliereLivePublicOrchestrationGui>;
+//# sourceMappingURL=ateliere-live-public-orchestration-gui.d.ts.map

package/lib/generated/ateliere-live-public-orchestration-gui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ateliere-live-public-orchestration-gui.d.ts","sourceRoot":"","sources":["../../src/generated/ateliere-live-public-orchestration-gui.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,4BAA4B,EAAE;QAC5B,mDAAmD;QACnD,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,0DAA0D;wBAC1D,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;wBACF,UAAU,EAAE,MAAM,CAAC;wBACnB,MAAM,EAAE,MAAM,CAAC;wBACf,cAAc,EAAE,MAAM,CAAC;wBACvB,cAAc,CAAC,EAAE,MAAM,CAAC;qBACzB,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,8CAA8C;QAC9C,IAAI,EAAE;YACJ,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,CAAC,EAAE;wBACL,0DAA0D;wBAC1D,IAAI,EAAE,MAAM,CAAC;wBACb,UAAU,EAAE,MAAM,CAAC;wBACnB,MAAM,EAAE,MAAM,CAAC;wBACf,cAAc,EAAE,MAAM,CAAC;wBACvB,cAAc,CAAC,EAAE,MAAM,CAAC;qBACzB,CAAC;iBACH,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,0DAA0D;wBAC1D,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;wBACF,UAAU,EAAE,MAAM,CAAC;wBACnB,MAAM,EAAE,MAAM,CAAC;wBACf,cAAc,EAAE,MAAM,CAAC;wBACvB,cAAc,CAAC,EAAE,MAAM,CAAC;qBACzB,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,iCAAiC,EAAE;QACjC,wEAAwE;QACxE,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,6CAA6C;oBAC7C,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,0DAA0D;wBAC1D,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;wBACF,UAAU,EAAE,MAAM,CAAC;wBACnB,MAAM,EAAE,MAAM,CAAC;wBACf,cAAc,EAAE,MAAM,CAAC;wBACvB,cAAc,CAAC,EAAE,MAAM,CAAC;qBACzB,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,oDAAoD;QACpD,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,6CAA6C;oBAC7C,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,kDAAkD;QAClD,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,6CAA6C;oBAC7C,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,iEAAiE;QACjE,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,6CAA6C;oBAC7C,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,oEAAoE;QACpE,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,6CAA6C;oBAC7C,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,kCAAkC,GAC5C,KAAK,CAAC,iCAAiC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEhF,MAAM,MAAM,wCAAwC,GAClD,KAAK,CAAC,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5E,OAAO,EAAE,OAAO,EAAkB,MAAM,oBAAoB,CAAC;AAE7D;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,gDAAgD,CACpE,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,wCAAwC,GAC7C,OAAO,CAAC,kCAAkC,CAAC,CAU7C"}

package/lib/generated/ateliere-live-public-orchestration-gui.js

@@ -0,0 +1,30 @@
+"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.createAteliereLivePublicOrchestrationGuiInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * Ateliere Live GUI
+ *
+ * Ateliere Live GUI is a cutting-edge tool for streamlined development. With Node.js 18.x compatibility and easy Ubuntu installation, it ensures a seamless workflow. Explore the external documentation for enhanced productivity. Get your hands on this game-changer today!
+ *
+ * Create a new orchestration-gui
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {AteliereLivePublicOrchestrationGuiConfig}} body - Service instance configuration
+ * @returns {AteliereLivePublicOrchestrationGui} - Service instance
+ * @example
+ * import { Context, createAteliereLivePublicOrchestrationGuiInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createAteliereLivePublicOrchestrationGuiInstance(ctx, { name: 'my-instance' });
+ * console.log(instance.url);
+ */
+async function createAteliereLivePublicOrchestrationGuiInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('ateliere-live-public-orchestration-gui');
+    return await (0, client_core_1.createInstance)(ctx, 'ateliere-live-public-orchestration-gui', serviceAccessToken, body);
+}
+exports.createAteliereLivePublicOrchestrationGuiInstance = createAteliereLivePublicOrchestrationGuiInstance;
+//# sourceMappingURL=ateliere-live-public-orchestration-gui.js.map

package/lib/generated/ateliere-live-public-orchestration-gui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ateliere-live-public-orchestration-gui.js","sourceRoot":"","sources":["../../src/generated/ateliere-live-public-orchestration-gui.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAqSH,oDAA6D;AAE7D;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,gDAAgD,CACpE,GAAY,EACZ,IAA8C;IAE9C,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,wCAAwC,CACzC,CAAC;IACF,OAAO,MAAM,IAAA,4BAAc,EACzB,GAAG,EACH,wCAAwC,EACxC,kBAAkB,EAClB,IAAI,CACL,CAAC;AACJ,CAAC;AAbD,4GAaC"}

package/lib/generated/atmoz-sftp.d.ts

@@ -0,0 +1,302 @@
+/**
+ * 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;
+                };
+            };
+        };
+    };
+    '/sftpinstance': {
+        /** List all running sftp instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the sftp 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;
+                            };
+                        };
+                        Username: string;
+                        Password: string;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new sftp instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the sftp instance */
+                        name: string;
+                        Username: string;
+                        Password: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the sftp 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;
+                            };
+                        };
+                        Username: string;
+                        Password: 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;
+                    };
+                };
+            };
+        };
+    };
+    '/sftpinstance/{id}': {
+        /** Obtain status and resource URLs for an sftp instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the sftp instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the sftp 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;
+                            };
+                        };
+                        Username: string;
+                        Password: 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 sftp instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the sftp 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 sftp instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the sftp 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 sftp instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the sftp 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 sftp instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the sftp 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 AtmozSftp = paths['/sftpinstance/{id}']['get']['responses']['200']['schema'];
+export type AtmozSftpConfig = paths['/sftpinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * SFTP Server
+ *
+ * Effortlessly manage secure file transfers with our user-friendly SFTP server powered by OpenSSH. Ideal for sharing files securely using SSH, it integrates easily with Docker, ensuring both security and simplicity.
+
+ *
+ * Create a new sftp
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {AtmozSftpConfig}} body - Service instance configuration
+ * @returns {AtmozSftp} - Service instance
+ * @example
+ * import { Context, createAtmozSftpInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createAtmozSftpInstance(ctx, { name: 'my-instance' });
+ * console.log(instance.url);
+ */
+export declare function createAtmozSftpInstance(ctx: Context, body: AtmozSftpConfig): Promise<AtmozSftp>;
+//# sourceMappingURL=atmoz-sftp.d.ts.map

package/lib/generated/atmoz-sftp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"atmoz-sftp.d.ts","sourceRoot":"","sources":["../../src/generated/atmoz-sftp.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,eAAe,EAAE;QACf,sCAAsC;QACtC,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,6CAA6C;wBAC7C,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;wBACF,QAAQ,EAAE,MAAM,CAAC;wBACjB,QAAQ,EAAE,MAAM,CAAC;qBAClB,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,iCAAiC;QACjC,IAAI,EAAE;YACJ,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,CAAC,EAAE;wBACL,6CAA6C;wBAC7C,IAAI,EAAE,MAAM,CAAC;wBACb,QAAQ,EAAE,MAAM,CAAC;wBACjB,QAAQ,EAAE,MAAM,CAAC;qBAClB,CAAC;iBACH,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,6CAA6C;wBAC7C,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;wBACF,QAAQ,EAAE,MAAM,CAAC;wBACjB,QAAQ,EAAE,MAAM,CAAC;qBAClB,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,oBAAoB,EAAE;QACpB,2DAA2D;QAC3D,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,gCAAgC;oBAChC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,6CAA6C;wBAC7C,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;wBACF,QAAQ,EAAE,MAAM,CAAC;wBACjB,QAAQ,EAAE,MAAM,CAAC;qBAClB,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,uCAAuC;QACvC,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,gCAAgC;oBAChC,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,qCAAqC;QACrC,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,gCAAgC;oBAChC,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,oDAAoD;QACpD,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,gCAAgC;oBAChC,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,uDAAuD;QACvD,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,gCAAgC;oBAChC,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,SAAS,GACnB,KAAK,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEnE,MAAM,MAAM,eAAe,GACzB,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAkB,MAAM,oBAAoB,CAAC;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,uBAAuB,CAC3C,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,eAAe,GACpB,OAAO,CAAC,SAAS,CAAC,CAGpB"}