@cloudinary/asset-management-mcp 0.9.3 → 0.10.0

package/src/models/referenceimage.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 25cf64688b41
+ */
+
+import * as z from "zod";
+import {
+  ManagedAssetReference,
+  ManagedAssetReference$zodSchema,
+} from "./managedassetreference.js";
+import { UrlReference, UrlReference$zodSchema } from "./urlreference.js";
+
+/**
+ * A single reference image, in **one** of two mutually exclusive forms
+ *
+ * @remarks
+ * determined by `source_type`:
+ *   * `ManagedAssetReference`: a managed asset in the caller's product
+ *     environment, by `asset_id` (read permission is checked).
+ *   * `UrlReference`: an external image by HTTPS `url`.
+ */
+export type ReferenceImage =
+  | (ManagedAssetReference & { source_type: "managed_asset" })
+  | (UrlReference & { source_type: "url" });
+
+export const ReferenceImage$zodSchema: z.ZodType<ReferenceImage> = z.union([
+  ManagedAssetReference$zodSchema.and(
+    z.object({
+      source_type: z.literal("managed_asset"),
+    }).transform((v) => ({ source_type: v.source_type })),
+  ),
+  UrlReference$zodSchema.and(
+    z.object({
+      source_type: z.literal("url"),
+    }).transform((v) => ({ source_type: v.source_type })),
+  ),
+]).describe(
+  "A single reference image, in **one** of two mutually exclusive forms\ndetermined by `source_type`:\n  * `ManagedAssetReference`: a managed asset in the caller's product\n    environment, by `asset_id` (read permission is checked).\n  * `UrlReference`: an external image by HTTPS `url`.\n",
+);

package/src/models/renamefolderoperationop.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7a8a56d17bf3
+ */
+
+import * as z from "zod";
+import { ApiError, ApiError$zodSchema } from "./apierror.js";
+import {
+  FolderRenameResponse,
+  FolderRenameResponse$zodSchema,
+} from "./folderrenameresponse.js";
+
+export type RenameFolderOperationGlobals = { cloud_name?: string | undefined };
+
+export const RenameFolderOperationGlobals$zodSchema: z.ZodType<
+  RenameFolderOperationGlobals
+> = z.object({
+  cloud_name: z.string().describe("The cloud name of your product environment.")
+    .optional(),
+});
+
+export type RenameFolderOperationResponse = ApiError | FolderRenameResponse;
+
+export const RenameFolderOperationResponse$zodSchema: z.ZodType<
+  RenameFolderOperationResponse
+> = z.union([
+  ApiError$zodSchema,
+  FolderRenameResponse$zodSchema,
+]);

package/src/models/resourcegetbybodyrequest.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2f9165e777b1
+ */
+
+import * as z from "zod";
+import { collectExtraKeys as collectExtraKeys$ } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * The type of the asset (image, video, or raw).
+ */
+export const ResourceGetByBodyRequestResourceType = {
+  Image: "image",
+  Video: "video",
+  Raw: "raw",
+} as const;
+/**
+ * The type of the asset (image, video, or raw).
+ */
+export type ResourceGetByBodyRequestResourceType = ClosedEnum<
+  typeof ResourceGetByBodyRequestResourceType
+>;
+
+export const ResourceGetByBodyRequestResourceType$zodSchema = z.enum([
+  "image",
+  "video",
+  "raw",
+]).describe("The type of the asset (image, video, or raw).");
+
+/**
+ * The delivery type of the asset.
+ */
+export const ResourceGetByBodyRequestKind = {
+  Upload: "upload",
+  Private: "private",
+  Authenticated: "authenticated",
+} as const;
+/**
+ * The delivery type of the asset.
+ */
+export type ResourceGetByBodyRequestKind = ClosedEnum<
+  typeof ResourceGetByBodyRequestKind
+>;
+
+export const ResourceGetByBodyRequestKind$zodSchema = z.enum([
+  "upload",
+  "private",
+  "authenticated",
+]).describe("The delivery type of the asset.");
+
+/**
+ * The identifying attributes of the asset to retrieve.
+ */
+export type ResourceGetByBodyRequest = {
+  public_id: string;
+  resource_type: ResourceGetByBodyRequestResourceType;
+  kind: ResourceGetByBodyRequestKind;
+  with_elastic?: boolean | undefined;
+  derived?: boolean | undefined;
+  versions?: boolean | undefined;
+  AdditionalProperties?: { [k: string]: any };
+};
+
+export const ResourceGetByBodyRequest$zodSchema: z.ZodType<
+  ResourceGetByBodyRequest
+> = collectExtraKeys$(
+  z.object({
+    derived: z.boolean().optional().describe(
+      "Whether to include the derived assets of this asset in the response. Default is true.",
+    ),
+    kind: ResourceGetByBodyRequestKind$zodSchema.describe(
+      "The delivery type of the asset.",
+    ),
+    public_id: z.string().describe("The public ID of the asset to retrieve."),
+    resource_type: ResourceGetByBodyRequestResourceType$zodSchema.describe(
+      "The type of the asset (image, video, or raw).",
+    ),
+    versions: z.boolean().optional().describe(
+      "Whether to include the backup versions of this asset in the response. Default is false.",
+    ),
+    with_elastic: z.boolean().optional().describe(
+      "Whether to source the asset details from the search index. If false, the details are read directly from the canonical store. Default is true.",
+    ),
+  }).describe("The identifying attributes of the asset to retrieve.").catchall(
+    z.any(),
+  ),
+  "AdditionalProperties",
+  true,
+);
+
+export const ResourceGetByBodyRequest$zodSchemaOutbound: z.ZodType<any> = z
+  .object({
+    AdditionalProperties: z.record(z.string(), z.any()).optional(),
+    derived: z.boolean().optional(),
+    kind: ResourceGetByBodyRequestKind$zodSchema,
+    public_id: z.string(),
+    resource_type: ResourceGetByBodyRequestResourceType$zodSchema,
+    versions: z.boolean().optional(),
+    with_elastic: z.boolean().optional(),
+  }).describe("The identifying attributes of the asset to retrieve.").transform(
+    (v) => {
+      const { AdditionalProperties, ...rest } = v;
+      return {
+        ...rest,
+        ...AdditionalProperties,
+      };
+    },
+  );

