@kasuvia/sdk 0.0.8 → 0.0.9

package/src/generated/media-openapi.ts

@@ -0,0 +1,613 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/api/v1/media/upload/presigned": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate presigned PUT URL for direct client upload to R2
+         * @description Generate a presigned PUT URL for direct client uploads to R2.
+         *
+         *     Flow:
+         *     1. Client calls this endpoint to get a presigned URL. A `MediaAsset` row is
+         *        created immediately with status="pending" and an `expires_at` — this is
+         *        what lets confirm-upload later verify the storage_path was actually
+         *        issued by this service (not guessed), and what the GC job sweeps if the
+         *        client never confirms.
+         *     2. Client uploads directly to R2 using the presigned URL.
+         *     3. Client calls /confirm-upload, which validates the real object and flips
+         *        this row to "processing"/"ready".
+         */
+        post: operations["generate_presigned_upload_url_api_v1_media_upload_presigned_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/media/confirm-upload": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Confirm direct upload and write metadata to database
+         * @description Called by client after successful direct upload to R2.
+         *
+         *     Trust boundary: `content_type`/`size` above are the client's claims and are
+         *     used only to select which context rules to check against and as an
+         *     idempotency/dedup aid — the actual persisted `file_type`/`size` always come
+         *     from the downloaded bytes. `storage_path` must match a `MediaAsset` row this
+         *     service created at presign time (status="pending"); a storage_path with no
+         *     such row is rejected outright rather than trusted, which also means a
+         *     confirm-upload call can never write a record for an object this service
+         *     didn't itself hand out a presigned URL for.
+         */
+        post: operations["confirm_upload_api_v1_media_confirm_upload_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/media/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List media assets for a business
+         * @description Return all (or filtered) media assets for ``business_id``, newest first.
+         *
+         *     Read access is public - no authentication required. However, if authenticated,
+         *     users can only access their own business's media assets.
+         */
+        get: operations["list_media_api_v1_media__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/media/{asset_id}/metadata": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Fetch metadata of a single media asset
+         * @description Returns JSON metadata for the specified asset_id.
+         *
+         *     For `digital_product`/`export` assets, `.url` is a freshly generated
+         *     presigned R2 GET URL (these assets are stored non-public — the raw
+         *     `r2_url` is not fetchable directly). For every other context, `.url`
+         *     is the same public R2 URL as `.r2_url`.
+         */
+        get: operations["get_media_by_id_api_v1_media__asset_id__metadata_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/media/{asset_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Permanently delete a media asset */
+        delete: operations["delete_media_api_v1_media__asset_id__delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Update alt text, description, or affiliation of an asset
+         * @description Partial update — only fields explicitly included in the JSON body are changed.
+         *     The file itself is never modified by this endpoint.
+         */
+        patch: operations["update_media_metadata_api_v1_media__asset_id__patch"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** Body_upload_export_csv_api_v1_media_upload_export_post */
+        Body_upload_export_csv_api_v1_media_upload_export_post: {
+            /** File */
+            file: string;
+        };
+        /** HTTPValidationError */
+        HTTPValidationError: {
+            /** Detail */
+            detail?: components["schemas"]["ValidationError"][];
+        };
+        /**
+         * MediaAssetResponse
+         * @description Full representation of a stored media asset returned to API consumers.
+         */
+        MediaAssetResponse: {
+            /**
+             * Id
+             * @description MongoDB document ID (string)
+             */
+            id: string;
+            /**
+             * Url
+             * @description Absolute public/signed URL to serve the asset
+             */
+            url: string;
+            /**
+             * Alt
+             * @description Accessibility alt text
+             */
+            alt?: string | null;
+            /**
+             * Description
+             * @description Contextual human-readable description
+             */
+            description?: string | null;
+            /**
+             * Filename
+             * @description Stored filename (UUID + extension)
+             */
+            filename: string;
+            /**
+             * Original Filename
+             * @description Original filename from the client
+             */
+            original_filename: string;
+            /**
+             * File Type
+             * @description MIME type, e.g. image/jpeg
+             */
+            file_type: string;
+            /**
+             * Size
+             * @description File size in bytes
+             */
+            size: number;
+            /**
+             * Storage Provider
+             * @description Storage backend: 'r2'
+             */
+            storage_provider: string;
+            /**
+             * R2 Url
+             * @description Direct Cloudflare R2 public URL
+             */
+            r2_url: string;
+            /**
+             * Bucket Name
+             * @description R2 bucket name
+             */
+            bucket_name: string;
+            /**
+             * Business Id
+             * @description Owning business UUID
+             */
+            business_id: string;
+            /**
+             * Affiliation
+             * @description Entity tag: Product | User | Business | Collection | Chat | General
+             */
+            affiliation: string;
+            /**
+             * Entity Type
+             * @description The context type (e.g. product, user, business)
+             */
+            entity_type: string;
+            /**
+             * Entity Id
+             * @description The ID of the entity this file belongs to
+             */
+            entity_id: string;
+            /**
+             * Status
+             * @description pending | processing | ready | failed
+             */
+            status: string;
+            /**
+             * Thumbnail Small Path
+             * @description R2 key of the small (150x150) derivative, once ready
+             */
+            thumbnail_small_path?: string | null;
+            /**
+             * Thumbnail Medium Path
+             * @description R2 key of the medium (300x300) derivative, once ready
+             */
+            thumbnail_medium_path?: string | null;
+            /**
+             * Thumbnail Large Path
+             * @description R2 key of the large (600x600) derivative, once ready
+             */
+            thumbnail_large_path?: string | null;
+            /**
+             * Uploaded By Name
+             * @description Friendly display name of the uploader
+             */
+            uploaded_by_name?: string | null;
+            /**
+             * Created At
+             * @description ISO 8601 creation timestamp
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * @description ISO 8601 last-update timestamp
+             */
+            updated_at: string;
+            /**
+             * Idempotency Key
+             * @description Logical key for intelligent replacement
+             */
+            idempotency_key?: string | null;
+        };
+        /**
+         * MediaAssetUpdate
+         * @description Partial update payload for PATCH /media/{asset_id}.
+         */
+        MediaAssetUpdate: {
+            /**
+             * Alt
+             * @description New alt text
+             */
+            alt?: string | null;
+            /**
+             * Description
+             * @description New description
+             */
+            description?: string | null;
+            /**
+             * Affiliation
+             * @description New affiliation tag (Product | User | Business | Collection | Runway | Chat | General)
+             */
+            affiliation?: string | null;
+        };
+        /**
+         * MediaUploadResponse
+         * @description URL-only response for upload endpoints. Simplifies frontend integration.
+         */
+        MediaUploadResponse: {
+            /**
+             * Url
+             * @description Absolute public/signed URL to serve the asset
+             */
+            url: string;
+        };
+        /**
+         * StorageStatsResponse
+         * @description Aggregated storage statistics for a single business.
+         */
+        StorageStatsResponse: {
+            /**
+             * Total Size
+             * @description Total bytes consumed across all assets
+             * @default 0
+             */
+            total_size: number;
+            /**
+             * Total Count
+             * @description Total number of stored assets
+             * @default 0
+             */
+            total_count: number;
+            /**
+             * Used Gb
+             * @description Storage used in GB (4 decimal places)
+             * @default 0
+             */
+            used_gb: number;
+            /**
+             * Limit Gb
+             * @description Storage quota in GB for this business's plan
+             * @default 5
+             */
+            limit_gb: number;
+            /**
+             * Breakdown
+             * @description Per-affiliation asset counts (canonical: Content, Product, Collection, Chat, BusinessOwner, Staff, Customer, General)
+             */
+            breakdown?: {
+                [key: string]: number;
+            };
+            /**
+             * Grouped Breakdown
+             * @description Grouped affiliation counts for logical categories: {"Content": 15, "Products": 42, "Collections": 8, "Chat": 5, "Users": 10, "General": 3}
+             */
+            grouped_breakdown?: {
+                [key: string]: number;
+            };
+        };
+        /** ValidationError */
+        ValidationError: {
+            /** Location */
+            loc: (string | number)[];
+            /** Message */
+            msg: string;
+            /** Error Type */
+            type: string;
+            /** Input */
+            input?: unknown;
+            /** Context */
+            ctx?: Record<string, never>;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    generate_presigned_upload_url_api_v1_media_upload_presigned_post: {
+        parameters: {
+            query: {
+                /** @description Original filename */
+                filename: string;
+                /** @description File content type (e.g., image/jpeg) */
+                content_type: string;
+                /** @description Business UUID */
+                business_id: string;
+                /** @description User UUID of uploader */
+                owner_id?: string | null;
+                /** @description Context type (e.g., product, collection, user_avatar) */
+                context: string;
+                /** @description Entity ID */
+                entity_id: string;
+                /** @description Entity tag */
+                affiliation?: string;
+                /** @description Alt text */
+                alt?: string | null;
+                /** @description Description */
+                description?: string | null;
+                /** @description Idempotency key */
+                idempotency_key?: string | null;
+                /** @description Client-reported file size in bytes — a hint for fast feedback only, re-validated against the real bytes at confirm-upload */
+                declared_size?: number;
+                /** @description URL expiration in seconds */
+                expires_in_seconds?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": Record<string, never>;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    confirm_upload_api_v1_media_confirm_upload_post: {
+        parameters: {
+            query: {
+                /** @description Storage key from presigned URL */
+                storage_path: string;
+                /** @description Business UUID */
+                business_id: string;
+                /** @description User UUID of uploader */
+                owner_id?: string | null;
+                /** @description Original filename */
+                original_filename: string;
+                /** @description File content type */
+                content_type: string;
+                /** @description File size in bytes */
+                size: number;
+                /** @description Context type */
+                context: string;
+                /** @description Entity ID */
+                entity_id: string;
+                /** @description Entity tag */
+                affiliation?: string;
+                /** @description Alt text */
+                alt?: string | null;
+                /** @description Description */
+                description?: string | null;
+                /** @description Idempotency key */
+                idempotency_key?: string | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MediaAssetResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    list_media_api_v1_media__get: {
+        parameters: {
+            query: {
+                /** @description UUID of the owning business */
+                business_id: string;
+                /** @description Filter by affiliation tag */
+                affiliation?: string | null;
+                skip?: number;
+                limit?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MediaAssetResponse"][];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_media_by_id_api_v1_media__asset_id__metadata_get: {
+        parameters: {
+            query?: {
+                /** @description For digital_product/export assets only: presigned URL lifetime. Defaults to 6 days, capped at R2/S3's 7-day maximum. */
+                expires_in_seconds?: number | null;
+            };
+            header?: never;
+            path: {
+                asset_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MediaAssetResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    delete_media_api_v1_media__asset_id__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                asset_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    update_media_metadata_api_v1_media__asset_id__patch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                asset_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["MediaAssetUpdate"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MediaAssetResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+}