academe-kit 0.3.8 → 0.3.9

package/dist/types/types/academe-api.d.ts

@@ -4760,7 +4760,7 @@ export interface paths {
         };
         trace?: never;
     };
-    "/plans": {
+    "/products": {
         parameters: {
             query?: never;
             header?: never;
@@ -4768,14 +4768,20 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get all plans
-         * @description Retrieve a list of all subscription plans
+         * List all products
+         * @description Retrieve a paginated list of all products
          */
         get: {
             parameters: {
                 query?: {
-                    /** @description Search plans by name or code */
+                    /** @description Filter by product name (partial match) */
+                    name?: string;
+                    /** @description Search products by name */
                     search?: string;
+                    /** @description Page number */
+                    page?: number;
+                    /** @description Number of items per page */
+                    limit?: number;
                 };
                 header?: never;
                 path?: never;
@@ -4783,21 +4789,33 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description List of plans */
+                /** @description List of products */
                 200: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Plan"][];
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["Product"][];
+                            meta?: {
+                                total?: number;
+                                page?: number;
+                                limit?: number;
+                                totalPages?: number;
+                            };
+                        };
                     };
                 };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
             };
         };
         put?: never;
         /**
-         * Create a new plan
-         * @description Create a new subscription plan
+         * Create a new product
+         * @description Create a new product in the system
          */
         post: {
             parameters: {
@@ -4808,26 +4826,40 @@ export interface paths {
             };
             requestBody: {
                 content: {
-                    "application/json": components["schemas"]["CreatePlanDto"];
+                    "application/json": components["schemas"]["CreateProductDto"];
                 };
             };
             responses: {
-                /** @description Plan created successfully */
+                /** @description Product created successfully */
                 201: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Plan"];
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["Product"];
+                        };
                     };
                 };
-                /** @description Plan with this code already exists */
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                /** @description Product with this name already exists */
                 409: {
                     headers: {
                         [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Product with this name already exists */
+                            message?: string;
+                        };
+                    };
                 };
+                500: components["responses"]["ServerError"];
             };
         };
         delete?: never;
@@ -4836,7 +4868,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/plans/{id}": {
+    "/products/{id}": {
         parameters: {
             query?: never;
             header?: never;
@@ -4844,111 +4876,117 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get a plan by ID
-         * @description Retrieve details of a specific plan
+         * Get product by ID
+         * @description Retrieve detailed information about a specific product including associated seats
          */
         get: {
             parameters: {
                 query?: never;
                 header?: never;
                 path: {
-                    /** @description Plan ID */
+                    /** @description Product ID */
                     id: string;
                 };
                 cookie?: never;
             };
             requestBody?: never;
             responses: {
-                /** @description Plan found */
+                /** @description Product information */
                 200: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Plan"];
-                    };
-                };
-                /** @description Plan not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["Product"];
+                        };
                     };
-                    content?: never;
                 };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
             };
         };
         put?: never;
         post?: never;
         /**
-         * Delete a plan
-         * @description Delete an existing plan
+         * Delete product
+         * @description Remove a product from the system
          */
         delete: {
             parameters: {
                 query?: never;
                 header?: never;
                 path: {
-                    /** @description Plan ID */
+                    /** @description Product ID */
                     id: string;
                 };
                 cookie?: never;
             };
             requestBody?: never;
             responses: {
-                /** @description Plan deleted successfully */
+                /** @description Product deleted successfully */
                 204: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content?: never;
                 };
-                /** @description Plan not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
             };
         };
         options?: never;
         head?: never;
         /**
-         * Update a plan
-         * @description Update an existing plan
+         * Update product
+         * @description Update product information
          */
         patch: {
             parameters: {
                 query?: never;
                 header?: never;
                 path: {
-                    /** @description Plan ID */
+                    /** @description Product ID */
                     id: string;
                 };
                 cookie?: never;
             };
             requestBody: {
                 content: {
-                    "application/json": components["schemas"]["UpdatePlanDto"];
+                    "application/json": components["schemas"]["UpdateProductDto"];
                 };
             };
             responses: {
-                /** @description Plan updated successfully */
+                /** @description Product updated successfully */
                 200: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Plan"];
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["Product"];
+                        };
                     };
                 };
-                /** @description Plan not found */
-                404: {
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                /** @description Product with this name already exists */
+                409: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content?: never;
                 };
+                500: components["responses"]["ServerError"];
             };
         };
         trace?: never;
