@aviaryhq/cloudglue-js 0.3.1 → 0.3.3

package/dist/generated/Face_Detection.d.ts

@@ -0,0 +1,309 @@
+import { type ZodiosOptions } from "@zodios/core";
+import { z } from "zod";
+import { FaceBoundingBox } from "./common";
+import { FrameExtractionConfig } from "./common";
+type FaceDetection = {
+    face_detection_id: string;
+    frame_extraction_id?: string | undefined;
+    file_id?: string | undefined;
+    status: "pending" | "processing" | "completed" | "failed";
+    created_at: number;
+    data?: Partial<{
+        object: "list";
+        total: number;
+        limit: number;
+        offset: number;
+        faces: Array<DetectedFace>;
+    }> | undefined;
+};
+type FaceDetectionRequest = {
+    url: string;
+    frame_extraction_id?: string | undefined;
+    frame_extraction_config?: FrameExtractionConfig | undefined;
+};
+type DetectedFace = {
+    id: string;
+    face_bounding_box: FaceBoundingBox;
+    frame_id: string;
+    timestamp: number;
+    thumbnail_url?: string | undefined;
+};
+declare const FaceDetectionRequest: z.ZodType<FaceDetectionRequest>;
+declare const DetectedFace: z.ZodType<DetectedFace>;
+declare const FaceDetection: z.ZodType<FaceDetection>;
+export declare const schemas: {
+    FaceDetectionRequest: z.ZodType<FaceDetectionRequest, z.ZodTypeDef, FaceDetectionRequest>;
+    DetectedFace: z.ZodType<DetectedFace, z.ZodTypeDef, DetectedFace>;
+    FaceDetection: z.ZodType<FaceDetection, z.ZodTypeDef, FaceDetection>;
+};
+export declare const Face_DetectionApi: import("@zodios/core").ZodiosInstance<[{
+    method: "post";
+    path: "/face-detect";
+    alias: "createFaceDetection";
+    description: "Analyze video to detect all faces";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<FaceDetectionRequest, z.ZodTypeDef, FaceDetectionRequest>;
+    }];
+    response: z.ZodType<FaceDetection, z.ZodTypeDef, FaceDetection>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 429;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}, {
+    method: "get";
+    path: "/face-detect/:face_detection_id";
+    alias: "getFaceDetection";
+    description: "Retrieve face detection results including all detected faces";
+    requestFormat: "json";
+    parameters: [{
+        name: "face_detection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }, {
+        name: "limit";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "offset";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }];
+    response: z.ZodType<FaceDetection, z.ZodTypeDef, FaceDetection>;
+    errors: [{
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}, {
+    method: "delete";
+    path: "/face-detect/:face_detection_id";
+    alias: "deleteFaceDetection";
+    description: "Delete a specific face detection analysis";
+    requestFormat: "json";
+    parameters: [{
+        name: "face_detection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }];
+    response: z.ZodObject<{
+        id: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>;
+    errors: [{
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}]>;
+export declare function createApiClient(baseUrl: string, options?: ZodiosOptions): import("@zodios/core").ZodiosInstance<[{
+    method: "post";
+    path: "/face-detect";
+    alias: "createFaceDetection";
+    description: "Analyze video to detect all faces";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<FaceDetectionRequest, z.ZodTypeDef, FaceDetectionRequest>;
+    }];
+    response: z.ZodType<FaceDetection, z.ZodTypeDef, FaceDetection>;
+    errors: [{
+        status: 400;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 429;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}, {
+    method: "get";
+    path: "/face-detect/:face_detection_id";
+    alias: "getFaceDetection";
+    description: "Retrieve face detection results including all detected faces";
+    requestFormat: "json";
+    parameters: [{
+        name: "face_detection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }, {
+        name: "limit";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "offset";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }];
+    response: z.ZodType<FaceDetection, z.ZodTypeDef, FaceDetection>;
+    errors: [{
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}, {
+    method: "delete";
+    path: "/face-detect/:face_detection_id";
+    alias: "deleteFaceDetection";
+    description: "Delete a specific face detection analysis";
+    requestFormat: "json";
+    parameters: [{
+        name: "face_detection_id";
+        type: "Path";
+        schema: z.ZodString;
+    }];
+    response: z.ZodObject<{
+        id: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>;
+    errors: [{
+        status: 404;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }, {
+        status: 500;
+        description: string;
+        schema: z.ZodObject<{
+            error: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            error: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>;
+    }];
+}]>;
+export {};

package/dist/generated/Face_Detection.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Face_DetectionApi = exports.schemas = void 0;
+exports.createApiClient = createApiClient;
+const core_1 = require("@zodios/core");
+const zod_1 = require("zod");
+const common_1 = require("./common");
+const common_2 = require("./common");
+const FaceDetectionRequest = zod_1.z
+    .object({
+    url: zod_1.z.string(),
+    frame_extraction_id: zod_1.z.string().uuid().optional(),
+    frame_extraction_config: common_2.FrameExtractionConfig.optional(),
+})
+    .strict()
+    .passthrough();
+const DetectedFace = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid(),
+    face_bounding_box: common_1.FaceBoundingBox,
+    frame_id: zod_1.z.string().uuid(),
+    timestamp: zod_1.z.number(),
+    thumbnail_url: zod_1.z.string().optional(),
+})
+    .strict()
+    .passthrough();
+const FaceDetection = zod_1.z
+    .object({
+    face_detection_id: zod_1.z.string().uuid(),
+    frame_extraction_id: zod_1.z.string().uuid().optional(),
+    file_id: zod_1.z.string().uuid().optional(),
+    status: zod_1.z.enum(["pending", "processing", "completed", "failed"]),
+    created_at: zod_1.z.number(),
+    data: zod_1.z
+        .object({
+        object: zod_1.z.literal("list"),
+        total: zod_1.z.number().int(),
+        limit: zod_1.z.number().int().gte(1).lte(100),
+        offset: zod_1.z.number().int().gte(0),
+        faces: zod_1.z.array(DetectedFace),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
+})
+    .strict()
+    .passthrough();
+exports.schemas = {
+    FaceDetectionRequest,
+    DetectedFace,
+    FaceDetection,
+};
+const endpoints = (0, core_1.makeApi)([
+    {
+        method: "post",
+        path: "/face-detect",
+        alias: "createFaceDetection",
+        description: `Analyze video to detect all faces`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `Face detection request parameters`,
+                type: "Body",
+                schema: FaceDetectionRequest,
+            },
+        ],
+        response: FaceDetection,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request parameters or configuration`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Target video file not found`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 429,
+                description: `Monthly face detection jobs limit reached`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 500,
+                description: `An unexpected error occurred on the server`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+        ],
+    },
+    {
+        method: "get",
+        path: "/face-detect/:face_detection_id",
+        alias: "getFaceDetection",
+        description: `Retrieve face detection results including all detected faces`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "face_detection_id",
+                type: "Path",
+                schema: zod_1.z.string().uuid(),
+            },
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().gte(1).lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().gte(0).optional().default(0),
+            },
+        ],
+        response: FaceDetection,
+        errors: [
+            {
+                status: 404,
+                description: `Face detection job not found`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 500,
+                description: `An unexpected error occurred on the server`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+        ],
+    },
+    {
+        method: "delete",
+        path: "/face-detect/:face_detection_id",
+        alias: "deleteFaceDetection",
+        description: `Delete a specific face detection analysis`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "face_detection_id",
+                type: "Path",
+                schema: zod_1.z.string().uuid(),
+            },
+        ],
+        response: zod_1.z.object({ id: zod_1.z.string().uuid() }).strict().passthrough(),
+        errors: [
+            {
+                status: 404,
+                description: `Face detection job not found`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 500,
+                description: `An unexpected error occurred on the server`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+        ],
+    },
+]);
+exports.Face_DetectionApi = new core_1.Zodios("https://api.cloudglue.dev/v1", endpoints);
+function createApiClient(baseUrl, options) {
+    return new core_1.Zodios(baseUrl, endpoints, options);
+}