@ndla/types-backend 1.0.44 → 1.0.45

package/build/myndla-api-openapi.d.ts

@@ -279,6 +279,78 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
+    "/myndla-api/v1/robots": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List out all of your own robot definitions
+         * @description List out all of your own robot definitions
+         */
+        get: operations["getMyndla-apiV1Robots"];
+        put?: never;
+        /**
+         * Create a new robot definition
+         * @description Create a new robot definition
+         */
+        post: operations["postMyndla-apiV1Robots"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/myndla-api/v1/robots/{robot-id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get single robot definition
+         * @description Get single robot definition
+         */
+        get: operations["getMyndla-apiV1RobotsRobot-id"];
+        /**
+         * Update a robot definition
+         * @description Update a robot definition
+         */
+        put: operations["putMyndla-apiV1RobotsRobot-id"];
+        post?: never;
+        /**
+         * Delete a robot definition
+         * @description Update a robot definition
+         */
+        delete: operations["deleteMyndla-apiV1RobotsRobot-id"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/myndla-api/v1/robots/{robot-id}/{robot-status}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Update a robot definition
+         * @description Update a robot definition
+         */
+        put: operations["putMyndla-apiV1RobotsRobot-idRobot-status"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/myndla-api/v1/users": {
         parameters: {
             query?: never;
@@ -494,6 +566,15 @@ export type components = {
             /** @description Value to set configuration param to. */
             value: string[] | boolean;
         };
+        /**
+         * CreateRobotDefinitionDTO
+         * @description DTO for creating a new robot definition
+         */
+        CreateRobotDefinitionDTO: {
+            status: components["schemas"]["RobotStatus"];
+            /** @description DTO for robot configuration */
+            configuration: components["schemas"]["RobotConfigurationDTO"];
+        };
         /**
          * ErrorBody
          * @description Information about an error
@@ -561,6 +642,13 @@ export type components = {
          * @enum {string}
          */
         FolderStatus: "private" | "shared";
+        /**
+         * ListOfRobotDefinitionsDTO
+         * @description DTO for listing all robot definitions
+         */
+        ListOfRobotDefinitionsDTO: {
+            robots: components["schemas"]["RobotDefinitionDTO"][];
+        };
         /** Map_Long */
         Map_Long: {
             [key: string]: number;
@@ -693,6 +781,46 @@ export type components = {
          * @enum {string}
          */
         ResourceType: "article" | "audio" | "concept" | "image" | "learningpath" | "multidisciplinary" | "topic" | "video";
+        /** RobotConfigurationDTO */
+        RobotConfigurationDTO: {
+            title: string;
+            version: string;
+            settings: components["schemas"]["RobotSettingsDTO"];
+        };
+        /**
+         * RobotDefinitionDTO
+         * @description DTO for creating a new robot definition
+         */
+        RobotDefinitionDTO: {
+            /** @description The unique identifier of the robot */
+            id: string;
+            /** @description The status of the robot */
+            status: components["schemas"]["RobotStatus"];
+            /** @description The configuration details of the robot */
+            configuration: components["schemas"]["RobotConfigurationDTO"];
+            /** @description The date when the robot was created */
+            created: string;
+            /** @description The date when the robot was last updated */
+            updated: string;
+            /** @description The date when the robot was shared, if applicable */
+            shared?: string;
+        };
+        /**
+         * RobotSettingsDTO
+         * @description DTO for robot settings
+         */
+        RobotSettingsDTO: {
+            name: string;
+            systemprompt?: string;
+            question?: string;
+            temperature: string;
+            model: string;
+        };
+        /**
+         * RobotStatus
+         * @enum {string}
+         */
+        RobotStatus: "PRIVATE" | "SHARED";
         /**
          * SingleResourceStatsDTO
          * @description Stats for single resource
@@ -2133,6 +2261,393 @@ export interface operations {
             };
         };
     };
+    "getMyndla-apiV1Robots": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListOfRobotDefinitionsDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
+    "postMyndla-apiV1Robots": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateRobotDefinitionDTO"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RobotDefinitionDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
+    "getMyndla-apiV1RobotsRobot-id": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path: {
+                "robot-id": string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RobotDefinitionDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
+    "putMyndla-apiV1RobotsRobot-id": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path: {
+                "robot-id": string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateRobotDefinitionDTO"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RobotDefinitionDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
+    "deleteMyndla-apiV1RobotsRobot-id": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path: {
+                "robot-id": string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
+    "putMyndla-apiV1RobotsRobot-idRobot-status": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Header containing FEIDE access token. */
+                FeideAuthorization?: string;
+            };
+            path: {
+                "robot-id": string;
+                "robot-status": components["schemas"]["RobotStatus"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RobotDefinitionDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+        };
+    };
     "getMyndla-apiV1Users": {
         parameters: {
             query?: never;

package/build/myndla-api.d.ts

@@ -13,6 +13,8 @@ export type ConfigMetaRestrictedDTO = schemas["ConfigMetaRestrictedDTO"];
 export type IConfigMetaRestrictedDTO = schemas["ConfigMetaRestrictedDTO"];
 export type ConfigMetaValueDTO = schemas["ConfigMetaValueDTO"];
 export type IConfigMetaValueDTO = schemas["ConfigMetaValueDTO"];
+export type CreateRobotDefinitionDTO = schemas["CreateRobotDefinitionDTO"];
+export type ICreateRobotDefinitionDTO = schemas["CreateRobotDefinitionDTO"];
 export type ErrorBody = schemas["ErrorBody"];
 export type IErrorBody = schemas["ErrorBody"];
 export type ExportedUserDataDTO = schemas["ExportedUserDataDTO"];
@@ -25,6 +27,8 @@ export type FolderSortRequestDTO = schemas["FolderSortRequestDTO"];
 export type IFolderSortRequestDTO = schemas["FolderSortRequestDTO"];
 export type FolderStatus = schemas["FolderStatus"];
 export type IFolderStatus = schemas["FolderStatus"];
+export type ListOfRobotDefinitionsDTO = schemas["ListOfRobotDefinitionsDTO"];
+export type IListOfRobotDefinitionsDTO = schemas["ListOfRobotDefinitionsDTO"];
 export type Map_Long = schemas["Map_Long"];
 export type IMap_Long = schemas["Map_Long"];
 export type Map_Map_String_Long = schemas["Map_Map_String_Long"];
@@ -47,6 +51,14 @@ export type ResourceStatsDTO = schemas["ResourceStatsDTO"];
 export type IResourceStatsDTO = schemas["ResourceStatsDTO"];
 export type ResourceType = schemas["ResourceType"];
 export type IResourceType = schemas["ResourceType"];
+export type RobotConfigurationDTO = schemas["RobotConfigurationDTO"];
+export type IRobotConfigurationDTO = schemas["RobotConfigurationDTO"];
+export type RobotDefinitionDTO = schemas["RobotDefinitionDTO"];
+export type IRobotDefinitionDTO = schemas["RobotDefinitionDTO"];
+export type RobotSettingsDTO = schemas["RobotSettingsDTO"];
+export type IRobotSettingsDTO = schemas["RobotSettingsDTO"];
+export type RobotStatus = schemas["RobotStatus"];
+export type IRobotStatus = schemas["RobotStatus"];
 export type SingleResourceStatsDTO = schemas["SingleResourceStatsDTO"];
 export type ISingleResourceStatsDTO = schemas["SingleResourceStatsDTO"];
 export type StatsDTO = schemas["StatsDTO"];

package/package.json

@@ -32,6 +32,6 @@
     "tsx": "^4.19.3",
     "typescript": "^5.3.3"
   },
-  "version": "1.0.44",
+  "version": "1.0.45",
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }