@osaas/client-services 0.12.1 → 0.14.0

package/lib/generated/eyevinn-python-runner.d.ts

@@ -0,0 +1,679 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Health check endpoint */
+        get: {
+            parameters: {
+                query: {
+                    verbose?: boolean;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: Partial<string> & Partial<{
+                        status: string;
+                        versions: {
+                            '@osaas/orchestrator': string;
+                        };
+                        environment: string;
+                        _links: {
+                            self: {
+                                href: string;
+                            };
+                            api: {
+                                href: string;
+                            };
+                        };
+                    }>;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        status: string;
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/python-runnerinstance': {
+        /** List all running python-runner instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: ({
+                        /** @description Name of the python-runner 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;
+                            };
+                        };
+                        SourceUrl: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            nodePorts?: {
+                                /** @description Get assigned NodePorts for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    })[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new python-runner instance */
+        post: {
+            parameters: {
+                query: {
+                    beta?: boolean;
+                };
+                body: {
+                    body?: {
+                        /** @description Name of the python-runner instance */
+                        name: string;
+                        SourceUrl: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the python-runner 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;
+                            };
+                        };
+                        SourceUrl: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            nodePorts?: {
+                                /** @description Get assigned NodePorts for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: 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;
+                    };
+                };
+            };
+        };
+    };
+    '/restart/{id}': {
+        /** Restart python-runner */
+        post: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/python-runnerinstance/{id}': {
+        /** Obtain status and resource URLs for an python-runner instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the python-runner 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;
+                            };
+                        };
+                        SourceUrl: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            nodePorts?: {
+                                /** @description Get assigned NodePorts for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: 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 python-runner instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Patch python-runner instance with new parameters and restart */
+        patch: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the python-runner instance */
+                        name?: string;
+                        SourceUrl?: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    };
+                };
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the python-runner 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;
+                            };
+                        };
+                        SourceUrl: string;
+                        GitHubToken?: string;
+                        AwsAccessKeyId?: string;
+                        AwsSecretAccessKey?: string;
+                        AwsRegion?: string;
+                        S3EndpointUrl?: string;
+                        OscAccessToken?: string;
+                        ConfigService?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            nodePorts?: {
+                                /** @description Get assigned NodePorts for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                400: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of python-runner instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                        images?: string[];
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the python-runner instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the python-runner 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 python-runner instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner 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;
+                    };
+                };
+            };
+        };
+    };
+    '/nodeports/{id}': {
+        /** Return the assigned NodePorts for python-runner instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the python-runner instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        name: string;
+                        protocol: Partial<'TCP'> & Partial<'UDP'>;
+                        port: number;
+                        ip?: string;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface definitions {
+}
+export interface operations {
+}
+export interface external {
+}
+export type EyevinnPythonRunner = paths['/python-runnerinstance/{id}']['get']['responses']['200']['schema'];
+export type EyevinnPythonRunnerConfig = paths['/python-runnerinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * @namespace eyevinn-python-runner
+ * @description Effortlessly deploy your Python web apps with our Docker-based Python Runner! Clone from GitHub or S3, install dependencies, and auto-detect frameworks for seamless app execution. Ideal for FastAPI, Flask, and more!
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} EyevinnPythonRunnerConfig
+ * @property {string} name - Name of python-runner
+ * @property {string} SourceUrl - SourceUrl
+ * @property {string} [GitHubToken] - GitHubToken
+ * @property {string} [AwsAccessKeyId] - AwsAccessKeyId
+ * @property {string} [AwsSecretAccessKey] - AwsSecretAccessKey
+ * @property {string} [AwsRegion] - AwsRegion
+ * @property {string} [S3EndpointUrl] - S3EndpointUrl
+ * @property {string} [OscAccessToken] - OscAccessToken
+ * @property {string} [ConfigService] - ConfigService
+
+ *
+ */
+/**
+ * @typedef {Object} EyevinnPythonRunner
+ * @property {string} name - Name of the Python Runner instance
+ * @property {string} url - URL of the Python Runner instance
+ *
+ */
+/**
+ * Create a new Python Runner instance
+ *
+ * @memberOf eyevinn-python-runner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {EyevinnPythonRunnerConfig} body - Service instance configuration
+ * @returns {EyevinnPythonRunner} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createEyevinnPythonRunnerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: EyevinnPythonRunnerConfig = { name: 'myinstance', ... };
+ * const instance = await createEyevinnPythonRunnerInstance(ctx, body);
+ * console.log(instance.url);
+ */
+export declare function createEyevinnPythonRunnerInstance(ctx: Context, body: EyevinnPythonRunnerConfig): Promise<EyevinnPythonRunner>;
+/**
+ * Remove a Python Runner instance
+ *
+ * @memberOf eyevinn-python-runner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the python-runner to be removed
+ */
+export declare function removeEyevinnPythonRunnerInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a Python Runner instance
+ *
+ * @memberOf eyevinn-python-runner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the python-runner to be retrieved
+ * @returns {EyevinnPythonRunner} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getEyevinnPythonRunnerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getEyevinnPythonRunnerInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+export declare function getEyevinnPythonRunnerInstance(ctx: Context, name: string): Promise<EyevinnPythonRunner>;
+//# sourceMappingURL=eyevinn-python-runner.d.ts.map