@@ -7345,203 +7383,6 @@ export interface paths {
         };
         trace?: never;
     };
-    "/subscriptions": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get all subscriptions
-         * @description Retrieve a list of all subscriptions with optional filters
-         */
-        get: {
-            parameters: {
-                query?: {
-                    /** @description Filter by plan ID */
-                    planId?: string;
-                    /** @description Filter by institution ID */
-                    institutionId?: string;
-                    /** @description Filter by group ID */
-                    groupId?: string;
-                };
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description List of subscriptions */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Subscription"][];
-                    };
-                };
-            };
-        };
-        put?: never;
-        /**
-         * Create a new subscription
-         * @description Create a subscription linking a plan to an institution or group
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": components["schemas"]["CreateSubscriptionDto"];
-                };
-            };
-            responses: {
-                /** @description Subscription created successfully */
-                201: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Subscription"];
-                    };
-                };
-                /** @description Invalid request (missing required fields) */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/subscriptions/{id}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get a subscription by ID
-         * @description Retrieve details of a specific subscription
-         */
-        get: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path: {
-                    /** @description Subscription ID */
-                    id: string;
-                };
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Subscription found */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Subscription"];
-                    };
-                };
-                /** @description Subscription not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        /**
-         * Delete a subscription
-         * @description Delete an existing subscription
-         */
-        delete: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path: {
-                    /** @description Subscription ID */
-                    id: string;
-                };
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Subscription deleted successfully */
-                204: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
-                /** @description Subscription not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
-            };
-        };
-        options?: never;
-        head?: never;
-        /**
-         * Update a subscription
-         * @description Update an existing subscription
-         */
-        patch: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path: {
-                    /** @description Subscription ID */
-                    id: string;
-                };
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": components["schemas"]["UpdateSubscriptionDto"];
-                };
-            };
-            responses: {
-                /** @description Subscription updated successfully */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Subscription"];
-                    };
-                };
-                /** @description Subscription not found */
-                404: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
-            };
-        };
-        trace?: never;
-    };
     "/superset/dashboard/{dash_id}": {
         parameters: {
             query?: never;
@@ -9263,6 +9104,11 @@ export interface components {
              * @description Group ID
              */
             groupId?: string;
+            /**
+             * Format: uuid
+             * @description Product ID associated with this seat
+             */
+            productId?: string;
             /** @description Available quantity for this group in the institution */
             availableQuantity?: number;
             /** @description Number of users currently assigned to this group in the institution */
@@ -9272,6 +9118,7 @@ export interface components {
             /** Format: date-time */
             updatedAt?: string;
             group?: components["schemas"]["Group"];
+            product?: components["schemas"]["Product"];
         };
         CreateSeatsDto: {
             /**
@@ -9279,6 +9126,11 @@ export interface components {
              * @description Group ID to associate with the institution
              */
             groupId: string;
+            /**
+             * Format: uuid
+             * @description Product ID to associate with the seat
+             */
+            productId: string;
             /**
              * @description Available quantity for this group
              * @default 0
@@ -9289,75 +9141,65 @@ export interface components {
             /** @description New available quantity for this group */
             availableQuantity: number;
         };
-        Plan: {
+        /**
+         * @example {
+         *       "id": "550e8400-e29b-41d4-a716-446655440000",
+         *       "name": "Premium Plan",
+         *       "description": "Full access to all platform features",
+         *       "createdAt": "2024-01-15T10:30:00Z",
+         *       "updatedAt": "2024-01-15T10:30:00Z"
+         *     }
+         */
+        Product: {
             /**
              * Format: uuid
-             * @description Unique identifier for the plan
-             */
-            id: string;
-            /**
-             * @description Unique code for the plan (e.g., gold_plan, free_tier)
-             * @example gold_plan
+             * @description Unique identifier of the product
              */
-            code: string;
-            /**
-             * @description Display name of the plan
-             * @example Plano Gold
-             */
-            name: string;
-            /**
-             * @description JSON object with plan settings and configurations
-             * @example {
-             *       "maxUsers": 100,
-             *       "features": [
-             *         "analytics",
-             *         "support"
-             *       ]
-             *     }
-             */
-            settings: Record<string, never>;
-            /**
-             * @description Whether the plan is currently active
-             * @default true
-             */
-            isActive: boolean;
+            id?: string;
+            /** @description Name of the product */
+            name?: string;
+            /** @description Description of the product */
+            description?: string | null;
             /**
              * Format: date-time
-             * @description Timestamp when the plan was created
+             * @description Creation timestamp
              */
             createdAt?: string;
-        };
-        CreatePlanDto: {
             /**
-             * @description Unique code for the plan
-             * @example gold_plan
+             * Format: date-time
+             * @description Last update timestamp
              */
-            code: string;
+            updatedAt?: string;
+        };
+        /**
+         * @example {
+         *       "id": "550e8400-e29b-41d4-a716-446655440000",
+         *       "name": "Premium Plan",
+         *       "description": "Full access to all platform features"
+         *     }
+         */
+        CreateProductDto: {
             /**
-             * @description Display name of the plan
-             * @example Plano Gold
+             * Format: uuid
+             * @description Optional custom UUID for the product (auto-generated if not provided)
              */
+            id?: string;
+            /** @description Name of the product */
             name: string;
-            /**
-             * @description JSON object with plan settings
-             * @example {
-             *       "maxUsers": 100
-             *     }
-             */
-            settings?: Record<string, never>;
-            /**
-             * @description Whether the plan is active
-             * @default true
-             */
-            isActive: boolean;
+            /** @description Description of the product */
+            description?: string;
         };
-        UpdatePlanDto: {
-            /** @description Display name of the plan */
+        /**
+         * @example {
+         *       "name": "Premium Plan Updated",
+         *       "description": "Updated description"
+         *     }
+         */
+        UpdateProductDto: {
+            /** @description Name of the product */
             name?: string;
-            /** @description JSON object with plan settings */
-            settings?: Record<string, never>;
-            /** @description Whether the plan is active */
-            isActive?: boolean;
+            /** @description Description of the product */
+            description?: string;
         };
         StudentWithClass: {
             /** Format: uuid */
@@ -9442,71 +9284,6 @@ export interface components {
             totalStudents?: number;
             year?: number;
         };
-        Subscription: {
-            /**
-             * Format: uuid
-             * @description Unique identifier for the subscription
-             */
-            id: string;
-            /**
-             * Format: uuid
-             * @description ID of the associated plan
-             */
-            planId: string;
-            /**
-             * Format: uuid
-             * @description ID of the associated institution (optional)
-             */
-            institutionId?: string | null;
-            /**
-             * Format: uuid
-             * @description ID of the associated group (optional)
-             */
-            groupId?: string | null;
-            /**
-             * Format: date-time
-             * @description Timestamp when the subscription was created
-             */
-            createdAt?: string;
-            plan?: components["schemas"]["Plan"];
-            institution?: components["schemas"]["Institution"];
-            group?: components["schemas"]["Group"];
-        };
-        /** @description At least one of institutionId or groupId must be provided */
-        CreateSubscriptionDto: {
-            /**
-             * Format: uuid
-             * @description ID of the plan to subscribe to
-             */
-            planId: string;
-            /**
-             * Format: uuid
-             * @description ID of the institution (required if groupId is not provided)
-             */
-            institutionId?: string | null;
-            /**
-             * Format: uuid
-             * @description ID of the group (required if institutionId is not provided)
-             */
-            groupId?: string | null;
-        };
-        UpdateSubscriptionDto: {
-            /**
-             * Format: uuid
-             * @description ID of the plan
-             */
-            planId?: string;
-            /**
-             * Format: uuid
-             * @description ID of the institution
-             */
-            institutionId?: string | null;
-            /**
-             * Format: uuid
-             * @description ID of the group
-             */
-            groupId?: string | null;
-        };
         CreateUserDto: {
             /** @example John */
             firstName: string;
@@ -9548,6 +9325,12 @@ export interface components {
              * @example 550e8400-e29b-41d4-a716-446655440001
              */
             institutionId?: string;
+            /**
+             * Format: uuid
+             * @description Optional guardian ID to associate the user with a guardian
+             * @example 550e8400-e29b-41d4-a716-446655440002
+             */
+            guardianId?: string;
         };
         UserResponse: components["schemas"]["User"];
         CreateInstitutionDto: {