@meshery/schemas 1.3.60 → 1.3.62

package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.d.ts

@@ -0,0 +1,776 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/api/blowhorn/profiles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Blowhorn profiles
+         * @description Returns a paginated list of Blowhorn profiles in the organization of the authenticated session.
+         */
+        get: operations["listBlowhornProfiles"];
+        put?: never;
+        /**
+         * Upsert Blowhorn profile
+         * @description Creates a new Blowhorn profile when no `id` is supplied, or
+         *     updates the entry matching the provided `id`. Ownership is
+         *     derived from the authenticated session; any client-supplied
+         *     owner is ignored. Slug renames are guarded server-side.
+         */
+        post: operations["upsertBlowhornProfile"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/blowhorn/profiles/by-subject": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Blowhorn profile by subject
+         * @description Returns the Blowhorn profile keyed by the given subject within the organization of the authenticated session.
+         */
+        get: operations["getBlowhornProfileBySubject"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/blowhorn/profiles/{blowhornProfileId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Blowhorn profile by ID */
+        get: operations["getBlowhornProfile"];
+        /**
+         * Update Blowhorn profile
+         * @description Updates the Blowhorn profile matching the path ID. Slug renames are guarded server-side.
+         */
+        put: operations["updateBlowhornProfile"];
+        post?: never;
+        /**
+         * Delete Blowhorn profile
+         * @description Soft-deletes the Blowhorn profile.
+         */
+        delete: operations["deleteBlowhornProfile"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * Blowhorn Profile Schema
+         * @description Server-returned Blowhorn profile as persisted by meshery-cloud. A profile
+         *     binds a subject to a slug with free-form attributes, scoped by
+         *     organization and keyed by subject. Subject-to-slug resolution stays
+         *     Blowhorn-side; organization, user and team identity are reused from the
+         *     existing constructs. Profiles soft-delete, and renames are guarded
+         *     server-side.
+         */
+        BlowhornProfile: {
+            /**
+             * Format: uuid
+             * @description Server-generated Blowhorn profile ID.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+             */
+            organizationId: string;
+            /** @description Subject the profile is keyed by. */
+            subject: string;
+            /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+            slug: string;
+            /** @description Free-form profile attributes, stored as a JSON blob. */
+            attributes?: Record<string, never>;
+            /**
+             * Format: date-time
+             * @description Timestamp of Blowhorn profile creation.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of last Blowhorn profile modification.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the Blowhorn profile was soft-deleted.
+             */
+            deletedAt?: string | null;
+        };
+        /**
+         * @description Payload for creating or updating a Blowhorn profile. Contains
+         *     only client-settable fields; the owning `organizationId` (derived
+         *     from the authenticated session) and the server-generated
+         *     `createdAt` / `updatedAt` timestamps are intentionally excluded.
+         */
+        BlowhornProfilePayload: {
+            /**
+             * Format: uuid
+             * @description Existing Blowhorn profile ID for updates; omit on create.
+             */
+            id?: string;
+            /** @description Subject the profile is keyed by. */
+            subject: string;
+            /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+            slug: string;
+            /** @description Free-form profile attributes, stored as a JSON blob. */
+            attributes?: Record<string, never>;
+        };
+        /** @description Paginated collection of Blowhorn profiles. */
+        BlowhornProfilePage: {
+            /** @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 Blowhorn profiles included on this page of results. */
+            blowhornProfiles?: {
+                /**
+                 * Format: uuid
+                 * @description Server-generated Blowhorn profile ID.
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                 */
+                organizationId: string;
+                /** @description Subject the profile is keyed by. */
+                subject: string;
+                /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                slug: string;
+                /** @description Free-form profile attributes, stored as a JSON blob. */
+                attributes?: Record<string, never>;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of Blowhorn profile creation.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of last Blowhorn profile modification.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the Blowhorn profile was soft-deleted.
+                 */
+                deletedAt?: string | null;
+            }[];
+        };
+    };
+    responses: {
+        /** @description Invalid request body or request param */
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Expired JWT token used or insufficient privilege */
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Result not found */
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Internal server error */
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description Blowhorn profile ID */
+        blowhornProfileId: string;
+        /** @description Get responses by page */
+        page: number;
+        /** @description Number of items per page (canonical camelCase form). */
+        pageSize: number;
+        /**
+         * @deprecated
+         * @description Number of items per page. Deprecated alias of pageSize;
+         *     canonical `pageSize` wins when both are present.
+         */
+        pagesize: number;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    listBlowhornProfiles: {
+        parameters: {
+            query?: {
+                /** @description Get responses by page */
+                page?: number;
+                /** @description Number of items per page (canonical camelCase form). */
+                pageSize?: number;
+                /**
+                 * @deprecated
+                 * @description Number of items per page. Deprecated alias of pageSize;
+                 *     canonical `pageSize` wins when both are present.
+                 */
+                pagesize?: number;
+                /** @description Get responses that match search param value */
+                search?: string;
+                /** @description Get ordered responses */
+                order?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn profiles page */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                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 Blowhorn profiles included on this page of results. */
+                        blowhornProfiles?: {
+                            /**
+                             * Format: uuid
+                             * @description Server-generated Blowhorn profile ID.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                             */
+                            organizationId: string;
+                            /** @description Subject the profile is keyed by. */
+                            subject: string;
+                            /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                            slug: string;
+                            /** @description Free-form profile attributes, stored as a JSON blob. */
+                            attributes?: Record<string, never>;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of Blowhorn profile creation.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of last Blowhorn profile modification.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the Blowhorn profile was soft-deleted.
+                             */
+                            deletedAt?: string | null;
+                        }[];
+                    };
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    upsertBlowhornProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn profile ID for updates; omit on create.
+                     */
+                    id?: string;
+                    /** @description Subject the profile is keyed by. */
+                    subject: string;
+                    /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                    slug: string;
+                    /** @description Free-form profile attributes, stored as a JSON blob. */
+                    attributes?: Record<string, never>;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn profile saved */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn profile ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject the profile is keyed by. */
+                        subject: string;
+                        /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                        slug: string;
+                        /** @description Free-form profile attributes, stored as a JSON blob. */
+                        attributes?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn profile creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn profile modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn profile was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    getBlowhornProfileBySubject: {
+        parameters: {
+            query: {
+                /** @description Subject the profile is keyed by. */
+                subject: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn profile response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn profile ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject the profile is keyed by. */
+                        subject: string;
+                        /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                        slug: string;
+                        /** @description Free-form profile attributes, stored as a JSON blob. */
+                        attributes?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn profile creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn profile modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn profile was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    getBlowhornProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn profile ID */
+                blowhornProfileId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn profile response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn profile ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject the profile is keyed by. */
+                        subject: string;
+                        /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                        slug: string;
+                        /** @description Free-form profile attributes, stored as a JSON blob. */
+                        attributes?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn profile creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn profile modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn profile was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    updateBlowhornProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn profile ID */
+                blowhornProfileId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn profile ID for updates; omit on create.
+                     */
+                    id?: string;
+                    /** @description Subject the profile is keyed by. */
+                    subject: string;
+                    /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                    slug: string;
+                    /** @description Free-form profile attributes, stored as a JSON blob. */
+                    attributes?: Record<string, never>;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn profile updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn profile ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject the profile is keyed by. */
+                        subject: string;
+                        /** @description Unique slug for the profile within the organization. Renames are guarded server-side. */
+                        slug: string;
+                        /** @description Free-form profile attributes, stored as a JSON blob. */
+                        attributes?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn profile creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn profile modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn profile was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    deleteBlowhornProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn profile ID */
+                blowhornProfileId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn profile deleted */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}