@aviaryhq/cloudglue-js 0.1.8 → 0.2.0

package/dist/generated/Collections.js

@@ -41,6 +41,17 @@ const Collection = zod_1.z
         .strict()
         .passthrough()
         .optional(),
+    describe_config: zod_1.z
+        .object({
+        enable_summary: zod_1.z.boolean().default(true),
+        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(),
     default_segmentation_config: common_1.SegmentationConfig.optional(),
     default_thumbnails_config: common_2.ThumbnailsConfig.optional(),
     created_at: zod_1.z.number().int(),
@@ -50,7 +61,11 @@ const Collection = zod_1.z
     .passthrough();
 const NewCollection = zod_1.z
     .object({
-    collection_type: zod_1.z.enum(["entities", "rich-transcripts"]),
+    collection_type: zod_1.z.enum([
+        "entities",
+        "rich-transcripts",
+        "media-descriptions",
+    ]),
     name: zod_1.z.string(),
     description: zod_1.z.union([zod_1.z.string(), zod_1.z.null()]).optional(),
     extract_config: zod_1.z
@@ -75,6 +90,17 @@ const NewCollection = zod_1.z
         .strict()
         .passthrough()
         .optional(),
+    describe_config: zod_1.z
+        .object({
+        enable_summary: zod_1.z.boolean().default(true),
+        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(),
     default_segmentation_config: common_1.SegmentationConfig.optional(),
     default_thumbnails_config: common_2.ThumbnailsConfig.optional(),
 })
@@ -331,6 +357,124 @@ const CollectionRichTranscriptsList = zod_1.z
 })
     .strict()
     .passthrough();
+const CollectionMediaDescriptionsList = zod_1.z
+    .object({
+    object: zod_1.z.literal("list"),
+    data: zod_1.z.array(zod_1.z
+        .object({
+        file_id: zod_1.z.string(),
+        added_at: zod_1.z.number().int(),
+        object: zod_1.z.literal("collection_file"),
+        data: zod_1.z
+            .object({
+            content: zod_1.z.string(),
+            title: zod_1.z.string(),
+            summary: zod_1.z.string(),
+            speech: 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()),
+            visual_scene_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()),
+            segment_summary: zod_1.z.array(zod_1.z
+                .object({
+                title: zod_1.z.string(),
+                summary: zod_1.z.string(),
+                start_time: zod_1.z.number(),
+                end_time: zod_1.z.number(),
+            })
+                .partial()
+                .strict()
+                .passthrough()),
+        })
+            .partial()
+            .strict()
+            .passthrough(),
+    })
+        .strict()
+        .passthrough()),
+    total: zod_1.z.number().int(),
+    limit: zod_1.z.number().int(),
+    offset: zod_1.z.number().int(),
+})
+    .strict()
+    .passthrough();
+const MediaDescription = zod_1.z
+    .object({
+    collection_id: zod_1.z.string(),
+    file_id: zod_1.z.string(),
+    content: zod_1.z.string().optional(),
+    title: zod_1.z.string().optional(),
+    summary: zod_1.z.string().optional(),
+    speech: 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())
+        .optional(),
+    visual_scene_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())
+        .optional(),
+    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())
+        .optional(),
+    segment_summary: zod_1.z
+        .array(zod_1.z
+        .object({
+        title: zod_1.z.string(),
+        summary: zod_1.z.string(),
+        start_time: zod_1.z.number(),
+        end_time: zod_1.z.number(),
+    })
+        .partial()
+        .strict()
+        .passthrough())
+        .optional(),
+})
+    .strict()
+    .passthrough();
 exports.schemas = {
     Collection,
     NewCollection,
@@ -345,6 +489,8 @@ exports.schemas = {
     RichTranscript,
     CollectionEntitiesList,
     CollectionRichTranscriptsList,
+    CollectionMediaDescriptionsList,
+    MediaDescription,
 };
 const endpoints = (0, core_1.makeApi)([
     {
@@ -901,6 +1047,115 @@ const endpoints = (0, core_1.makeApi)([
             },
         ],
     },
+    {
+        method: "get",
+        path: "/collections/:collection_id/media-descriptions",
+        alias: "listCollectionMediaDescriptions",
+        description: `List all media description data for files in a collection. This API is only available when a collection is created with collection_type 'media-descriptions'`,
+        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(20),
+            },
+            {
+                name: "offset",
+                type: "Query",
+                schema: zod_1.z.number().int().optional().default(0),
+            },
+            {
+                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"),
+            },
+            {
+                name: "added_before",
+                type: "Query",
+                schema: zod_1.z.string().optional(),
+            },
+            {
+                name: "added_after",
+                type: "Query",
+                schema: zod_1.z.string().optional(),
+            },
+            {
+                name: "response_format",
+                type: "Query",
+                schema: zod_1.z.enum(["json", "markdown"]).optional().default("json"),
+            },
+        ],
+        response: CollectionMediaDescriptionsList,
+        errors: [
+            {
+                status: 400,
+                description: `Collection type is not 'media-descriptions'`,
+                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(),
+            },
+        ],
+    },
+    {
+        method: "get",
+        path: "/collections/:collection_id/videos/:file_id/media-descriptions",
+        alias: "getMediaDescriptions",
+        description: `Retrieve media description data for a specific file in a collection. This API is only available when the collection is created with collection_type 'media-descriptions'`,
+        requestFormat: "json",
+        parameters: [
+            {
+                name: "collection_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "file_id",
+                type: "Path",
+                schema: zod_1.z.string(),
+            },
+            {
+                name: "response_format",
+                type: "Query",
+                schema: zod_1.z.enum(["json", "markdown"]).optional().default("json"),
+            },
+        ],
+        response: MediaDescription,
+        errors: [
+            {
+                status: 400,
+                description: `Collection type is not 'media-descriptions'`,
+                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(),
+            },
+        ],
+    },
 ]);
 exports.CollectionsApi = new core_1.Zodios("https://api.cloudglue.dev/v1", endpoints);
 function createApiClient(baseUrl, options) {

package/dist/generated/Describe.d.ts

@@ -0,0 +1,364 @@
+import { type ZodiosOptions } from "@zodios/core";
+import { z } from "zod";
+import { ThumbnailsConfig } from "./common";
+import { FileSegmentationConfig } from "./common";
+type Describe = {
+    job_id: string;
+    status: "pending" | "processing" | "completed" | "failed" | "not_applicable";
+    url?: string | undefined;
+    created_at?: number | undefined;
+    describe_config?: Partial<{
+        enable_summary: boolean;
+        enable_speech: boolean;
+        enable_visual_scene_description: boolean;
+        enable_scene_text: boolean;
+    }> | undefined;
+    data?: Partial<{
+        content: string;
+        title: string;
+        summary: string;
+        speech: Array<Partial<{
+            text: string;
+            start_time: number;
+            end_time: number;
+        }>>;
+        visual_scene_description: Array<Partial<{
+            text: string;
+            start_time: number;
+            end_time: number;
+        }>>;
+        scene_text: Array<Partial<{
+            text: string;
+            start_time: number;
+            end_time: number;
+        }>>;
+        segment_summary: Array<Partial<{
+            title: string;
+            summary: string;
+            start_time: number;
+            end_time: number;
+        }>>;
+    }> | undefined;
+    error?: string | undefined;
+};
+type NewDescribe = {
+    url: string;
+    enable_summary?: boolean | undefined;
+    enable_speech?: boolean | undefined;
+    enable_visual_scene_description?: boolean | undefined;
+    enable_scene_text?: boolean | undefined;
+    thumbnails_config?: ThumbnailsConfig | undefined;
+} & FileSegmentationConfig;
+type DescribeList = {
+    object: "list";
+    data: Array<Describe>;
+    total: number;
+    limit: number;
+};
+declare const NewDescribe: z.ZodType<NewDescribe>;
+declare const Describe: z.ZodType<Describe>;
+declare const DescribeList: z.ZodType<DescribeList>;
+export declare const schemas: {
+    NewDescribe: z.ZodType<NewDescribe, z.ZodTypeDef, NewDescribe>;
+    Describe: z.ZodType<Describe, z.ZodTypeDef, Describe>;
+    DescribeList: z.ZodType<DescribeList, z.ZodTypeDef, DescribeList>;
+};
+export declare const DescribeApi: import("@zodios/core").ZodiosInstance<[{
+    method: "post";
+    path: "/describe";
+    alias: "createDescribe";
+    description: "Creates a new media description job for video content";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<NewDescribe, z.ZodTypeDef, NewDescribe>;
+    }];
+    response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
+    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: 509;
+        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: "/describe";
+    alias: "listDescribes";
+    description: "List all media description jobs with optional filtering";
+    requestFormat: "json";
+    parameters: [{
+        name: "limit";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "offset";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "status";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodEnum<["pending", "processing", "completed", "failed", "not_applicable"]>>;
+    }, {
+        name: "created_before";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "created_after";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "url";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "response_format";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
+    }];
+    response: z.ZodType<DescribeList, z.ZodTypeDef, DescribeList>;
+    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: 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: "/describe/:job_id";
+    alias: "getDescribe";
+    description: "Retrieve the current state of a media description job";
+    requestFormat: "json";
+    parameters: [{
+        name: "job_id";
+        type: "Path";
+        schema: z.ZodString;
+    }, {
+        name: "response_format";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
+    }];
+    response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
+    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: "/describe";
+    alias: "createDescribe";
+    description: "Creates a new media description job for video content";
+    requestFormat: "json";
+    parameters: [{
+        name: "body";
+        description: string;
+        type: "Body";
+        schema: z.ZodType<NewDescribe, z.ZodTypeDef, NewDescribe>;
+    }];
+    response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
+    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: 509;
+        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: "/describe";
+    alias: "listDescribes";
+    description: "List all media description jobs with optional filtering";
+    requestFormat: "json";
+    parameters: [{
+        name: "limit";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "offset";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, {
+        name: "status";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodEnum<["pending", "processing", "completed", "failed", "not_applicable"]>>;
+    }, {
+        name: "created_before";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "created_after";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "url";
+        type: "Query";
+        schema: z.ZodOptional<z.ZodString>;
+    }, {
+        name: "response_format";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
+    }];
+    response: z.ZodType<DescribeList, z.ZodTypeDef, DescribeList>;
+    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: 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: "/describe/:job_id";
+    alias: "getDescribe";
+    description: "Retrieve the current state of a media description job";
+    requestFormat: "json";
+    parameters: [{
+        name: "job_id";
+        type: "Path";
+        schema: z.ZodString;
+    }, {
+        name: "response_format";
+        type: "Query";
+        schema: z.ZodDefault<z.ZodOptional<z.ZodEnum<["json", "markdown"]>>>;
+    }];
+    response: z.ZodType<Describe, z.ZodTypeDef, Describe>;
+    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 {};