@meshery/schemas 0.8.107 → 0.8.108

package/dist/constructs/v1beta1/invitation/Invitation.d.mts

@@ -0,0 +1,644 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/organizations/invitations/{invitationId}": {
+        get: operations["getInvitation"];
+        put: operations["updateInvitation"];
+        delete: operations["deleteInvitation"];
+    };
+    "/api/organizations/invitations": {
+        get: operations["getInvitations"];
+        post: operations["createInvitation"];
+    };
+    "/api/organizations/invitations/{invitationId}/accept": {
+        post: operations["acceptInvitation"];
+    };
+}
+interface components {
+    schemas: {
+        /**
+         * Format: uuid
+         * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+         */
+        uuid: string;
+        InvitationsPage: {
+            /** @description List of invitations */
+            data: {
+                /**
+                 * Format: uuid
+                 * @description Unique identifier for the invitation , is also used as the invitation code
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                 */
+                owner_id: string;
+                /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                is_default?: boolean;
+                /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                name: string;
+                /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                description: string;
+                emails: string[];
+                /** @description ID of the organization to which the user is invited */
+                org_id: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                 */
+                expires_at?: string;
+                /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                quota?: number;
+                /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                accepted_by: string[];
+                roles: string[];
+                teams: string[];
+                /**
+                 * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                 * @enum {string}
+                 */
+                status: "enabled" | "disabled";
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the invitation was created
+                 */
+                created_at: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the invitation was last updated
+                 */
+                updated_at: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the invitation was deleted, if applicable
+                 */
+                deleted_at: string;
+            }[];
+            /** @description Total number of invitations available */
+            total: number;
+        };
+        /**
+         * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+         * @enum {string}
+         */
+        InvitationStatus: "enabled" | "disabled";
+        Invitation: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the invitation , is also used as the invitation code
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+             */
+            owner_id: string;
+            /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+            is_default?: boolean;
+            /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+            name: string;
+            /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+            description: string;
+            emails: string[];
+            /** @description ID of the organization to which the user is invited */
+            org_id: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+             */
+            expires_at?: string;
+            /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+            quota?: number;
+            /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+            accepted_by: string[];
+            roles: string[];
+            teams: string[];
+            /**
+             * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+             * @enum {string}
+             */
+            status: "enabled" | "disabled";
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was created
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was last updated
+             */
+            updated_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was deleted, if applicable
+             */
+            deleted_at: string;
+        };
+    };
+    responses: {
+        /** Bad Request */
+        400: unknown;
+        /** Unauthorized */
+        401: unknown;
+        /** Internal Server Error */
+        500: unknown;
+    };
+    parameters: {
+        /** @description The ID of the organization */
+        organization_id: string;
+        /** @description The ID of the invitation */
+        invitation_id: string;
+    };
+}
+interface operations {
+    getInvitation: {
+        parameters: {
+            path: {
+                /** The ID of the invitation */
+                invitationId: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the invitation , is also used as the invitation code
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                         */
+                        owner_id: string;
+                        /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                        is_default?: boolean;
+                        /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                        name: string;
+                        /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                        description: string;
+                        emails: string[];
+                        /** @description ID of the organization to which the user is invited */
+                        org_id: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                         */
+                        expires_at?: string;
+                        /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                        quota?: number;
+                        /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                        accepted_by: string[];
+                        roles: string[];
+                        teams: string[];
+                        /**
+                         * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                         * @enum {string}
+                         */
+                        status: "enabled" | "disabled";
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was created
+                         */
+                        created_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was last updated
+                         */
+                        updated_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was deleted, if applicable
+                         */
+                        deleted_at: string;
+                    };
+                };
+            };
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+    };
+    updateInvitation: {
+        parameters: {
+            path: {
+                /** The ID of the invitation */
+                invitationId: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the invitation , is also used as the invitation code
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                         */
+                        owner_id: string;
+                        /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                        is_default?: boolean;
+                        /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                        name: string;
+                        /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                        description: string;
+                        emails: string[];
+                        /** @description ID of the organization to which the user is invited */
+                        org_id: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                         */
+                        expires_at?: string;
+                        /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                        quota?: number;
+                        /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                        accepted_by: string[];
+                        roles: string[];
+                        teams: string[];
+                        /**
+                         * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                         * @enum {string}
+                         */
+                        status: "enabled" | "disabled";
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was created
+                         */
+                        created_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was last updated
+                         */
+                        updated_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was deleted, if applicable
+                         */
+                        deleted_at: string;
+                    };
+                };
+            };
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the invitation , is also used as the invitation code
+                     */
+                    id: string;
+                    /**
+                     * Format: uuid
+                     * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                     */
+                    owner_id: string;
+                    /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                    is_default?: boolean;
+                    /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                    name: string;
+                    /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                    description: string;
+                    emails: string[];
+                    /** @description ID of the organization to which the user is invited */
+                    org_id: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                     */
+                    expires_at?: string;
+                    /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                    quota?: number;
+                    /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                    accepted_by: string[];
+                    roles: string[];
+                    teams: string[];
+                    /**
+                     * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                     * @enum {string}
+                     */
+                    status: "enabled" | "disabled";
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was created
+                     */
+                    created_at: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was last updated
+                     */
+                    updated_at: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was deleted, if applicable
+                     */
+                    deleted_at: string;
+                };
+            };
+        };
+    };
+    deleteInvitation: {
+        parameters: {
+            path: {
+                /** The ID of the invitation */
+                invitationId: string;
+            };
+        };
+        responses: {
+            /** Invitation deleted successfully */
+            204: never;
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+    };
+    getInvitations: {
+        responses: {
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description List of invitations */
+                        data: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the invitation , is also used as the invitation code
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                             */
+                            owner_id: string;
+                            /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                            is_default?: boolean;
+                            /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                            name: string;
+                            /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                            description: string;
+                            emails: string[];
+                            /** @description ID of the organization to which the user is invited */
+                            org_id: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                             */
+                            expires_at?: string;
+                            /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                            quota?: number;
+                            /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                            accepted_by: string[];
+                            roles: string[];
+                            teams: string[];
+                            /**
+                             * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                             * @enum {string}
+                             */
+                            status: "enabled" | "disabled";
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the invitation was created
+                             */
+                            created_at: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the invitation was last updated
+                             */
+                            updated_at: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the invitation was deleted, if applicable
+                             */
+                            deleted_at: string;
+                        }[];
+                        /** @description Total number of invitations available */
+                        total: number;
+                    };
+                };
+            };
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+    };
+    createInvitation: {
+        responses: {
+            201: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the invitation , is also used as the invitation code
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                         */
+                        owner_id: string;
+                        /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                        is_default?: boolean;
+                        /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                        name: string;
+                        /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                        description: string;
+                        emails: string[];
+                        /** @description ID of the organization to which the user is invited */
+                        org_id: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                         */
+                        expires_at?: string;
+                        /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                        quota?: number;
+                        /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                        accepted_by: string[];
+                        roles: string[];
+                        teams: string[];
+                        /**
+                         * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                         * @enum {string}
+                         */
+                        status: "enabled" | "disabled";
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was created
+                         */
+                        created_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was last updated
+                         */
+                        updated_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was deleted, if applicable
+                         */
+                        deleted_at: string;
+                    };
+                };
+            };
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the invitation , is also used as the invitation code
+                     */
+                    id: string;
+                    /**
+                     * Format: uuid
+                     * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                     */
+                    owner_id: string;
+                    /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                    is_default?: boolean;
+                    /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                    name: string;
+                    /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                    description: string;
+                    emails: string[];
+                    /** @description ID of the organization to which the user is invited */
+                    org_id: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                     */
+                    expires_at?: string;
+                    /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                    quota?: number;
+                    /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                    accepted_by: string[];
+                    roles: string[];
+                    teams: string[];
+                    /**
+                     * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                     * @enum {string}
+                     */
+                    status: "enabled" | "disabled";
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was created
+                     */
+                    created_at: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was last updated
+                     */
+                    updated_at: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the invitation was deleted, if applicable
+                     */
+                    deleted_at: string;
+                };
+            };
+        };
+    };
+    acceptInvitation: {
+        parameters: {
+            path: {
+                /** The ID of the invitation */
+                invitationId: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the invitation , is also used as the invitation code
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
+                         */
+                        owner_id: string;
+                        /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation */
+                        is_default?: boolean;
+                        /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
+                        name: string;
+                        /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
+                        description: string;
+                        emails: string[];
+                        /** @description ID of the organization to which the user is invited */
+                        org_id: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
+                         */
+                        expires_at?: string;
+                        /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
+                        quota?: number;
+                        /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
+                        accepted_by: string[];
+                        roles: string[];
+                        teams: string[];
+                        /**
+                         * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
+                         * @enum {string}
+                         */
+                        status: "enabled" | "disabled";
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was created
+                         */
+                        created_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was last updated
+                         */
+                        updated_at: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the invitation was deleted, if applicable
+                         */
+                        deleted_at: string;
+                    };
+                };
+            };
+            /** Bad Request */
+            400: unknown;
+            /** Unauthorized */
+            401: unknown;
+            /** Internal Server Error */
+            500: unknown;
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };