@meshery/schemas 1.3.6 → 1.3.8

package/dist/index.d.ts

@@ -13314,106 +13314,187 @@ interface components$n {
 
 interface components$m {
     schemas: {
-        FeaturesPage: {
+        /** @description A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design. */
+        Feature: {
             /**
              * Format: uuid
-             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             * @description Unique identifier for the feature.
              */
             id: string;
             /**
              * Format: uuid
-             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             * @description Identifier of the plan granting this feature.
              */
             plan_id: string;
+            /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
             plan?: {
                 /**
                  * Format: uuid
-                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 * @description Unique identifier for the plan.
                  */
                 id: string;
                 /**
-                 * @description Name of the plan
+                 * @description Display name of the plan.
                  * @enum {string}
                  */
                 name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                /** @enum {string} */
-                cadence: "monthly" | "yearly";
-                /** @enum {string} */
+                /**
+                 * @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 */
-                minimum_units: number;
-                /** @description Price per unit of the plan */
-                price_per_unit: number;
-                /** @enum {string} */
+                /** @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 Enumeration of possible feature types
+             * @description Name of the entitled feature.
              * @enum {string}
              */
             name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
-            /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
+            /**
+             * Format: double
+             * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
+             */
             quantity: number;
-            /** Format: date-time */
-            created_at?: string;
-            /** Format: date-time */
-            updated_at?: string;
-        }[];
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at: string;
+        };
         /**
-         * @description Enumeration of possible feature types
+         * @description Enumeration of feature names that can be granted by a plan.
          * @enum {string}
          */
         FeatureName: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
-        Feature: {
+        /** @description List of features. */
+        FeaturesPage: {
             /**
              * Format: uuid
-             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             * @description Unique identifier for the feature.
              */
             id: string;
             /**
              * Format: uuid
-             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             * @description Identifier of the plan granting this feature.
              */
             plan_id: string;
+            /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
             plan?: {
                 /**
                  * Format: uuid
-                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 * @description Unique identifier for the plan.
                  */
                 id: string;
                 /**
-                 * @description Name of the plan
+                 * @description Display name of the plan.
                  * @enum {string}
                  */
                 name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
-                /** @enum {string} */
-                cadence: "monthly" | "yearly";
-                /** @enum {string} */
+                /**
+                 * @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 */
-                minimum_units: number;
-                /** @description Price per unit of the plan */
-                price_per_unit: number;
-                /** @enum {string} */
+                /** @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 Enumeration of possible feature types
+             * @description Name of the entitled feature.
              * @enum {string}
              */
             name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
-            /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
+            /**
+             * Format: double
+             * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
+             */
             quantity: number;
-            /** Format: date-time */
-            created_at?: string;
-            /** Format: date-time */
-            updated_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at: string;
+        }[];
+    };
+    responses: {
+        /** @description Invalid request body or request param */
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Expired JWT token used or insufficient privilege */
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Result not found */
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Internal server error */
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
         };
     };
-    responses: never;
     parameters: {
         /** @description The ID of the organization */
-        organization_id: string;
+        orgId: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
     };
     requestBodies: never;
     headers: never;
@@ -30801,6 +30882,23 @@ interface components$5 {
         DashboardPrefs: {
             [key: string]: unknown;
         };
+        /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+        Links: {
+            /**
+             * Format: uri
+             * @description URL of the organization's Terms of Service page.
+             */
+            termsOfService?: string;
+            /**
+             * Format: uri
+             * @description URL of the organization's Privacy Policy page.
+             */
+            privacy?: string;
+            /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+            support?: {
+                [key: string]: string;
+            };
+        };
         /** @description Organization-level user experience preferences. */
         Preferences: {
             /** @description UI theme configured for an organization. */
@@ -30850,6 +30948,28 @@ interface components$5 {
             dashboard: {
                 [key: string]: unknown;
             };
+            /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+            links?: {
+                /**
+                 * Format: uri
+                 * @description URL of the organization's Terms of Service page.
+                 */
+                termsOfService?: string;
+                /**
+                 * Format: uri
+                 * @description URL of the organization's Privacy Policy page.
+                 */
+                privacy?: string;
+                /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                support?: {
+                    [key: string]: string;
+                };
+            };
+            /**
+             * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+             * @default true
+             */
+            showAuthCarousel: boolean;
         };
         /** @description Free-form metadata associated with an organization, including preferences. */
         OrgMetadata: {
@@ -30902,6 +31022,28 @@ interface components$5 {
                 dashboard: {
                     [key: string]: unknown;
                 };
+                /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                links?: {
+                    /**
+                     * Format: uri
+                     * @description URL of the organization's Terms of Service page.
+                     */
+                    termsOfService?: string;
+                    /**
+                     * Format: uri
+                     * @description URL of the organization's Privacy Policy page.
+                     */
+                    privacy?: string;
+                    /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                    support?: {
+                        [key: string]: string;
+                    };
+                };
+                /**
+                 * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                 * @default true
+                 */
+                showAuthCarousel: boolean;
             };
         };
         /** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
@@ -31012,6 +31154,28 @@ interface components$5 {
                     dashboard: {
                         [key: string]: unknown;
                     };
+                    /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                    links?: {
+                        /**
+                         * Format: uri
+                         * @description URL of the organization's Terms of Service page.
+                         */
+                        termsOfService?: string;
+                        /**
+                         * Format: uri
+                         * @description URL of the organization's Privacy Policy page.
+                         */
+                        privacy?: string;
+                        /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                        support?: {
+                            [key: string]: string;
+                        };
+                    };
+                    /**
+                     * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                     * @default true
+                     */
+                    showAuthCarousel: boolean;
                 };
             };
             /**
@@ -31106,6 +31270,28 @@ interface components$5 {
                         dashboard: {
                             [key: string]: unknown;
                         };
+                        /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                        links?: {
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Terms of Service page.
+                             */
+                            termsOfService?: string;
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Privacy Policy page.
+                             */
+                            privacy?: string;
+                            /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                            support?: {
+                                [key: string]: string;
+                            };
+                        };
+                        /**
+                         * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                         * @default true
+                         */
+                        showAuthCarousel: boolean;
                     };
                 };
                 /**
@@ -31201,6 +31387,28 @@ interface components$5 {
                         dashboard: {
                             [key: string]: unknown;
                         };
+                        /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                        links?: {
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Terms of Service page.
+                             */
+                            termsOfService?: string;
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Privacy Policy page.
+                             */
+                            privacy?: string;
+                            /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                            support?: {
+                                [key: string]: string;
+                            };
+                        };
+                        /**
+                         * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                         * @default true
+                         */
+                        showAuthCarousel: boolean;
                     };
                 };
                 /**
@@ -31281,6 +31489,28 @@ interface components$5 {
                 dashboard: {
                     [key: string]: unknown;
                 };
+                /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                links?: {
+                    /**
+                     * Format: uri
+                     * @description URL of the organization's Terms of Service page.
+                     */
+                    termsOfService?: string;
+                    /**
+                     * Format: uri
+                     * @description URL of the organization's Privacy Policy page.
+                     */
+                    privacy?: string;
+                    /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                    support?: {
+                        [key: string]: string;
+                    };
+                };
+                /**
+                 * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                 * @default true
+                 */
+                showAuthCarousel: boolean;
             };
         };
         /** @description Team listing record used in team listings associated with an organization. */
@@ -31554,6 +31784,28 @@ interface components$5 {
                         dashboard: {
                             [key: string]: unknown;
                         };
+                        /** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
+                        links?: {
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Terms of Service page.
+                             */
+                            termsOfService?: string;
+                            /**
+                             * Format: uri
+                             * @description URL of the organization's Privacy Policy page.
+                             */
+                            privacy?: string;
+                            /** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
+                            support?: {
+                                [key: string]: string;
+                            };
+                        };
+                        /**
+                         * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
+                         * @default true
+                         */
+                        showAuthCarousel?: boolean;
                     };
                 };
             };