package/src/models/resourceinternalresponse.ts

@@ -0,0 +1,376 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: df55d886fbf6
+ */
+
+import * as z from "zod";
+import { collectExtraKeys as collectExtraKeys$ } from "../lib/schemas.js";
+import {
+  AccessControlItem,
+  AccessControlItem$zodSchema,
+} from "./accesscontrolitem.js";
+import {
+  ContextFullResponse,
+  ContextFullResponse$zodSchema,
+  ContextFullResponse$zodSchemaOutbound,
+} from "./contextfullresponse.js";
+import {
+  CoordinatesResponse,
+  CoordinatesResponse$zodSchema,
+} from "./coordinatesresponse.js";
+import {
+  DeliveryTypeAll,
+  DeliveryTypeAll$zodSchema,
+} from "./deliverytypeall.js";
+
+export type ResourceInternalResponseModeration = {
+  kind?: string | undefined;
+  status?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+export const ResourceInternalResponseModeration$zodSchema: z.ZodType<
+  ResourceInternalResponseModeration
+> = z.object({
+  kind: z.string().optional(),
+  status: z.string().optional(),
+  updated_at: z.iso.datetime({ offset: true }).optional(),
+});
+
+export type ResourceInternalResponseRelatedAsset = {};
+
+export const ResourceInternalResponseRelatedAsset$zodSchema: z.ZodType<
+  ResourceInternalResponseRelatedAsset
+> = z.object({});
+
+export type ResourceInternalResponseLastUpdated = {
+  access_control_updated_at?: string | undefined;
+  context_updated_at?: string | undefined;
+  metadata_updated_at?: string | undefined;
+  public_id_updated_at?: string | undefined;
+  tags_updated_at?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+export const ResourceInternalResponseLastUpdated$zodSchema: z.ZodType<
+  ResourceInternalResponseLastUpdated
+> = z.object({
+  access_control_updated_at: z.iso.datetime({ offset: true }).optional(),
+  context_updated_at: z.iso.datetime({ offset: true }).optional(),
+  metadata_updated_at: z.iso.datetime({ offset: true }).optional(),
+  public_id_updated_at: z.iso.datetime({ offset: true }).optional(),
+  tags_updated_at: z.iso.datetime({ offset: true }).optional(),
+  updated_at: z.iso.datetime({ offset: true }).optional(),
+});
+
+export type ResourceInternalResponseDerived = {
+  transformation?: string | undefined;
+  format?: string | undefined;
+  bytes?: number | undefined;
+  id?: string | undefined;
+  url?: string | undefined;
+  secure_url?: string | undefined;
+};
+
+export const ResourceInternalResponseDerived$zodSchema: z.ZodType<
+  ResourceInternalResponseDerived
+> = z.object({
+  bytes: z.int().optional(),
+  format: z.string().optional(),
+  id: z.string().optional(),
+  secure_url: z.string().optional(),
+  transformation: z.string().optional(),
+  url: z.string().optional(),
+});
+
+export type ResourceInternalResponseVersion = {
+  version_id?: string | undefined;
+  version?: string | undefined;
+  format?: string | null | undefined;
+  size?: number | undefined;
+  time?: string | undefined;
+  restorable?: boolean | undefined;
+};
+
+export const ResourceInternalResponseVersion$zodSchema: z.ZodType<
+  ResourceInternalResponseVersion
+> = z.object({
+  format: z.string().nullable().optional(),
+  restorable: z.boolean().optional(),
+  size: z.int().optional(),
+  time: z.iso.datetime({ offset: true }).optional(),
+  version: z.string().optional(),
+  version_id: z.string().optional().describe(
+    "Hexadecimal version ID; length is a positive multiple of 32 (typically 32 or 64).",
+  ),
+});
+
+/**
+ * Additional asset information (visual search, recognized people, etc.)
+ */
+export type ResourceInternalResponseInfo = {};
+
+export const ResourceInternalResponseInfo$zodSchema: z.ZodType<
+  ResourceInternalResponseInfo
+> = z.object({}).describe(
+  "Additional asset information (visual search, recognized people, etc.)",
+);
+
+export type ResourceInternalResponseDerivative = {
+  id?: string | undefined;
+  transformation?: string | undefined;
+  transformation_signature?: string | undefined;
+  secure_url?: string | undefined;
+};
+
+export const ResourceInternalResponseDerivative$zodSchema: z.ZodType<
+  ResourceInternalResponseDerivative
+> = z.object({
+  id: z.string().optional().describe(
+    "The unique identifier of the derived resource.",
+  ),
+  secure_url: z.string().optional().describe(
+    "The secure URL for accessing the derived resource.",
+  ),
+  transformation: z.string().optional().describe(
+    "The transformation string that was applied.",
+  ),
+  transformation_signature: z.string().optional().describe(
+    "The unique signature of the transformation.",
+  ),
+});
+
+/**
+ * The details of a single asset. Returns the standard asset fields, plus additional
+ *
+ * @remarks
+ * internal fields when accessed over the internal transport.
+ */
+export type ResourceInternalResponse = {
+  asset_id?: string | undefined;
+  public_id?: string | undefined;
+  asset_folder?: string | undefined;
+  display_name?: string | undefined;
+  folder?: string | undefined;
+  filename?: string | undefined;
+  format?: string | undefined;
+  version?: number | undefined;
+  resource_type?: string | undefined;
+  type?: DeliveryTypeAll | undefined;
+  created_at?: string | undefined;
+  uploaded_at?: string | undefined;
+  bytes?: number | undefined;
+  backup_bytes?: number | undefined;
+  width?: number | null | undefined;
+  height?: number | null | undefined;
+  aspect_ratio?: number | null | undefined;
+  pixels?: number | null | undefined;
+  tags?: Array<string> | null | undefined;
+  context?: ContextFullResponse | null | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  moderation_kind?: string | undefined;
+  moderation_status?: string | undefined;
+  moderation?: Array<ResourceInternalResponseModeration> | undefined;
+  backup?: boolean | undefined;
+  url?: string | undefined;
+  secure_url?: string | undefined;
+  status?: string | undefined;
+  access_control?: Array<AccessControlItem> | null | undefined;
+  etag?: string | undefined;
+  animated?: boolean | null | undefined;
+  duration?: number | null | undefined;
+  resource_subtype?: string | null | undefined;
+  substatus?: string | null | undefined;
+  related_assets?:
+    | Array<ResourceInternalResponseRelatedAsset>
+    | null
+    | undefined;
+  last_updated?: ResourceInternalResponseLastUpdated | null | undefined;
+  next_cursor?: string | undefined;
+  derived?: Array<ResourceInternalResponseDerived> | undefined;
+  faces?: Array<Array<number>> | null | undefined;
+  coordinates?: CoordinatesResponse | null | undefined;
+  illustration_score?: number | undefined;
+  semi_transparent?: boolean | undefined;
+  grayscale?: boolean | undefined;
+  colors?: Array<Array<any>> | undefined;
+  predominant?: { [k: string]: Array<Array<any>> } | undefined;
+  versions?: Array<ResourceInternalResponseVersion> | undefined;
+  info?: ResourceInternalResponseInfo | undefined;
+  derivatives?: Array<ResourceInternalResponseDerivative> | null | undefined;
+  AdditionalProperties?: { [k: string]: any };
+};
+
+export const ResourceInternalResponse$zodSchema: z.ZodType<
+  ResourceInternalResponse
+> = collectExtraKeys$(
+  z.object({
+    access_control: z.array(AccessControlItem$zodSchema).nullable().optional(),
+    animated: z.boolean().nullable().optional().describe(
+      "Whether the asset is animated (e.g., GIF, animated WebP). Null for non-animated assets.",
+    ),
+    aspect_ratio: z.number().nullable().optional(),
+    asset_folder: z.string().optional(),
+    asset_id: z.string().optional().describe(
+      "A 32-character hexadecimal asset ID.",
+    ),
+    backup: z.boolean().optional(),
+    backup_bytes: z.int().optional(),
+    bytes: z.int().optional(),
+    colors: z.array(z.array(z.any())).optional(),
+    context: ContextFullResponse$zodSchema.nullable().optional().describe(
+      "Included if 'context=true' parameter is used.",
+    ),
+    coordinates: CoordinatesResponse$zodSchema.nullable().optional().describe(
+      "Face and custom coordinate data. Included if 'coordinates=true' parameter is used.",
+    ),
+    created_at: z.iso.datetime({ offset: true }).optional(),
+    derivatives: z.array(
+      z.lazy(() => ResourceInternalResponseDerivative$zodSchema),
+    ).nullable().optional().describe(
+      "Included if 'derived=true' parameter is used. Null when no derivatives exist.",
+    ),
+    derived: z.array(z.lazy(() => ResourceInternalResponseDerived$zodSchema))
+      .optional(),
+    display_name: z.string().optional(),
+    duration: z.number().nullable().optional().describe(
+      "Duration in seconds for video/audio assets. Null for images.",
+    ),
+    etag: z.string().optional(),
+    faces: z.array(z.array(z.int())).nullable().optional().describe(
+      "Detected face rectangles. Included if 'faces=true' parameter is used.",
+    ),
+    filename: z.string().optional(),
+    folder: z.string().optional(),
+    format: z.string().optional(),
+    grayscale: z.boolean().optional(),
+    height: z.int().nullable().optional(),
+    illustration_score: z.number().optional(),
+    info: z.lazy(() => ResourceInternalResponseInfo$zodSchema).optional()
+      .describe(
+        "Additional asset information (visual search, recognized people, etc.)",
+      ),
+    last_updated: z.lazy(() => ResourceInternalResponseLastUpdated$zodSchema)
+      .nullable().optional(),
+    metadata: z.record(z.string(), z.any()).optional(),
+    moderation: z.array(
+      z.lazy(() => ResourceInternalResponseModeration$zodSchema),
+    ).optional().describe("Included if 'moderations=true' parameter is used."),
+    moderation_kind: z.string().optional().describe(
+      "The type of moderation applied to the asset.",
+    ),
+    moderation_status: z.string().optional().describe(
+      "The current status of the moderation process for the asset.",
+    ),
+    next_cursor: z.string().optional().describe(
+      "Cursor for paginating derived assets.",
+    ),
+    pixels: z.int().nullable().optional(),
+    predominant: z.record(z.string(), z.array(z.array(z.any()))).optional(),
+    public_id: z.string().optional(),
+    related_assets: z.array(
+      z.lazy(() => ResourceInternalResponseRelatedAsset$zodSchema),
+    ).nullable().optional().describe(
+      "Related assets linked to this resource. Null when none linked.",
+    ),
+    resource_subtype: z.string().nullable().optional().describe(
+      "The subtype of the resource (e.g., for video). Null when not applicable.",
+    ),
+    resource_type: z.string().optional(),
+    secure_url: z.string().optional(),
+    semi_transparent: z.boolean().optional(),
+    status: z.string().optional(),
+    substatus: z.string().nullable().optional().describe(
+      "The substatus of the resource. Null when not set.",
+    ),
+    tags: z.array(z.string()).nullable().optional().describe(
+      "Included if 'tags=true' parameter is used.",
+    ),
+    type: DeliveryTypeAll$zodSchema.optional().describe(
+      "All supported delivery types.",
+    ),
+    uploaded_at: z.iso.datetime({ offset: true }).optional(),
+    url: z.string().optional(),
+    version: z.int().optional(),
+    versions: z.array(z.lazy(() => ResourceInternalResponseVersion$zodSchema))
+      .optional(),
+    width: z.int().nullable().optional(),
+  }).describe(
+    "The details of a single asset. Returns the standard asset fields, plus additional\ninternal fields when accessed over the internal transport.\n",
+  ).catchall(z.any()),
+  "AdditionalProperties",
+  true,
+);
+
+export const ResourceInternalResponse$zodSchemaOutbound: z.ZodType<any> = z
+  .object({
+    AdditionalProperties: z.record(z.string(), z.any()).optional(),
+    access_control: z.nullable(z.array(AccessControlItem$zodSchema)).optional(),
+    animated: z.nullable(z.boolean()).optional(),
+    aspect_ratio: z.nullable(z.number()).optional(),
+    asset_folder: z.string().optional(),
+    asset_id: z.string().optional(),
+    backup: z.boolean().optional(),
+    backup_bytes: z.int().optional(),
+    bytes: z.int().optional(),
+    colors: z.array(z.array(z.any())).optional(),
+    context: z.nullable(ContextFullResponse$zodSchemaOutbound).optional(),
+    coordinates: z.nullable(CoordinatesResponse$zodSchema).optional(),
+    created_at: z.union([z.date(), z.string().transform(v => new Date(v))])
+      .transform(v => v.toISOString()).optional(),
+    derivatives: z.nullable(
+      z.array(z.lazy(() => ResourceInternalResponseDerivative$zodSchema)),
+    ).optional(),
+    derived: z.array(z.lazy(() => ResourceInternalResponseDerived$zodSchema))
+      .optional(),
+    display_name: z.string().optional(),
+    duration: z.nullable(z.number()).optional(),
+    etag: z.string().optional(),
+    faces: z.nullable(z.array(z.array(z.int()))).optional(),
+    filename: z.string().optional(),
+    folder: z.string().optional(),
+    format: z.string().optional(),
+    grayscale: z.boolean().optional(),
+    height: z.nullable(z.int()).optional(),
+    illustration_score: z.number().optional(),
+    info: z.lazy(() => ResourceInternalResponseInfo$zodSchema).optional(),
+    last_updated: z.nullable(
+      z.lazy(() => ResourceInternalResponseLastUpdated$zodSchema),
+    ).optional(),
+    metadata: z.record(z.string(), z.any()).optional(),
+    moderation: z.array(
+      z.lazy(() => ResourceInternalResponseModeration$zodSchema),
+    ).optional(),
+    moderation_kind: z.string().optional(),
+    moderation_status: z.string().optional(),
+    next_cursor: z.string().optional(),
+    pixels: z.nullable(z.int()).optional(),
+    predominant: z.record(z.string(), z.array(z.array(z.any()))).optional(),
+    public_id: z.string().optional(),
+    related_assets: z.nullable(
+      z.array(z.lazy(() => ResourceInternalResponseRelatedAsset$zodSchema)),
+    ).optional(),
+    resource_subtype: z.nullable(z.string()).optional(),
+    resource_type: z.string().optional(),
+    secure_url: z.string().optional(),
+    semi_transparent: z.boolean().optional(),
+    status: z.string().optional(),
+    substatus: z.nullable(z.string()).optional(),
+    tags: z.nullable(z.array(z.string())).optional(),
+    type: DeliveryTypeAll$zodSchema.optional(),
+    uploaded_at: z.union([z.date(), z.string().transform(v => new Date(v))])
+      .transform(v => v.toISOString()).optional(),
+    url: z.string().optional(),
+    version: z.int().optional(),
+    versions: z.array(z.lazy(() => ResourceInternalResponseVersion$zodSchema))
+      .optional(),
+    width: z.nullable(z.int()).optional(),
+  }).describe(
+    "The details of a single asset. Returns the standard asset fields, plus additional\ninternal fields when accessed over the internal transport.\n",
+  ).transform((v) => {
+    const { AdditionalProperties, ...rest } = v;
+    return {
+      ...rest,
+      ...AdditionalProperties,
+    };
+  });

package/src/models/resourcesbycontaineridresponse.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: aba3f59bb468
+ */
+
+import * as z from "zod";
+import {
+  ResourceInternalResponse,
+  ResourceInternalResponse$zodSchema,
+} from "./resourceinternalresponse.js";
+
+/**
+ * A page of assets contained in a folder, with pagination metadata.
+ */
+export type ResourcesByContainerIdResponse = {
+  resources: Array<ResourceInternalResponse>;
+  total_count?: number | undefined;
+  next_cursor?: string | undefined;
+};
+
+export const ResourcesByContainerIdResponse$zodSchema: z.ZodType<
+  ResourcesByContainerIdResponse
+> = z.object({
+  next_cursor: z.string().optional().describe(
+    "A cursor for retrieving the next page of results, when more results are available.",
+  ),
+  resources: z.array(ResourceInternalResponse$zodSchema).describe(
+    "The assets contained in the folder.",
+  ),
+  total_count: z.int().optional().describe(
+    "The total number of assets in the folder.",
+  ),
+}).describe(
+  "A page of assets contained in a folder, with pagination metadata.",
+);