@meshery/schemas 1.3.60 → 1.3.62

package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.d.ts

@@ -0,0 +1,784 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/api/blowhorn/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Blowhorn run records
+         * @description Returns a paginated list of Blowhorn run records in the organization of the authenticated session.
+         */
+        get: operations["listBlowhornRunRecords"];
+        put?: never;
+        /**
+         * Append Blowhorn run record
+         * @description Appends a run record to the ledger, replaying idempotently on the
+         *     (runId, kind, ts, profile, platform) tuple: replaying an existing
+         *     tuple returns the stored record unchanged. Ownership is derived
+         *     from the authenticated session; any client-supplied owner is
+         *     ignored.
+         */
+        post: operations["appendBlowhornRunRecord"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/blowhorn/analytics": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Blowhorn analytics
+         * @description Returns a paginated list of Blowhorn analytics rollups in the organization of the authenticated session.
+         */
+        get: operations["listBlowhornAnalytics"];
+        put?: never;
+        /**
+         * Record Blowhorn analytics
+         * @description Records an analytics rollup, replacing the stored metrics for the
+         *     (scope, window) pair. Ownership is derived from the authenticated
+         *     session; any client-supplied owner is ignored.
+         */
+        post: operations["recordBlowhornAnalytics"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * Blowhorn Run Record Schema
+         * @description Server-returned Blowhorn run record as persisted by meshery-cloud. Run
+         *     records form an append-only ledger: appends replay idempotently on the
+         *     (runId, kind, ts, profile, platform) tuple. The local spool stays on the
+         *     machine; only the append crosses the API. Writers also emit Cloud events
+         *     so the organization audit trail sees publishes without a second read
+         *     path.
+         */
+        BlowhornRunRecord: {
+            /**
+             * Format: uuid
+             * @description Server-generated Blowhorn run record ID.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+             */
+            organizationId: string;
+            /** @description Run identifier grouping the records of one execution. */
+            runId: string;
+            /** @description Record kind within the run. */
+            kind: string;
+            /**
+             * Format: date-time
+             * @description Event time of the record within the run. Part of the idempotency tuple.
+             */
+            ts: string;
+            /** @description Subject of the profile the record concerns. */
+            profile?: string;
+            /** @description Platform the record concerns (e.g. linkedin). */
+            platform?: string;
+            /** @description Record values, stored as a JSON blob. */
+            data?: Record<string, never>;
+            /**
+             * Format: date-time
+             * @description Timestamp of Blowhorn run record creation.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of last Blowhorn run record modification.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the Blowhorn run record was soft-deleted.
+             */
+            deletedAt?: string | null;
+        };
+        /**
+         * Blowhorn Analytics Schema
+         * @description Server-returned Blowhorn analytics rollup as persisted by
+         *     meshery-cloud. Analytics rows aggregate run records per scope and
+         *     window; recording the same (scope, window) pair replaces the stored
+         *     metrics.
+         */
+        BlowhornAnalytics: {
+            /**
+             * Format: uuid
+             * @description Server-generated Blowhorn analytics ID.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+             */
+            organizationId: string;
+            /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+            scope: string;
+            /** @description Aggregation window the metrics cover (e.g. day, week). */
+            window?: string;
+            /** @description Aggregated metrics, stored as a JSON blob. */
+            metrics: Record<string, never>;
+            /**
+             * Format: date-time
+             * @description Time the metrics were computed.
+             */
+            computedAt?: string | null;
+            /**
+             * Format: date-time
+             * @description Timestamp of Blowhorn analytics creation.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of last Blowhorn analytics modification.
+             */
+            updatedAt: string;
+        };
+        /**
+         * @description Payload for appending a Blowhorn run record. Contains only
+         *     client-settable fields; the owning `organizationId` (derived from
+         *     the authenticated session) and the server-generated `createdAt` /
+         *     `updatedAt` timestamps are intentionally excluded.
+         */
+        BlowhornRunRecordPayload: {
+            /**
+             * Format: uuid
+             * @description Existing Blowhorn run record ID; omit on append.
+             */
+            id?: string;
+            /** @description Run identifier grouping the records of one execution. */
+            runId: string;
+            /** @description Record kind within the run. */
+            kind: string;
+            /**
+             * Format: date-time
+             * @description Event time of the record within the run. Part of the idempotency tuple.
+             */
+            ts: string;
+            /** @description Subject of the profile the record concerns. */
+            profile?: string;
+            /** @description Platform the record concerns (e.g. linkedin). */
+            platform?: string;
+            /** @description Record values, stored as a JSON blob. */
+            data?: Record<string, never>;
+        };
+        /**
+         * @description Payload for recording a Blowhorn analytics rollup. Contains only
+         *     client-settable fields; the owning `organizationId` (derived from
+         *     the authenticated session) and the server-generated `createdAt` /
+         *     `updatedAt` timestamps are intentionally excluded.
+         */
+        BlowhornAnalyticsPayload: {
+            /**
+             * Format: uuid
+             * @description Existing Blowhorn analytics ID for updates; omit on record.
+             */
+            id?: string;
+            /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+            scope: string;
+            /** @description Aggregation window the metrics cover (e.g. day, week). */
+            window?: string;
+            /** @description Aggregated metrics, stored as a JSON blob. */
+            metrics: Record<string, never>;
+            /**
+             * Format: date-time
+             * @description Time the metrics were computed.
+             */
+            computedAt?: string;
+        };
+        /** @description Paginated collection of Blowhorn run records. */
+        BlowhornRunRecordPage: {
+            /** @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 run records included on this page of results. */
+            blowhornRunRecords?: {
+                /**
+                 * Format: uuid
+                 * @description Server-generated Blowhorn run record ID.
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                 */
+                organizationId: string;
+                /** @description Run identifier grouping the records of one execution. */
+                runId: string;
+                /** @description Record kind within the run. */
+                kind: string;
+                /**
+                 * Format: date-time
+                 * @description Event time of the record within the run. Part of the idempotency tuple.
+                 */
+                ts: string;
+                /** @description Subject of the profile the record concerns. */
+                profile?: string;
+                /** @description Platform the record concerns (e.g. linkedin). */
+                platform?: string;
+                /** @description Record values, stored as a JSON blob. */
+                data?: Record<string, never>;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of Blowhorn run record creation.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of last Blowhorn run record modification.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the Blowhorn run record was soft-deleted.
+                 */
+                deletedAt?: string | null;
+            }[];
+        };
+        /** @description Paginated collection of Blowhorn analytics rollups. */
+        BlowhornAnalyticsPage: {
+            /** @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 analytics rollups included on this page of results. */
+            blowhornAnalytics?: {
+                /**
+                 * Format: uuid
+                 * @description Server-generated Blowhorn analytics ID.
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                 */
+                organizationId: string;
+                /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+                scope: string;
+                /** @description Aggregation window the metrics cover (e.g. day, week). */
+                window?: string;
+                /** @description Aggregated metrics, stored as a JSON blob. */
+                metrics: Record<string, never>;
+                /**
+                 * Format: date-time
+                 * @description Time the metrics were computed.
+                 */
+                computedAt?: string | null;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of Blowhorn analytics creation.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of last Blowhorn analytics modification.
+                 */
+                updatedAt: string;
+            }[];
+        };
+    };
+    responses: {
+        /** @description Invalid request body or request param */
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Expired JWT token used or insufficient privilege */
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Result not found */
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Internal server error */
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @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 {
+    listBlowhornRunRecords: {
+        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;
+                /** @description Filter by run identifier. */
+                runId?: string;
+                /** @description Filter by record kind. */
+                kind?: string;
+                /** @description Filter by profile subject. */
+                profile?: string;
+                /** @description Filter by platform (e.g. linkedin). */
+                platform?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn run records 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 run records included on this page of results. */
+                        blowhornRunRecords?: {
+                            /**
+                             * Format: uuid
+                             * @description Server-generated Blowhorn run record ID.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                             */
+                            organizationId: string;
+                            /** @description Run identifier grouping the records of one execution. */
+                            runId: string;
+                            /** @description Record kind within the run. */
+                            kind: string;
+                            /**
+                             * Format: date-time
+                             * @description Event time of the record within the run. Part of the idempotency tuple.
+                             */
+                            ts: string;
+                            /** @description Subject of the profile the record concerns. */
+                            profile?: string;
+                            /** @description Platform the record concerns (e.g. linkedin). */
+                            platform?: string;
+                            /** @description Record values, stored as a JSON blob. */
+                            data?: Record<string, never>;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of Blowhorn run record creation.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of last Blowhorn run record modification.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the Blowhorn run record 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;
+                };
+            };
+        };
+    };
+    appendBlowhornRunRecord: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn run record ID; omit on append.
+                     */
+                    id?: string;
+                    /** @description Run identifier grouping the records of one execution. */
+                    runId: string;
+                    /** @description Record kind within the run. */
+                    kind: string;
+                    /**
+                     * Format: date-time
+                     * @description Event time of the record within the run. Part of the idempotency tuple.
+                     */
+                    ts: string;
+                    /** @description Subject of the profile the record concerns. */
+                    profile?: string;
+                    /** @description Platform the record concerns (e.g. linkedin). */
+                    platform?: string;
+                    /** @description Record values, stored as a JSON blob. */
+                    data?: Record<string, never>;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn run record appended */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn run record ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Run identifier grouping the records of one execution. */
+                        runId: string;
+                        /** @description Record kind within the run. */
+                        kind: string;
+                        /**
+                         * Format: date-time
+                         * @description Event time of the record within the run. Part of the idempotency tuple.
+                         */
+                        ts: string;
+                        /** @description Subject of the profile the record concerns. */
+                        profile?: string;
+                        /** @description Platform the record concerns (e.g. linkedin). */
+                        platform?: string;
+                        /** @description Record values, stored as a JSON blob. */
+                        data?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn run record creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn run record modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn run record 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;
+                };
+            };
+        };
+    };
+    listBlowhornAnalytics: {
+        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;
+                /** @description Filter by aggregation scope. */
+                scope?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn analytics 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 analytics rollups included on this page of results. */
+                        blowhornAnalytics?: {
+                            /**
+                             * Format: uuid
+                             * @description Server-generated Blowhorn analytics ID.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                             */
+                            organizationId: string;
+                            /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+                            scope: string;
+                            /** @description Aggregation window the metrics cover (e.g. day, week). */
+                            window?: string;
+                            /** @description Aggregated metrics, stored as a JSON blob. */
+                            metrics: Record<string, never>;
+                            /**
+                             * Format: date-time
+                             * @description Time the metrics were computed.
+                             */
+                            computedAt?: string | null;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of Blowhorn analytics creation.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of last Blowhorn analytics modification.
+                             */
+                            updatedAt: 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;
+                };
+            };
+        };
+    };
+    recordBlowhornAnalytics: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn analytics ID for updates; omit on record.
+                     */
+                    id?: string;
+                    /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+                    scope: string;
+                    /** @description Aggregation window the metrics cover (e.g. day, week). */
+                    window?: string;
+                    /** @description Aggregated metrics, stored as a JSON blob. */
+                    metrics: Record<string, never>;
+                    /**
+                     * Format: date-time
+                     * @description Time the metrics were computed.
+                     */
+                    computedAt?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn analytics recorded */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn analytics ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Aggregation scope (e.g. profile subject or organization-wide rollup name). */
+                        scope: string;
+                        /** @description Aggregation window the metrics cover (e.g. day, week). */
+                        window?: string;
+                        /** @description Aggregated metrics, stored as a JSON blob. */
+                        metrics: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Time the metrics were computed.
+                         */
+                        computedAt?: string | null;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn analytics creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn analytics modification.
+                         */
+                        updatedAt: string;
+                    };
+                };
+            };
+            /** @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;
+                };
+            };
+        };
+    };
+}