@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta3/plan/Plan.d.ts

@@ -0,0 +1,198 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/entitlement/plans": {
+        get: operations["getPlans"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Paginated list of plans supported by the system. */
+        PlanPage: {
+            /** @description Current page number of the result set. */
+            page: number;
+            /** @description Number of items per page. */
+            pageSize: number;
+            /** @description Total number of items available. */
+            totalCount: number;
+            /** @description Plans returned on the current page. */
+            plans: {
+                /**
+                 * Format: uuid
+                 * @description Unique identifier for the plan.
+                 */
+                id: string;
+                /**
+                 * @description Display name of the plan.
+                 * @enum {string}
+                 */
+                name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                /**
+                 * @description Billing cadence for the plan (monthly, annually, or none).
+                 * @enum {string}
+                 */
+                cadence: "none" | "monthly" | "annually";
+                /**
+                 * @description Unit of consumption this plan charges against (e.g. user).
+                 * @enum {string}
+                 */
+                unit: "user" | "free";
+                /** @description Minimum number of units required for the plan. */
+                minimumUnits: number;
+                /** @description Price per unit of the plan. */
+                pricePerUnit: number;
+                /**
+                 * @description Currency in which the plan is priced.
+                 * @enum {string}
+                 */
+                currency: "usd";
+            }[];
+        };
+        /** @description Plan entity schema. */
+        Plan: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the plan.
+             */
+            id: string;
+            /**
+             * @description Display name of the plan.
+             * @enum {string}
+             */
+            name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+            /**
+             * @description Billing cadence for the plan (monthly, annually, or none).
+             * @enum {string}
+             */
+            cadence: "none" | "monthly" | "annually";
+            /**
+             * @description Unit of consumption this plan charges against (e.g. user).
+             * @enum {string}
+             */
+            unit: "user" | "free";
+            /** @description Minimum number of units required for the plan. */
+            minimumUnits: number;
+            /** @description Price per unit of the plan. */
+            pricePerUnit: number;
+            /**
+             * @description Currency in which the plan is priced.
+             * @enum {string}
+             */
+            currency: "usd";
+        };
+        /**
+         * @description Display name of the subscription plan.
+         * @enum {string}
+         */
+        PlanName: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+        /**
+         * @description Billing cadence of the subscription plan.
+         * @enum {string}
+         */
+        PlanCadence: "none" | "monthly" | "annually";
+        /**
+         * @description Unit of consumption the plan charges against.
+         * @enum {string}
+         */
+        PlanUnit: "user" | "free";
+        /**
+         * @description Currency code for the plan pricing.
+         * @enum {string}
+         */
+        Currency: "usd";
+    };
+    responses: {
+        /** Invalid request body or request param */
+        400: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Expired JWT token used or insufficient privilege */
+        401: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Internal server error */
+        500: {
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+}
+interface operations {
+    getPlans: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Plans response */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the plan.
+                         */
+                        id: string;
+                        /**
+                         * @description Display name of the plan.
+                         * @enum {string}
+                         */
+                        name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
+                        /**
+                         * @description Billing cadence for the plan (monthly, annually, or none).
+                         * @enum {string}
+                         */
+                        cadence: "none" | "monthly" | "annually";
+                        /**
+                         * @description Unit of consumption this plan charges against (e.g. user).
+                         * @enum {string}
+                         */
+                        unit: "user" | "free";
+                        /** @description Minimum number of units required for the plan. */
+                        minimumUnits: number;
+                        /** @description Price per unit of the plan. */
+                        pricePerUnit: number;
+                        /**
+                         * @description Currency in which the plan is priced.
+                         * @enum {string}
+                         */
+                        currency: "usd";
+                    }[];
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };

package/dist/constructs/v1beta3/plan/Plan.js

@@ -0,0 +1 @@
+'use strict';

package/dist/constructs/v1beta3/plan/PlanSchema.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was automatically generated from OpenAPI schema.
+ * Do not manually modify this file.
+ */
+declare const PlanSchema: Record<string, unknown>;
+
+export { PlanSchema as default };

package/dist/constructs/v1beta3/plan/PlanSchema.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was automatically generated from OpenAPI schema.
+ * Do not manually modify this file.
+ */
+declare const PlanSchema: Record<string, unknown>;
+
+export { PlanSchema as default };

package/dist/constructs/v1beta3/plan/PlanSchema.js

@@ -0,0 +1,2 @@
+'use strict';var e={openapi:"3.0.0",info:{title:"Plan",description:"OpenAPI schema for subscription plan management in Meshery Cloud.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Plans",description:"Operations related to plans"}],paths:{"/api/entitlement/plans":{get:{"x-internal":["cloud"],operationId:"getPlans",tags:["Plans"],summary:"Get all plans supported by the system",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Plans response",content:{"application/json":{schema:{type:"array",items:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{PlanPage:{type:"object",description:"Paginated list of plans supported by the system.",required:["page","pageSize","totalCount","plans"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount"}},plans:{type:"array",items:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},"x-go-type":"Plan"},description:"Plans returned on the current page."}}},Plan:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},PlanName:{type:"string",description:"Display name of the subscription plan.","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},PlanCadence:{type:"string",description:"Billing cadence of the subscription plan.",enum:["none","monthly","annually"]},PlanUnit:{type:"string",description:"Unit of consumption the plan charges against.",enum:["user","free"]},Currency:{type:"string",description:"Currency code for the plan pricing.",enum:["usd"]}}}},n=e;
+module.exports=n;

package/dist/constructs/v1beta3/plan/PlanSchema.mjs

@@ -0,0 +1,2 @@
+var e={openapi:"3.0.0",info:{title:"Plan",description:"OpenAPI schema for subscription plan management in Meshery Cloud.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Plans",description:"Operations related to plans"}],paths:{"/api/entitlement/plans":{get:{"x-internal":["cloud"],operationId:"getPlans",tags:["Plans"],summary:"Get all plans supported by the system",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Plans response",content:{"application/json":{schema:{type:"array",items:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{PlanPage:{type:"object",description:"Paginated list of plans supported by the system.",required:["page","pageSize","totalCount","plans"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount"}},plans:{type:"array",items:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},"x-go-type":"Plan"},description:"Plans returned on the current page."}}},Plan:{type:"object",additionalProperties:false,description:"Plan entity schema.",required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},PlanName:{type:"string",description:"Display name of the subscription plan.","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},PlanCadence:{type:"string",description:"Billing cadence of the subscription plan.",enum:["none","monthly","annually"]},PlanUnit:{type:"string",description:"Unit of consumption the plan charges against.",enum:["user","free"]},Currency:{type:"string",description:"Currency code for the plan pricing.",enum:["usd"]}}}},n=e;
+export{n as default};