@meshery/schemas 1.2.15 → 1.2.16

package/dist/constructs/v1beta3/invitation/Invitation.d.ts

@@ -0,0 +1,1060 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export 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"];
+  };
+  "/api/identity/orgs/{orgId}/users/invite": {
+    post: operations["handleUserInvite"];
+  };
+  "/api/identity/users/request": {
+    get: operations["getSignupRequests"];
+    post: operations["signupRequest"];
+  };
+  "/api/identity/users/request/approve": {
+    post: operations["approveSignupRequest"];
+  };
+  "/api/identity/users/request/deny": {
+    post: operations["denySignupRequest"];
+  };
+  "/api/identity/users/request/notification": {
+    get: operations["getSignupRequestNotification"];
+  };
+}
+
+export 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;
+    /** @description Paginated list of invitations for an organization. */
+    InvitationsPage: {
+      /** @description Invitations returned on the current page. */
+      data: {
+        /**
+         * Format: uuid
+         * @description Unique identifier for the invitation, also used as the invitation code.
+         */
+        id: string;
+        /**
+         * Format: uuid
+         * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+         */
+        ownerId: 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. An organization can only have one default invitation. */
+        isDefault?: boolean;
+        /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+        name: string;
+        /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+        description: string;
+        /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+        emails: string[];
+        /**
+         * Format: uuid
+         * @description ID of the organization to which the user is invited.
+         */
+        orgId: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+         */
+        expiresAt?: string;
+        /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+        quota?: number;
+        /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+        acceptedBy: string[];
+        /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+        roles: string[];
+        /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+        teams: string[];
+        /**
+         * @description Activation status of the invitation.
+         * @enum {string}
+         */
+        status: "enabled" | "disabled";
+        /**
+         * Format: date-time
+         * @description Timestamp when the invitation was created.
+         */
+        createdAt: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the invitation was last updated.
+         */
+        updatedAt: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the invitation was deleted, if applicable.
+         */
+        deletedAt: string;
+      }[];
+      /** @description Total number of invitations available. */
+      total: number;
+    };
+    /** @description A signup request submitted for organization access. */
+    SignupRequest: { [key: string]: unknown };
+    /** @description Paginated list of signup requests. */
+    SignupRequestsPage: {
+      /** @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 Signup requests returned on the current page. */
+      data?: { [key: string]: unknown }[];
+    };
+    /** @description Payload for creating or updating an invitation. */
+    InvitationPayload: {
+      /**
+       * Format: uuid
+       * @description Existing invitation ID for updates; omit on create.
+       */
+      id?: string;
+      /**
+       * Format: uuid
+       * @description ID of the user who created the invitation.
+       */
+      ownerId?: string;
+      /** @description Indicates whether the invitation is a default invitation (open invite). */
+      isDefault?: boolean;
+      /** @description Name of the invitation. */
+      name: string;
+      /** @description Description of the invitation. */
+      description: string;
+      /** @description Email addresses or patterns this invitation is valid for. */
+      emails: string[];
+      /**
+       * Format: uuid
+       * @description ID of the organization to which the user is invited.
+       */
+      orgId: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the invitation expires, if applicable.
+       */
+      expiresAt?: string;
+      /** @description Quota for the invitation; limits the number of users that can accept it. */
+      quota?: number;
+      /** @description Roles that the user will have when accepting the invitation. */
+      roles: string[];
+      /** @description Teams that the user will be added to when accepting the invitation. */
+      teams: string[];
+      /**
+       * @description Activation status of the invitation.
+       * @enum {string}
+       */
+      status: "enabled" | "disabled";
+    };
+    /**
+     * @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";
+    /** @description Invitation entity schema. */
+    Invitation: {
+      /**
+       * Format: uuid
+       * @description Unique identifier for the invitation, also used as the invitation code.
+       */
+      id: string;
+      /**
+       * Format: uuid
+       * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+       */
+      ownerId: 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. An organization can only have one default invitation. */
+      isDefault?: boolean;
+      /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+      name: string;
+      /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+      description: string;
+      /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+      emails: string[];
+      /**
+       * Format: uuid
+       * @description ID of the organization to which the user is invited.
+       */
+      orgId: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+       */
+      expiresAt?: string;
+      /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+      quota?: number;
+      /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+      acceptedBy: string[];
+      /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+      roles: string[];
+      /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+      teams: string[];
+      /**
+       * @description Activation status of the invitation.
+       * @enum {string}
+       */
+      status: "enabled" | "disabled";
+      /**
+       * Format: date-time
+       * @description Timestamp when the invitation was created.
+       */
+      createdAt: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the invitation was last updated.
+       */
+      updatedAt: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the invitation was deleted, if applicable.
+       */
+      deletedAt: string;
+    };
+  };
+  responses: {
+    /** Invalid request body or request param */
+    400: {
+      content: {
+        "text/plain": string;
+      };
+    };
+    /** Expired JWT token used or insufficient privilege */
+    401: {
+      content: {
+        "text/plain": string;
+      };
+    };
+    /** Result not found */
+    404: {
+      content: {
+        "text/plain": string;
+      };
+    };
+    /** Internal server error */
+    500: {
+      content: {
+        "text/plain": string;
+      };
+    };
+  };
+  parameters: {
+    /** @description The ID of the organization. */
+    orgId: string;
+    /** @description The ID of the invitation. */
+    invitationId: string;
+  };
+}
+
+export interface operations {
+  getInvitation: {
+    parameters: {
+      path: {
+        /** The ID of the invitation. */
+        invitationId: string;
+      };
+    };
+    responses: {
+      /** Invitation fetched */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the invitation, also used as the invitation code.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+             */
+            ownerId: 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. An organization can only have one default invitation. */
+            isDefault?: boolean;
+            /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+            name: string;
+            /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+            description: string;
+            /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+            emails: string[];
+            /**
+             * Format: uuid
+             * @description ID of the organization to which the user is invited.
+             */
+            orgId: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+             */
+            expiresAt?: string;
+            /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+            quota?: number;
+            /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+            acceptedBy: string[];
+            /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+            roles: string[];
+            /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+            teams: string[];
+            /**
+             * @description Activation status of the invitation.
+             * @enum {string}
+             */
+            status: "enabled" | "disabled";
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was deleted, if applicable.
+             */
+            deletedAt: string;
+          };
+        };
+      };
+      /** Invalid request body or request param */
+      400: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+  updateInvitation: {
+    parameters: {
+      path: {
+        /** The ID of the invitation. */
+        invitationId: string;
+      };
+    };
+    responses: {
+      /** Invitation updated */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the invitation, also used as the invitation code.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+             */
+            ownerId: 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. An organization can only have one default invitation. */
+            isDefault?: boolean;
+            /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+            name: string;
+            /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+            description: string;
+            /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+            emails: string[];
+            /**
+             * Format: uuid
+             * @description ID of the organization to which the user is invited.
+             */
+            orgId: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+             */
+            expiresAt?: string;
+            /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+            quota?: number;
+            /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+            acceptedBy: string[];
+            /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+            roles: string[];
+            /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+            teams: string[];
+            /**
+             * @description Activation status of the invitation.
+             * @enum {string}
+             */
+            status: "enabled" | "disabled";
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was deleted, if applicable.
+             */
+            deletedAt: string;
+          };
+        };
+      };
+      /** Invalid request body or request param */
+      400: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          /**
+           * Format: uuid
+           * @description Existing invitation ID for updates; omit on create.
+           */
+          id?: string;
+          /**
+           * Format: uuid
+           * @description ID of the user who created the invitation.
+           */
+          ownerId?: string;
+          /** @description Indicates whether the invitation is a default invitation (open invite). */
+          isDefault?: boolean;
+          /** @description Name of the invitation. */
+          name: string;
+          /** @description Description of the invitation. */
+          description: string;
+          /** @description Email addresses or patterns this invitation is valid for. */
+          emails: string[];
+          /**
+           * Format: uuid
+           * @description ID of the organization to which the user is invited.
+           */
+          orgId: string;
+          /**
+           * Format: date-time
+           * @description Timestamp when the invitation expires, if applicable.
+           */
+          expiresAt?: string;
+          /** @description Quota for the invitation; limits the number of users that can accept it. */
+          quota?: number;
+          /** @description Roles that the user will have when accepting the invitation. */
+          roles: string[];
+          /** @description Teams that the user will be added to when accepting the invitation. */
+          teams: string[];
+          /**
+           * @description Activation status of the invitation.
+           * @enum {string}
+           */
+          status: "enabled" | "disabled";
+        };
+      };
+    };
+  };
+  deleteInvitation: {
+    parameters: {
+      path: {
+        /** The ID of the invitation. */
+        invitationId: string;
+      };
+    };
+    responses: {
+      /** Invitation deleted */
+      204: never;
+      /** Invalid request body or request param */
+      400: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+  getInvitations: {
+    responses: {
+      /** Invitations page */
+      200: {
+        content: {
+          "application/json": {
+            /** @description Invitations returned on the current page. */
+            data: {
+              /**
+               * Format: uuid
+               * @description Unique identifier for the invitation, also used as the invitation code.
+               */
+              id: string;
+              /**
+               * Format: uuid
+               * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+               */
+              ownerId: 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. An organization can only have one default invitation. */
+              isDefault?: boolean;
+              /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+              name: string;
+              /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+              description: string;
+              /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+              emails: string[];
+              /**
+               * Format: uuid
+               * @description ID of the organization to which the user is invited.
+               */
+              orgId: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+               */
+              expiresAt?: string;
+              /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+              quota?: number;
+              /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+              acceptedBy: string[];
+              /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+              roles: string[];
+              /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+              teams: string[];
+              /**
+               * @description Activation status of the invitation.
+               * @enum {string}
+               */
+              status: "enabled" | "disabled";
+              /**
+               * Format: date-time
+               * @description Timestamp when the invitation was created.
+               */
+              createdAt: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the invitation was last updated.
+               */
+              updatedAt: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the invitation was deleted, if applicable.
+               */
+              deletedAt: string;
+            }[];
+            /** @description Total number of invitations available. */
+            total: number;
+          };
+        };
+      };
+      /** 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;
+        };
+      };
+    };
+  };
+  createInvitation: {
+    responses: {
+      /** Invitation created */
+      201: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the invitation, also used as the invitation code.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+             */
+            ownerId: 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. An organization can only have one default invitation. */
+            isDefault?: boolean;
+            /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+            name: string;
+            /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+            description: string;
+            /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+            emails: string[];
+            /**
+             * Format: uuid
+             * @description ID of the organization to which the user is invited.
+             */
+            orgId: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+             */
+            expiresAt?: string;
+            /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+            quota?: number;
+            /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+            acceptedBy: string[];
+            /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+            roles: string[];
+            /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+            teams: string[];
+            /**
+             * @description Activation status of the invitation.
+             * @enum {string}
+             */
+            status: "enabled" | "disabled";
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was deleted, if applicable.
+             */
+            deletedAt: string;
+          };
+        };
+      };
+      /** 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;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          /**
+           * Format: uuid
+           * @description Existing invitation ID for updates; omit on create.
+           */
+          id?: string;
+          /**
+           * Format: uuid
+           * @description ID of the user who created the invitation.
+           */
+          ownerId?: string;
+          /** @description Indicates whether the invitation is a default invitation (open invite). */
+          isDefault?: boolean;
+          /** @description Name of the invitation. */
+          name: string;
+          /** @description Description of the invitation. */
+          description: string;
+          /** @description Email addresses or patterns this invitation is valid for. */
+          emails: string[];
+          /**
+           * Format: uuid
+           * @description ID of the organization to which the user is invited.
+           */
+          orgId: string;
+          /**
+           * Format: date-time
+           * @description Timestamp when the invitation expires, if applicable.
+           */
+          expiresAt?: string;
+          /** @description Quota for the invitation; limits the number of users that can accept it. */
+          quota?: number;
+          /** @description Roles that the user will have when accepting the invitation. */
+          roles: string[];
+          /** @description Teams that the user will be added to when accepting the invitation. */
+          teams: string[];
+          /**
+           * @description Activation status of the invitation.
+           * @enum {string}
+           */
+          status: "enabled" | "disabled";
+        };
+      };
+    };
+  };
+  acceptInvitation: {
+    parameters: {
+      path: {
+        /** The ID of the invitation. */
+        invitationId: string;
+      };
+    };
+    responses: {
+      /** Invitation accepted */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the invitation, also used as the invitation code.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
+             */
+            ownerId: 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. An organization can only have one default invitation. */
+            isDefault?: boolean;
+            /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
+            name: string;
+            /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
+            description: string;
+            /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
+            emails: string[];
+            /**
+             * Format: uuid
+             * @description ID of the organization to which the user is invited.
+             */
+            orgId: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
+             */
+            expiresAt?: string;
+            /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
+            quota?: number;
+            /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
+            acceptedBy: string[];
+            /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
+            roles: string[];
+            /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
+            teams: string[];
+            /**
+             * @description Activation status of the invitation.
+             * @enum {string}
+             */
+            status: "enabled" | "disabled";
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the invitation was deleted, if applicable.
+             */
+            deletedAt: string;
+          };
+        };
+      };
+      /** Invalid request body or request param */
+      400: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+  handleUserInvite: {
+    parameters: {
+      path: {
+        /** The ID of the organization. */
+        orgId: string;
+      };
+    };
+    responses: {
+      /** Invitation request accepted */
+      200: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** Invalid request body or request param */
+      400: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": { [key: string]: unknown };
+      };
+    };
+  };
+  getSignupRequests: {
+    parameters: {
+      query: {
+        /** Get responses by page */
+        page?: string;
+        /** Get responses by pagesize */
+        pagesize?: string;
+        /** Get responses that match search param value */
+        search?: string;
+        /** Get ordered responses */
+        order?: string;
+        /** Get filtered reponses */
+        filter?: string;
+      };
+    };
+    responses: {
+      /** Signup requests page */
+      200: {
+        content: {
+          "application/json": {
+            /** @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 Signup requests returned on the current page. */
+            data?: { [key: string]: unknown }[];
+          };
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+  signupRequest: {
+    responses: {
+      /** Signup request created */
+      201: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** 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;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": { [key: string]: unknown };
+      };
+    };
+  };
+  approveSignupRequest: {
+    responses: {
+      /** Signup request approved */
+      200: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** 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;
+        };
+      };
+    };
+  };
+  denySignupRequest: {
+    responses: {
+      /** Signup request denied */
+      200: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** 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;
+        };
+      };
+    };
+  };
+  getSignupRequestNotification: {
+    responses: {
+      /** Signup request notification payload */
+      200: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** No pending signup request notifications */
+      204: never;
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+}
+
+export interface external {}