@meshery/schemas 0.8.107 → 0.8.108

package/dist/constructs/v1beta1/user/User.d.mts

@@ -0,0 +1,473 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+}
+interface components {
+    schemas: {
+        /** @description Represents a user in Layer5 Cloud (Meshery) */
+        User: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the user
+             */
+            id: string;
+            /** @description User identifier (username or external ID) */
+            user_id: string;
+            /**
+             * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
+             * @example [
+             *   "local",
+             *   "github",
+             *   "google",
+             *   "twitter"
+             * ]
+             */
+            provider: string;
+            /**
+             * Format: email
+             * @description User's email address
+             */
+            email: string;
+            /** @description User's first name */
+            first_name: string;
+            /** @description User's last name */
+            last_name: string;
+            /**
+             * Format: uri
+             * @description URL to user's avatar image
+             */
+            avatar_url?: string;
+            /**
+             * @description User account status
+             * @enum {string}
+             */
+            status: "active" | "inactive" | "pending" | "anonymous";
+            /**
+             * @description User's biography or description
+             * @default
+             */
+            bio?: string;
+            /** @description User's country information stored as JSONB */
+            country?: {
+                [key: string]: unknown;
+            };
+            /** @description User's region information stored as JSONB */
+            region?: {
+                [key: string]: unknown;
+            };
+            /** @description User preferences stored as JSONB */
+            preferences?: {
+                meshAdapters?: {
+                    [key: string]: unknown;
+                }[];
+                grafana?: {
+                    grafanaURL?: string;
+                    grafanaAPIKey?: string;
+                    selectedBoardsConfigs?: {
+                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                        board?: {
+                            [key: string]: unknown;
+                        };
+                        panels?: {
+                            [key: string]: unknown;
+                        }[];
+                        templateVars?: string[];
+                    }[];
+                };
+                prometheus?: {
+                    prometheusURL?: string;
+                    selectedPrometheusBoardsConfigs?: {
+                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                        board?: {
+                            [key: string]: unknown;
+                        };
+                        panels?: {
+                            [key: string]: unknown;
+                        }[];
+                        templateVars?: string[];
+                    }[];
+                };
+                loadTestPrefs?: {
+                    /** @description Concurrent requests */
+                    c?: number;
+                    /** @description Queries per second */
+                    qps?: number;
+                    /** @description Duration */
+                    t?: string;
+                    /** @description Load generator */
+                    gen?: string;
+                };
+                anonymousUsageStats: boolean;
+                anonymousPerfResults: boolean;
+                /** Format: date-time */
+                updated_at?: string;
+                dashboardPreferences: {
+                    [key: string]: unknown;
+                };
+                selectedOrganizationID: string;
+                selectedWorkspaceForOrganizations: {
+                    [key: string]: string;
+                };
+                usersExtensionPreferences: {
+                    [key: string]: unknown;
+                };
+                remoteProviderPreferences?: {
+                    [key: string]: unknown;
+                };
+            } & {
+                updatedAt: unknown;
+                RemoteProviderPreferences: unknown;
+            };
+            /**
+             * Format: date-time
+             * @description Timestamp when user accepted terms and conditions
+             */
+            accepted_terms_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of user's first login
+             */
+            first_login_time?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of user's most recent login
+             */
+            last_login_time: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was created
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was last updated
+             */
+            updated_at: string;
+            /** @description Various online profiles associated with the user account */
+            socials?: {
+                site: string;
+                /** Format: uri */
+                link: string;
+            }[];
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was soft-deleted (null if not deleted)
+             */
+            deleted_at: string | null;
+        };
+        /** @description Response schema for getting user information, includes user data with roles, teams, and organizations */
+        GetUserResponse: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the user
+             */
+            id: string;
+            /** @description User identifier (username or external ID) */
+            user_id: string;
+            /**
+             * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
+             * @example [
+             *   "local",
+             *   "github",
+             *   "google",
+             *   "twitter"
+             * ]
+             */
+            provider: string;
+            /**
+             * Format: email
+             * @description User's email address
+             */
+            email: string;
+            /** @description User's first name */
+            first_name: string;
+            /** @description User's last name */
+            last_name: string;
+            /**
+             * Format: uri
+             * @description URL to user's avatar image
+             */
+            avatar_url?: string;
+            /**
+             * @description User account status
+             * @enum {string}
+             */
+            status: "active" | "inactive" | "pending" | "anonymous";
+            /**
+             * @description User's biography or description
+             * @default
+             */
+            bio?: string;
+            /** @description User's country information stored as JSONB */
+            country?: {
+                [key: string]: unknown;
+            };
+            /** @description User's region information stored as JSONB */
+            region?: {
+                [key: string]: unknown;
+            };
+            /** @description User preferences stored as JSONB */
+            preferences?: {
+                meshAdapters?: {
+                    [key: string]: unknown;
+                }[];
+                grafana?: {
+                    grafanaURL?: string;
+                    grafanaAPIKey?: string;
+                    selectedBoardsConfigs?: {
+                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                        board?: {
+                            [key: string]: unknown;
+                        };
+                        panels?: {
+                            [key: string]: unknown;
+                        }[];
+                        templateVars?: string[];
+                    }[];
+                };
+                prometheus?: {
+                    prometheusURL?: string;
+                    selectedPrometheusBoardsConfigs?: {
+                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                        board?: {
+                            [key: string]: unknown;
+                        };
+                        panels?: {
+                            [key: string]: unknown;
+                        }[];
+                        templateVars?: string[];
+                    }[];
+                };
+                loadTestPrefs?: {
+                    /** @description Concurrent requests */
+                    c?: number;
+                    /** @description Queries per second */
+                    qps?: number;
+                    /** @description Duration */
+                    t?: string;
+                    /** @description Load generator */
+                    gen?: string;
+                };
+                anonymousUsageStats: boolean;
+                anonymousPerfResults: boolean;
+                /** Format: date-time */
+                updated_at?: string;
+                dashboardPreferences: {
+                    [key: string]: unknown;
+                };
+                selectedOrganizationID: string;
+                selectedWorkspaceForOrganizations: {
+                    [key: string]: string;
+                };
+                usersExtensionPreferences: {
+                    [key: string]: unknown;
+                };
+                remoteProviderPreferences?: {
+                    [key: string]: unknown;
+                };
+            } & {
+                updatedAt: unknown;
+                RemoteProviderPreferences: unknown;
+            };
+            /**
+             * Format: date-time
+             * @description Timestamp when user accepted terms and conditions
+             */
+            accepted_terms_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of user's first login
+             */
+            first_login_time?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of user's most recent login
+             */
+            last_login_time: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was created
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was last updated
+             */
+            updated_at: string;
+            /** @description Various online profiles associated with the user account */
+            socials?: {
+                site: string;
+                /** Format: uri */
+                link: string;
+            }[];
+            /**
+             * Format: date-time
+             * @description Timestamp when the user record was soft-deleted (null if not deleted)
+             */
+            deleted_at: string | null;
+        } & {
+            /**
+             * @description List of global roles assigned to the user
+             * @example [
+             *   [
+             *     "admin",
+             *     "meshmap"
+             *   ],
+             *   [
+             *     "user"
+             *   ]
+             * ]
+             */
+            role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
+            /** @description Teams the user belongs to with role information */
+            teams?: {
+                teams_with_roles?: {
+                    [key: string]: unknown;
+                }[];
+                total_count?: number;
+            };
+            /** @description Organizations the user belongs to with role information */
+            organizations?: {
+                organizations_with_roles?: {
+                    [key: string]: unknown;
+                }[];
+                total_count?: number;
+            };
+        };
+        Preference: {
+            meshAdapters?: {
+                [key: string]: unknown;
+            }[];
+            grafana?: {
+                grafanaURL?: string;
+                grafanaAPIKey?: string;
+                selectedBoardsConfigs?: {
+                    /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                    board?: {
+                        [key: string]: unknown;
+                    };
+                    panels?: {
+                        [key: string]: unknown;
+                    }[];
+                    templateVars?: string[];
+                }[];
+            };
+            prometheus?: {
+                prometheusURL?: string;
+                selectedPrometheusBoardsConfigs?: {
+                    /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                    board?: {
+                        [key: string]: unknown;
+                    };
+                    panels?: {
+                        [key: string]: unknown;
+                    }[];
+                    templateVars?: string[];
+                }[];
+            };
+            loadTestPrefs?: {
+                /** @description Concurrent requests */
+                c?: number;
+                /** @description Queries per second */
+                qps?: number;
+                /** @description Duration */
+                t?: string;
+                /** @description Load generator */
+                gen?: string;
+            };
+            anonymousUsageStats: boolean;
+            anonymousPerfResults: boolean;
+            /** Format: date-time */
+            updated_at?: string;
+            dashboardPreferences: {
+                [key: string]: unknown;
+            };
+            selectedOrganizationID: string;
+            selectedWorkspaceForOrganizations: {
+                [key: string]: string;
+            };
+            usersExtensionPreferences: {
+                [key: string]: unknown;
+            };
+            remoteProviderPreferences?: {
+                [key: string]: unknown;
+            };
+        } & {
+            updatedAt: unknown;
+            RemoteProviderPreferences: unknown;
+        };
+        /** @description Placeholder for Adapter struct definition. */
+        Adapter: {
+            [key: string]: unknown;
+        };
+        Grafana: {
+            grafanaURL?: string;
+            grafanaAPIKey?: string;
+            selectedBoardsConfigs?: {
+                /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                board?: {
+                    [key: string]: unknown;
+                };
+                panels?: {
+                    [key: string]: unknown;
+                }[];
+                templateVars?: string[];
+            }[];
+        };
+        SelectedGrafanaConfig: {
+            /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+            board?: {
+                [key: string]: unknown;
+            };
+            panels?: {
+                [key: string]: unknown;
+            }[];
+            templateVars?: string[];
+        };
+        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+        GrafanaBoard: {
+            [key: string]: unknown;
+        };
+        /** @description Grafana panel structure imported from github.com/grafana-tools/sdk */
+        Panel: {
+            [key: string]: unknown;
+        };
+        Prometheus: {
+            prometheusURL?: string;
+            selectedPrometheusBoardsConfigs?: {
+                /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                board?: {
+                    [key: string]: unknown;
+                };
+                panels?: {
+                    [key: string]: unknown;
+                }[];
+                templateVars?: string[];
+            }[];
+        };
+        LoadTestPreferences: {
+            /** @description Concurrent requests */
+            c?: number;
+            /** @description Queries per second */
+            qps?: number;
+            /** @description Duration */
+            t?: string;
+            /** @description Load generator */
+            gen?: string;
+        };
+        /** @description Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on. */
+        Social: {
+            site: string;
+            /** Format: uri */
+            link: string;
+        };
+    };
+}
+interface operations {
+}
+interface external {
+}
+
+export type { components, external, operations, paths };