@cloudinary/asset-management-mcp 0.8.0 → 0.9.0-rc.0

package/src/models/listresourcetypesop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4db2684377ee
  */
 
 import * as z from "zod";
@@ -66,7 +67,8 @@ export type ListResourceTypesResponseBody = {
 export const ListResourceTypesResponseBody$zodSchema: z.ZodType<
   ListResourceTypesResponseBody
 > = z.object({
-  resource_types: z.array(ListResourceTypesResourceType$zodSchema).optional(),
+  resource_types: z.array(ListResourceTypesResourceType$zodSchema).optional()
+    .describe("The list of available resource types."),
 }).describe("The list of resource types.");
 
 export type ListResourceTypesResponse =

package/src/models/listresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 632309be6dea
  */
 
 import * as z from "zod";

package/src/models/listrootfoldersop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 84760bbe9415
  */
 
 import * as z from "zod";

package/src/models/liststoragetype.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c599606acf1f
  */
 
 import * as z from "zod";

package/src/models/listvideosop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: bc3719797339
  */
 
 import * as z from "zod";
@@ -35,7 +36,7 @@ export type ListVideosRequest = {
 
 export const ListVideosRequest$zodSchema: z.ZodType<ListVideosRequest> = z
   .object({
-    direction: Direction$zodSchema.optional(),
+    direction: Direction$zodSchema.optional().describe("Sort direction."),
     fields: z.array(FieldsSpec$zodSchema).optional(),
     max_results: z.int().describe(
       "Maximum number of results to return (1-500).",
@@ -53,7 +54,9 @@ export const ListVideosRequest$zodSchema: z.ZodType<ListVideosRequest> = z
     tags: z.boolean().describe(
       "Whether to include the list of tag names assigned to each asset. Default: false",
     ).optional(),
-    type: ListStorageType$zodSchema.optional(),
+    type: ListStorageType$zodSchema.optional().describe(
+      "The delivery type. Necessary for prefix filtering.",
+    ),
   });
 
 export type ListVideosResponse = ApiError | ListResponse;

package/src/models/nonfinalchunkuploadresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 04218d941f9e
  */
 
 import * as z from "zod";
@@ -22,11 +23,19 @@ export type NonFinalChunkUploadResponse = {
 export const NonFinalChunkUploadResponse$zodSchema: z.ZodType<
   NonFinalChunkUploadResponse
 > = z.object({
-  bytes: z.int(),
-  done: z.boolean(),
-  kind: StorageType$zodSchema.optional(),
-  public_id: z.string().optional(),
-  resource_type: z.string().optional(),
+  bytes: z.int().describe("The total number of bytes uploaded so far."),
+  done: z.boolean().describe(
+    "Whether the upload is complete. Will be false for all but the last chunk.",
+  ),
+  kind: StorageType$zodSchema.optional().describe(
+    "The storage type of the resource.",
+  ),
+  public_id: z.string().optional().describe(
+    "The public ID assigned to the upload. May be omitted in early chunks if it will be auto-generated upon completion.",
+  ),
+  resource_type: z.string().optional().describe(
+    "The type of resource being uploaded (e.g., \"image\", \"video\", \"raw\"). May be omitted in early chunks when using auto detection.",
+  ),
 }).describe(
   "Status information returned for in-progress chunked uploads.\nNote that fields that are not yet determined or not known at the time of the call are omitted from the response.\n",
 );

package/src/models/parametersdirection.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5f9a874f5402
  */
 
 import * as z from "zod";

package/src/models/permittedrole.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8a5e1b9f2d4d
  */
 
 import * as z from "zod";
@@ -7,7 +8,7 @@ import * as z from "zod";
 export type PermittedRole = { id: string; name: string; description: string };
 
 export const PermittedRole$zodSchema: z.ZodType<PermittedRole> = z.object({
-  description: z.string(),
-  id: z.string(),
-  name: z.string(),
+  description: z.string().describe("A description of the role's permissions."),
+  id: z.string().describe("The role identifier."),
+  name: z.string().describe("The human-readable name of the role."),
 });

package/src/models/persondetails.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ef3731a522b1
  */
 
 import * as z from "zod";
@@ -19,10 +20,18 @@ export type PersonDetails = {
 };
 
 export const PersonDetails$zodSchema: z.ZodType<PersonDetails> = z.object({
-  created_at: z.iso.datetime({ offset: true }).optional(),
-  id: z.string().optional(),
-  name: z.string().optional(),
-  status: PersonStatus$zodSchema.optional(),
-  thumbnail: Thumbnail$zodSchema.optional(),
-  updated_at: z.iso.datetime({ offset: true }).optional(),
+  created_at: z.iso.datetime({ offset: true }).optional().describe(
+    "The date and time when the person was first detected.",
+  ),
+  id: z.string().optional().describe("The unique identifier of the person."),
+  name: z.string().optional().describe(
+    "The display name of the person, or null if not named.",
+  ),
+  status: PersonStatus$zodSchema.optional().describe("The status of a person."),
+  thumbnail: Thumbnail$zodSchema.optional().describe(
+    "The thumbnail image for a person.",
+  ),
+  updated_at: z.iso.datetime({ offset: true }).optional().describe(
+    "The date and time when the person was last updated.",
+  ),
 }).describe("Detailed information about a recognized person.");

package/src/models/personstatus.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 11ea3e94c956
  */
 
 import * as z from "zod";

package/src/models/principaltype.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9c55942ff716
  */
 
 import * as z from "zod";

package/src/models/renameassetop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 189398e65a00
  */
 
 import * as z from "zod";
@@ -35,18 +36,38 @@ export type RenameAssetRequestBody = {
 export const RenameAssetRequestBody$zodSchema: z.ZodType<
   RenameAssetRequestBody
 > = z.object({
-  api_key: z.string().optional(),
-  context: z.string().optional(),
-  from_public_id: z.string(),
-  invalidate: z.boolean().optional(),
-  metadata: z.string().optional(),
-  notification_url: z.string().optional(),
-  overwrite: z.boolean().optional(),
-  signature: z.string().optional(),
-  timestamp: z.int().optional(),
-  to_public_id: z.string(),
-  to_type: StorageType$zodSchema.optional(),
-  type: StorageType$zodSchema.optional(),
+  api_key: z.string().optional().describe(
+    "The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.",
+  ),
+  context: z.string().optional().describe(
+    "Context metadata to update during rename.",
+  ),
+  from_public_id: z.string().describe("The public ID of the asset to rename."),
+  invalidate: z.boolean().optional().describe(
+    "Whether to invalidate the CDN cache for the renamed asset.",
+  ),
+  metadata: z.string().optional().describe(
+    "Structured metadata to update during rename.",
+  ),
+  notification_url: z.string().optional().describe(
+    "URL to notify when the operation is complete.",
+  ),
+  overwrite: z.boolean().optional().describe(
+    "Whether to overwrite the target asset if it already exists.",
+  ),
+  signature: z.string().optional().describe(
+    "(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.\n",
+  ),
+  timestamp: z.int().optional().describe(
+    "The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.",
+  ),
+  to_public_id: z.string().describe("The new public ID for the asset."),
+  to_type: StorageType$zodSchema.optional().describe(
+    "The storage type of the resource.",
+  ),
+  type: StorageType$zodSchema.optional().describe(
+    "The storage type of the resource.",
+  ),
 });
 
 export type RenameAssetRequest = {
@@ -57,7 +78,7 @@ export type RenameAssetRequest = {
 export const RenameAssetRequest$zodSchema: z.ZodType<RenameAssetRequest> = z
   .object({
     RequestBody: z.lazy(() => RenameAssetRequestBody$zodSchema),
-    resource_type: ResourceType$zodSchema,
+    resource_type: ResourceType$zodSchema.describe("The type of resource."),
   });
 
 export type RenameAssetResponse = ApiError | UploadResponse;

package/src/models/resourcetype.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dfe2f50983e9
  */
 
 import * as z from "zod";

package/src/models/resourceupdaterequest.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 870113738309
  */
 
 import * as z from "zod";
@@ -51,24 +52,64 @@ export type ResourceUpdateRequest = {
 
 export const ResourceUpdateRequest$zodSchema: z.ZodType<ResourceUpdateRequest> =
   z.object({
-    access_control: z.array(AccessControlItem$zodSchema).optional(),
-    asset_folder: z.string().optional(),
-    auto_tagging: z.number().optional(),
-    background_removal: z.string().optional(),
-    categorization: z.string().optional(),
-    clear_invalid: z.boolean().default(false),
-    context: z.string().optional(),
-    custom_coordinates: z.string().optional(),
-    detection: z.string().optional(),
-    display_name: z.string().optional(),
-    face_coordinates: z.string().optional(),
-    metadata: z.string().optional(),
-    moderation_status: ModerationStatus$zodSchema.optional(),
-    ocr: z.string().optional(),
-    quality_override: z.string().optional(),
-    raw_convert: z.string().optional(),
-    regions: z.string().optional(),
-    tags: z.string().optional(),
-    unique_display_name: z.boolean().default(false),
-    visual_search: z.boolean().optional(),
+    access_control: z.array(AccessControlItem$zodSchema).optional().describe(
+      "Restricts access to the asset by specifying one or more access types.\nThe asset is restricted unless at least one listed access type is valid.\n",
+    ),
+    asset_folder: z.string().optional().describe(
+      "The folder where the asset should be placed.",
+    ),
+    auto_tagging: z.number().optional().describe(
+      "Confidence threshold for auto-tagging.",
+    ),
+    background_removal: z.string().optional().describe(
+      "The background removal provider to use for the resource. Optionally append a template suffix (e.g., cloudinary_ai:fine_edges).",
+    ),
+    categorization: z.string().optional().describe(
+      "The type of categorization to perform on the resource. Optionally append a language code suffix (e.g., google_tagging:fr).",
+    ),
+    clear_invalid: z.boolean().default(false).describe(
+      "Whether to clear invalid metadata fields. If false, invalid fields will be preserved. Default: false",
+    ),
+    context: z.string().optional().describe(
+      "A pipe-separated list of key-value pairs of contextual metadata.",
+    ),
+    custom_coordinates: z.string().optional().describe(
+      "Custom coordinates as comma-separated values, with multiple coordinates separated by pipes.",
+    ),
+    detection: z.string().optional().describe(
+      "The type of detection to perform on the resource.",
+    ),
+    display_name: z.string().optional().describe(
+      "The display name of the resource.",
+    ),
+    face_coordinates: z.string().optional().describe(
+      "Face coordinates as comma-separated values, with multiple faces separated by pipes.",
+    ),
+    metadata: z.string().optional().describe(
+      "A pipe-separated list of custom metadata fields (by external_id) and their values.",
+    ),
+    moderation_status: ModerationStatus$zodSchema.optional().describe(
+      "The moderation status of the resource.",
+    ),
+    ocr: z.string().optional().describe(
+      "The type of OCR to perform on the resource. Set to adv_ocr, optionally with options (e.g., adv_ocr:document).",
+    ),
+    quality_override: z.string().optional().describe(
+      "Quality override value that will override any automatic quality transformations.",
+    ),
+    raw_convert: z.string().optional().describe(
+      "The conversion to apply for raw files (e.g., aspose, google_speech, extract_text).",
+    ),
+    regions: z.string().optional().describe(
+      "Named groups of coordinate pairs representing regions.",
+    ),
+    tags: z.string().optional().describe(
+      "A comma-separated list of tags to assign to the resource.",
+    ),
+    unique_display_name: z.boolean().default(false).describe(
+      "Whether to ensure the display name is unique across all resources. If false, the operation will fail if a resource with the same display name exists. Default: false",
+    ),
+    visual_search: z.boolean().optional().describe(
+      "Whether to index the resource with visual search. If true, the resource will be indexed for visual search capabilities. Default: false",
+    ),
   });

package/src/models/restoreresourcesbyassetidsop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ce48bda9c502
  */
 
 import * as z from "zod";
@@ -29,9 +30,15 @@ export type RestoreResourcesByAssetIDsRequest = {
 export const RestoreResourcesByAssetIDsRequest$zodSchema: z.ZodType<
   RestoreResourcesByAssetIDsRequest
 > = z.object({
-  asset_ids: z.array(z.string()),
-  notification_url: z.string().optional(),
-  versions: z.array(z.string()).optional(),
+  asset_ids: z.array(z.string()).describe(
+    "The unique and immutable asset IDs of backed up assets to restore.",
+  ),
+  notification_url: z.string().optional().describe(
+    "The URL that will receive notification when restore is complete.",
+  ),
+  versions: z.array(z.string()).optional().describe(
+    "If you specify versions, the number of versions in the array must exactly match the number of asset_ids.",
+  ),
 });
 
 export type RestoreResourcesByAssetIDsResponse = ApiError | {

package/src/models/restoreresponseunion.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f4606fb493f8
  */
 
 import * as z from "zod";
@@ -28,7 +29,9 @@ export const ErrorEnum$zodSchema = z.enum([
 export type RestoreResponse = { error?: ErrorEnum | undefined };
 
 export const RestoreResponse$zodSchema: z.ZodType<RestoreResponse> = z.object({
-  error: ErrorEnum$zodSchema.optional(),
+  error: ErrorEnum$zodSchema.optional().describe(
+    "The error message if restore failed for a specific asset.",
+  ),
 });
 
 export type RestoreResponseUnion = Info | RestoreResponse;

package/src/models/schemecloudinaryauth.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 12cfe3c34e03
  */
 
 import * as z from "zod";

package/src/models/searchassetsop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 19a313de27e8
  */
 
 import * as z from "zod";

package/src/models/searchfoldersop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6b80d45f0574
  */
 
 import * as z from "zod";
@@ -46,7 +47,9 @@ export const SearchFoldersRequest$zodSchema: z.ZodType<SearchFoldersRequest> = z
     expression: z.union([
       z.string(),
       z.lazy(() => Expression$zodSchema),
-    ]).optional(),
+    ]).optional().describe(
+      "The (Lucene-like) string expression specifying the search query, or an object for advanced queries. If not passed, returns all folders (up to max_results).",
+    ),
     max_results: z.int().default(50).describe(
       "Maximum number of folders to return (max 500, default 50).",
     ),

package/src/models/searchfolderspostop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 39cf71b58fa3
  */
 
 import * as z from "zod";
@@ -28,10 +29,18 @@ export type SearchFoldersPostRequest = {
 export const SearchFoldersPostRequest$zodSchema: z.ZodType<
   SearchFoldersPostRequest
 > = z.object({
-  expression: z.string().optional(),
-  max_results: z.int().default(50),
-  next_cursor: z.string().optional(),
-  sort_by: z.array(z.string()).optional(),
+  expression: z.string().optional().describe(
+    "The (Lucene-like) string expression specifying the search query.",
+  ),
+  max_results: z.int().default(50).describe(
+    "Maximum number of folders to return (max 500, default 50).",
+  ),
+  next_cursor: z.string().optional().describe(
+    "When more results are available, use the next_cursor value from the previous response.",
+  ),
+  sort_by: z.array(z.string()).optional().describe(
+    "An array of key-value pairs for sorting. Each value is a key and direction (asc/desc).",
+  ),
 });
 
 export type SearchFoldersPostResponse = FoldersSearchResponse | ApiError;

package/src/models/searchparameters.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 31420f097d62
  */
 
 import * as z from "zod";
@@ -28,8 +29,8 @@ export type SearchParametersRange = {
 
 export const SearchParametersRange$zodSchema: z.ZodType<SearchParametersRange> =
   z.object({
-    from: z.number().optional(),
-    to: z.number().optional(),
+    from: z.number().optional().describe("Start of the range (inclusive)"),
+    to: z.number().optional().describe("End of the range (exclusive)"),
   });
 
 export type Aggregate = {
@@ -102,11 +103,24 @@ export const SearchParameters$zodSchema: z.ZodType<SearchParameters> = z.object(
       z.array(AggregateEnum$zodSchema),
       z.array(z.lazy(() => Aggregate$zodSchema)),
     ]).optional(),
-    expression: z.string().optional(),
-    fields: z.string().optional(),
-    max_results: z.int().optional(),
-    next_cursor: z.string().optional(),
-    sort_by: z.array(z.record(z.string(), SearchSortPair$zodSchema)).optional(),
-    with_field: z.array(WithField$zodSchema).optional(),
+    expression: z.string().optional().describe(
+      "The search expression. Supports exact match, wildcard match, presence, greater/less than, and range. For details on building expressions, see the Search API documentation.",
+    ),
+    fields: z.string().optional().describe(
+      "A comma-separated list of fields to include in the response.\nNotes:\n- This parameter takes precedence over the with_field parameter, so if you want any additional asset attributes returned, make sure to also include them in this list (e.g., tags or context).\n- The following fields are always included in the response: public_id, asset_id, asset_folder, created_at, status, type, and resource_type.\n",
+    ),
+    max_results: z.int().optional().describe(
+      "The maximum number of results to return. Default - 50. Maximum - 500.",
+    ),
+    next_cursor: z.string().optional().describe(
+      "The cursor value to get the next page of results. Available when a previous search returned more results than max_results.",
+    ),
+    sort_by: z.array(z.record(z.string(), SearchSortPair$zodSchema)).optional()
+      .describe(
+        "An array of single-key objects mapping a field to a sort direction. Each object must contain exactly one field name mapped to 'asc' or 'desc'.\nDefault: [{\"created_at\": \"desc\"}].\n",
+      ),
+    with_field: z.array(WithField$zodSchema).optional().describe(
+      "The additional fields to include in the response. Note that the fields parameter takes precedence over this parameter.",
+    ),
   },
 ).describe("Common parameters for resource search operations.");