@aviaryhq/cloudglue-js 0.0.9

package/dist/generated/Collections.js

@@ -0,0 +1,666 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionsApi = exports.schemas = void 0;
+exports.createApiClient = createApiClient;
+const core_1 = require("@zodios/core");
+const zod_1 = require("zod");
+const common_1 = require("./common");
+const Collection = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal("collection"),
+    name: zod_1.z.string(),
+    description: zod_1.z.union([zod_1.z.string(), zod_1.z.null()]).optional(),
+    describe_config: zod_1.z
+        .object({
+        enable_speech: zod_1.z.boolean().default(true),
+        enable_scene_text: zod_1.z.boolean().default(true),
+        enable_visual_scene_description: zod_1.z.boolean().default(true),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
+    extract_config: zod_1.z
+        .object({
+        prompt: zod_1.z.string(),
+        schema: zod_1.z.object({}).partial().strict().passthrough(),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
+    created_at: zod_1.z.number().int(),
+    file_count: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+const CollectionList = zod_1.z
+    .object({
+    object: zod_1.z.literal("list"),
+    data: zod_1.z.array(Collection),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+const CollectionFile = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    object: zod_1.z.literal("collection_file"),
+    added_at: zod_1.z.number().int(),
+    status: zod_1.z.enum([
+        "pending",
+        "processing",
+        "ready",
+        "completed",
+        "failed",
+        "not_applicable",
+    ]),
+    describe_status: zod_1.z
+        .enum([
+        "pending",
+        "processing",
+        "ready",
+        "completed",
+        "failed",
+        "not_applicable",
+    ])
+        .optional(),
+    extract_status: zod_1.z
+        .enum([
+        "pending",
+        "processing",
+        "ready",
+        "completed",
+        "failed",
+        "not_applicable",
+    ])
+        .optional(),
+    searchable_status: zod_1.z
+        .enum([
+        "pending",
+        "processing",
+        "ready",
+        "completed",
+        "failed",
+        "not_applicable",
+    ])
+        .optional(),
+    file: common_1.File.optional(),
+})
+    .strict()
+    .passthrough();
+const CollectionFileList = zod_1.z
+    .object({
+    object: zod_1.z.literal("list"),
+    data: zod_1.z.array(CollectionFile),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+const NewCollection = zod_1.z
+    .object({
+    name: zod_1.z.string(),
+    description: zod_1.z.union([zod_1.z.string(), zod_1.z.null()]).optional(),
+    describe_config: zod_1.z
+        .object({
+        enable_speech: zod_1.z.boolean().default(true),
+        enable_scene_text: zod_1.z.boolean().default(true),
+        enable_visual_scene_description: zod_1.z.boolean().default(true),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
+    extract_config: zod_1.z
+        .object({
+        prompt: zod_1.z.string(),
+        schema: zod_1.z.object({}).partial().strict().passthrough(),
+    })
+        .partial()
+        .strict()
+        .passthrough()
+        .optional(),
+})
+    .strict()
+    .passthrough();
+const CollectionDelete = zod_1.z
+    .object({ id: zod_1.z.string(), object: zod_1.z.literal("collection") })
+    .strict()
+    .passthrough();
+const CollectionFileDelete = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    object: zod_1.z.literal("collection_file"),
+})
+    .strict()
+    .passthrough();
+const FileEntities = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    entities: zod_1.z.union([
+        zod_1.z.object({}).partial().strict().passthrough(),
+        zod_1.z.array(zod_1.z.any()),
+    ]),
+    segment_entities: zod_1.z
+        .array(zod_1.z
+        .object({
+        segment_id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+        entities: zod_1.z.object({}).partial().strict().passthrough(),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+const FileDescription = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    title: zod_1.z.string().optional(),
+    summary: zod_1.z.string().optional(),
+    segment_docs: zod_1.z
+        .array(zod_1.z
+        .object({
+        segment_id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+        title: zod_1.z.string(),
+        summary: zod_1.z.string(),
+        visual_description: zod_1.z.array(zod_1.z
+            .object({
+            text: zod_1.z.string(),
+            start_time: zod_1.z.number(),
+            end_time: zod_1.z.number(),
+        })
+            .partial()
+            .strict()
+            .passthrough()),
+        scene_text: zod_1.z.array(zod_1.z
+            .object({
+            text: zod_1.z.string(),
+            start_time: zod_1.z.number(),
+            end_time: zod_1.z.number(),
+        })
+            .partial()
+            .strict()
+            .passthrough()),
+        speech: zod_1.z.array(zod_1.z
+            .object({
+            speaker: zod_1.z.string(),
+            text: zod_1.z.string(),
+            start_time: zod_1.z.number(),
+            end_time: zod_1.z.number(),
+        })
+            .partial()
+            .strict()
+            .passthrough()),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+    total: zod_1.z.number().int().optional(),
+    limit: zod_1.z.number().int().optional(),
+    offset: zod_1.z.number().int().optional(),
+})
+    .strict()
+    .passthrough();
+const AddYouTubeCollectionFile = zod_1.z
+    .object({
+    url: zod_1.z.string(),
+    metadata: zod_1.z.object({}).partial().strict().passthrough().optional(),
+})
+    .strict()
+    .passthrough();
+exports.schemas = {
+    Collection,
+    CollectionList,
+    CollectionFile,
+    CollectionFileList,
+    NewCollection,
+    CollectionDelete,
+    CollectionFileDelete,
+    FileEntities,
+    FileDescription,
+    AddYouTubeCollectionFile,
+};
+const endpoints = (0, core_1.makeApi)([
+    {
+        method: "post",
+        path: "/collections",
+        alias: "createCollection",
+        description: `Create a new collection to organize and process video files`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `Collection creation parameters`,
+                type: "Body",
+                schema: NewCollection,
+            },
+        ],
+        response: Collection,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request or malformed YouTube URL`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 409,
+                description: `Collection name already exists for this account`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 429,
+                description: `Too many requests`,
+                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(),
+            },
+            {
+                status: 509,
+                description: `Resource limits exceeded (total collections or files per collection)`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+        ],
+    },
+    {
+        method: "get",
+        path: "/collections",
+        alias: "listCollections",
+        description: `List all collections`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().optional().default(0),
+            },
+            {
+                name: "order",
+                type: "Query",
+                schema: zod_1.z.enum(["name", "created_at"]).optional().default("created_at"),
+            },
+            {
+                name: "sort",
+                type: "Query",
+                schema: zod_1.z.enum(["asc", "desc"]).optional().default("desc"),
+            },
+        ],
+        response: CollectionList,
+        errors: [
+            {
+                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: "/collections/:collection_id",
+        alias: "getCollection",
+        description: `Retrieve details about a specific collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: Collection,
+        errors: [
+            {
+                status: 404,
+                description: `Collection 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: "/collections/:collection_id",
+        alias: "deleteCollection",
+        description: `Delete a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionDelete,
+        errors: [
+            {
+                status: 404,
+                description: `Collection 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: "post",
+        path: "/collections/:collection_id/videos",
+        alias: "addVideo",
+        description: `Add a video to a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `File association parameters`,
+                type: "Body",
+                schema: zod_1.z.object({ file_id: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionFile,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Collection or file 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: "get",
+        path: "/collections/:collection_id/videos",
+        alias: "listVideos",
+        description: `List all files in a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().optional().default(0),
+            },
+            {
+                name: "status",
+                type: "Query",
+                schema: zod_1.z
+                    .enum([
+                    "pending",
+                    "processing",
+                    "ready",
+                    "completed",
+                    "failed",
+                    "not_applicable",
+                ])
+                    .optional(),
+            },
+            {
+                name: "order",
+                type: "Query",
+                schema: zod_1.z.enum(["added_at", "filename"]).optional().default("added_at"),
+            },
+            {
+                name: "sort",
+                type: "Query",
+                schema: zod_1.z.enum(["asc", "desc"]).optional().default("desc"),
+            },
+        ],
+        response: CollectionFileList,
+        errors: [
+            {
+                status: 404,
+                description: `Collection 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: "get",
+        path: "/collections/:collection_id/videos/:file_id",
+        alias: "getVideo",
+        description: `Retrieve information about a specific video file in a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionFile,
+        errors: [
+            {
+                status: 404,
+                description: `Collection or file 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: "/collections/:collection_id/videos/:file_id",
+        alias: "deleteVideo",
+        description: `Remove a video file from a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionFileDelete,
+        errors: [
+            {
+                status: 404,
+                description: `Collection or file 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: "get",
+        path: "/collections/:collection_id/videos/:file_id/entities",
+        alias: "getEntities",
+        description: `Retrieve all extracted entities for a specific file in a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().optional().default(0),
+            },
+        ],
+        response: FileEntities,
+        errors: [
+            {
+                status: 404,
+                description: `Collection or file 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: "get",
+        path: "/collections/:collection_id/videos/:file_id/description",
+        alias: "getDescription",
+        description: `Retrieve the processed video summary description and segment documents for a file in a collection`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "limit",
+                type: "Query",
+                schema: zod_1.z.number().int().lte(100).optional().default(50),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().optional().default(0),
+            },
+        ],
+        response: FileDescription,
+        errors: [
+            {
+                status: 404,
+                description: `Collection or file 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: "post",
+        path: "/collections/:collection_id/youtube",
+        alias: "addYouTubeVideo",
+        description: `Add a YouTube video to a collection by URL`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "body",
+                description: `YouTube video URL parameters`,
+                type: "Body",
+                schema: AddYouTubeCollectionFile,
+            },
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+        ],
+        response: CollectionFile,
+        errors: [
+            {
+                status: 400,
+                description: `Invalid request or YouTube URL`,
+                schema: zod_1.z.object({ error: zod_1.z.string() }).strict().passthrough(),
+            },
+            {
+                status: 404,
+                description: `Collection 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.CollectionsApi = new core_1.Zodios("https://api.cloudglue.dev/v1", endpoints);
+function createApiClient(baseUrl, options) {
+    return new core_1.Zodios(baseUrl, endpoints, options);
+}