@osaas/client-services 0.14.0 → 0.15.0

package/lib/generated/tuomoku-spx-gc.d.ts

@@ -0,0 +1,693 @@
+/**
+ * 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;
+                    };
+                };
+            };
+        };
+    };
+    '/spx-gcinstance': {
+        /** List all running spx-gc instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: ({
+                        /** @description Name of the spx-gc 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;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: 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 spx-gc instance */
+        post: {
+            parameters: {
+                query: {
+                    beta?: boolean;
+                };
+                body: {
+                    body?: {
+                        /** @description Name of the spx-gc instance */
+                        name: string;
+                        Username?: string;
+                        Password?: string;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the spx-gc 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;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: 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 spx-gc */
+        post: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/spx-gcinstance/{id}': {
+        /** Obtain status and resource URLs for an spx-gc instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the spx-gc 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;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: 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 spx-gc instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Patch spx-gc instance with new parameters and restart */
+        patch: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the spx-gc instance */
+                        name?: string;
+                        Username?: string;
+                        Password?: string;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: string;
+                    };
+                };
+                path: {
+                    /** Name of the spx-gc instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the spx-gc 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;
+                        S3TemplatesUrl?: string;
+                        S3ProjectsUrl?: string;
+                        S3PluginsUrl?: string;
+                        S3MediaUrl?: string;
+                        S3EndpointUrl?: string;
+                        S3AccessKeyId?: string;
+                        S3SecretAccessKey?: string;
+                        S3Region?: 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 spx-gc instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc 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 spx-gc instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the spx-gc 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 spx-gc instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc 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 spx-gc instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the spx-gc 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 TuomokuSpxGc = paths['/spx-gcinstance/{id}']['get']['responses']['200']['schema'];
+export type TuomokuSpxGcConfig = paths['/spx-gcinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * @namespace tuomoku-spx-gc
+ * @description Elevate your live productions with SPX Graphics Controller! Seamlessly manage HTML graphics across platforms like OBS, vMix, and more. Ideal for stunning live streams and broadcasts with powerful customization.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} TuomokuSpxGcConfig
+ * @property {string} name - Name of spx-gc
+ * @property {string} [Username] - Username for SPX authentication. If provided along with password, users will be required to login to access the application.
+ * @property {string} [Password] - Password for SPX authentication. Works in conjunction with username to enable login protection for the application.
+ * @property {string} [S3TemplatesUrl] - S3 bucket URL or path for storing and retrieving HTML graphics templates used by SPX for live production graphics.
+ * @property {string} [S3ProjectsUrl] - S3 bucket URL or path for storing SPX projects and rundowns data that would normally be stored in the DATAROOT folder.
+ * @property {string} [S3PluginsUrl] - Configures the S3 bucket URL for storing SPX plugins and extensions. Plugins provide additional functionality like custom controls and user interface panels.
+ * @property {string} [S3MediaUrl] - Configures the S3 bucket URL for storing media assets like images, videos, and other files used by graphics templates.
+ * @property {string} [S3EndpointUrl] - Custom S3-compatible endpoint URL for accessing object storage services other than AWS S3, such as MinIO, DigitalOcean Spaces, or other S3-compatible storage providers.
+ * @property {string} [S3AccessKeyId] - AWS access key ID for authenticating with S3 services to access templates, projects, and media assets stored in cloud storage.
+ * @property {string} [S3SecretAccessKey] - AWS secret access key for authenticating with S3 services, paired with the access key ID for secure cloud storage access.
+ * @property {string} [S3Region] - AWS region identifier specifying the geographical region where the S3 buckets are located for optimal performance and compliance.
+
+ *
+ */
+/**
+ * @typedef {Object} TuomokuSpxGc
+ * @property {string} name - Name of the SPX Graphics Controller instance
+ * @property {string} url - URL of the SPX Graphics Controller instance
+ *
+ */
+/**
+ * Create a new SPX Graphics Controller instance
+ *
+ * @memberOf tuomoku-spx-gc
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {TuomokuSpxGcConfig} body - Service instance configuration
+ * @returns {TuomokuSpxGc} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createTuomokuSpxGcInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: TuomokuSpxGcConfig = { name: 'myinstance', ... };
+ * const instance = await createTuomokuSpxGcInstance(ctx, body);
+ * console.log(instance.url);
+ */
+export declare function createTuomokuSpxGcInstance(ctx: Context, body: TuomokuSpxGcConfig): Promise<TuomokuSpxGc>;
+/**
+ * Remove a SPX Graphics Controller instance
+ *
+ * @memberOf tuomoku-spx-gc
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the controller to be removed
+ */
+export declare function removeTuomokuSpxGcInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a SPX Graphics Controller instance
+ *
+ * @memberOf tuomoku-spx-gc
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the controller to be retrieved
+ * @returns {TuomokuSpxGc} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getTuomokuSpxGcInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getTuomokuSpxGcInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+export declare function getTuomokuSpxGcInstance(ctx: Context, name: string): Promise<TuomokuSpxGc>;
+//# sourceMappingURL=tuomoku-spx-gc.d.ts.map