@cloudinary/asset-management-mcp 0.7.0 → 0.8.1

package/src/models/deletebackupversionsop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 99224d013801
  */
 
 import * as z from "zod";
@@ -19,7 +20,9 @@ export type DeleteBackupVersionsRequestBody = { version_ids: Array<string> };
 export const DeleteBackupVersionsRequestBody$zodSchema: z.ZodType<
   DeleteBackupVersionsRequestBody
 > = z.object({
-  version_ids: z.array(z.string()),
+  version_ids: z.array(z.string()).describe(
+    "The list of version IDs to delete from backup.",
+  ),
 });
 
 export type DeleteBackupVersionsRequest = {
@@ -42,8 +45,12 @@ export type Failure = {
 };
 
 export const Failure$zodSchema: z.ZodType<Failure> = z.object({
-  error: z.string().optional(),
-  version_id: z.string().optional(),
+  error: z.string().optional().describe(
+    "The error message explaining the failure.",
+  ),
+  version_id: z.string().optional().describe(
+    "The version ID that failed to delete.",
+  ),
 });
 
 /**
@@ -58,9 +65,13 @@ export type DeleteBackupVersionsResponseBody2 = {
 export const DeleteBackupVersionsResponseBody2$zodSchema: z.ZodType<
   DeleteBackupVersionsResponseBody2
 > = z.object({
-  asset_id: z.string(),
-  deleted_version_ids: z.array(z.string()),
-  failures: z.array(z.lazy(() => Failure$zodSchema)).optional(),
+  asset_id: z.string().describe("The asset ID of the resource."),
+  deleted_version_ids: z.array(z.string()).describe(
+    "The list of version IDs that were successfully deleted.",
+  ),
+  failures: z.array(z.lazy(() => Failure$zodSchema)).optional().describe(
+    "The list of version IDs that failed to delete with error messages.",
+  ),
 }).describe("Multi-status - some versions deleted successfully, others failed");
 
 /**
@@ -74,8 +85,10 @@ export type DeleteBackupVersionsResponseBody1 = {
 export const DeleteBackupVersionsResponseBody1$zodSchema: z.ZodType<
   DeleteBackupVersionsResponseBody1
 > = z.object({
-  asset_id: z.string(),
-  deleted_version_ids: z.array(z.string()),
+  asset_id: z.string().describe("The asset ID of the resource."),
+  deleted_version_ids: z.array(z.string()).describe(
+    "The list of version IDs that were successfully deleted.",
+  ),
 }).describe("Backup versions successfully deleted");
 
 export type DeleteBackupVersionsResponse =

package/src/models/deleteresourcebypublicidsrequestunion.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f609f3bcbc44
  */
 
 import * as z from "zod";
@@ -42,15 +43,31 @@ export type DeleteResourceByPublicIdsRequest3 = {
 export const DeleteResourceByPublicIdsRequest3$zodSchema: z.ZodType<
   DeleteResourceByPublicIdsRequest3
 > = z.object({
-  all: z.boolean(),
-  invalidate: z.boolean().default(false),
-  keep_original: z.boolean().default(false),
-  next_cursor: z.string().optional(),
-  prefix: z.string().optional(),
-  public_ids: z.array(z.string()).optional(),
+  all: z.boolean().describe(
+    "Delete all assets (of the relevant resource_type and type), including derived assets (up to a maximum of 1000 original resources).",
+  ),
+  invalidate: z.boolean().default(false).describe(
+    "Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. Default: false.",
+  ),
+  keep_original: z.boolean().default(false).describe(
+    "Whether to delete only the derived assets. Default: false.",
+  ),
+  next_cursor: z.string().optional().describe(
+    "(Only when deleting by prefix or all) When a deletion request has more than 1000 resources to delete, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request.",
+  ),
+  prefix: z.string().optional().describe(
+    "Delete all assets, including derived assets, where the public ID starts with the specified prefix (up to a maximum of 1000 original resources).",
+  ),
+  public_ids: z.array(z.string()).optional().describe(
+    "A list of public IDs of the resources to delete.",
+  ),
   resource_type: DeleteResourceByPublicIdsRequestResourceType3$zodSchema
-    .default("image"),
-  transformations: z.string().optional(),
+    .default("image").describe(
+      "The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note: use video for all video and audio assets, such as .mp3. Default: image.",
+    ),
+  transformations: z.string().optional().describe(
+    "Only the derived assets matching this hash of transformation parameters will be deleted. You can include multiple transformations separated by a pipe character (|).",
+  ),
 });
 
 /**
@@ -90,15 +107,31 @@ export type DeleteResourceByPublicIdsRequest2 = {
 export const DeleteResourceByPublicIdsRequest2$zodSchema: z.ZodType<
   DeleteResourceByPublicIdsRequest2
 > = z.object({
-  all: z.boolean().optional(),
-  invalidate: z.boolean().default(false),
-  keep_original: z.boolean().default(false),
-  next_cursor: z.string().optional(),
-  prefix: z.string(),
-  public_ids: z.array(z.string()).optional(),
+  all: z.boolean().optional().describe(
+    "Delete all assets (of the relevant resource_type and type), including derived assets (up to a maximum of 1000 original resources).",
+  ),
+  invalidate: z.boolean().default(false).describe(
+    "Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. Default: false.",
+  ),
+  keep_original: z.boolean().default(false).describe(
+    "Whether to delete only the derived assets. Default: false.",
+  ),
+  next_cursor: z.string().optional().describe(
+    "(Only when deleting by prefix or all) When a deletion request has more than 1000 resources to delete, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request.",
+  ),
+  prefix: z.string().describe(
+    "Delete all assets, including derived assets, where the public ID starts with the specified prefix (up to a maximum of 1000 original resources).",
+  ),
+  public_ids: z.array(z.string()).optional().describe(
+    "A list of public IDs of the resources to delete.",
+  ),
   resource_type: DeleteResourceByPublicIdsRequestResourceType2$zodSchema
-    .default("image"),
-  transformations: z.string().optional(),
+    .default("image").describe(
+      "The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note: use video for all video and audio assets, such as .mp3. Default: image.",
+    ),
+  transformations: z.string().optional().describe(
+    "Only the derived assets matching this hash of transformation parameters will be deleted. You can include multiple transformations separated by a pipe character (|).",
+  ),
 });
 
 /**
@@ -138,15 +171,31 @@ export type DeleteResourceByPublicIdsRequest1 = {
 export const DeleteResourceByPublicIdsRequest1$zodSchema: z.ZodType<
   DeleteResourceByPublicIdsRequest1
 > = z.object({
-  all: z.boolean().optional(),
-  invalidate: z.boolean().default(false),
-  keep_original: z.boolean().default(false),
-  next_cursor: z.string().optional(),
-  prefix: z.string().optional(),
-  public_ids: z.array(z.string()),
+  all: z.boolean().optional().describe(
+    "Delete all assets (of the relevant resource_type and type), including derived assets (up to a maximum of 1000 original resources).",
+  ),
+  invalidate: z.boolean().default(false).describe(
+    "Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. Default: false.",
+  ),
+  keep_original: z.boolean().default(false).describe(
+    "Whether to delete only the derived assets. Default: false.",
+  ),
+  next_cursor: z.string().optional().describe(
+    "(Only when deleting by prefix or all) When a deletion request has more than 1000 resources to delete, the response includes the partial boolean parameter set to true, as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request.",
+  ),
+  prefix: z.string().optional().describe(
+    "Delete all assets, including derived assets, where the public ID starts with the specified prefix (up to a maximum of 1000 original resources).",
+  ),
+  public_ids: z.array(z.string()).describe(
+    "A list of public IDs of the resources to delete.",
+  ),
   resource_type: DeleteResourceByPublicIdsRequestResourceType1$zodSchema
-    .default("image"),
-  transformations: z.string().optional(),
+    .default("image").describe(
+      "The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note: use video for all video and audio assets, such as .mp3. Default: image.",
+    ),
+  transformations: z.string().optional().describe(
+    "Only the derived assets matching this hash of transformation parameters will be deleted. You can include multiple transformations separated by a pipe character (|).",
+  ),
 });
 
 export type DeleteResourceByPublicIdsRequestUnion =

package/src/models/deleteresourcesbypublicidop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cf9aed5b5a91
  */
 
 import * as z from "zod";
@@ -36,8 +37,10 @@ export const DeleteResourcesByPublicIdRequest$zodSchema: z.ZodType<
 > = z.object({
   DeleteResourceByPublicIdsRequest:
     DeleteResourceByPublicIdsRequestUnion$zodSchema,
-  resource_type: ResourceType$zodSchema,
-  type: ExtendedStorageType$zodSchema,
+  resource_type: ResourceType$zodSchema.describe("The type of resource."),
+  type: ExtendedStorageType$zodSchema.describe(
+    "The extended storage type of the resource.",
+  ),
 });
 
 /**

package/src/models/deriveddestroyop.ts

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

package/src/models/deriveddestroyrequest.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a8abf23f07f1
  */
 
 import * as z from "zod";
@@ -14,6 +15,10 @@ export type DerivedDestroyRequest = {
 
 export const DerivedDestroyRequest$zodSchema: z.ZodType<DerivedDestroyRequest> =
   z.object({
-    derived_resource_ids: z.array(z.string()),
-    invalidate: z.boolean().optional(),
+    derived_resource_ids: z.array(z.string()).describe(
+      "Array of derived resource IDs to delete specific derived resources",
+    ),
+    invalidate: z.boolean().optional().describe(
+      "Whether to invalidate the CDN cache for the deleted resources",
+    ),
   }).describe("Request parameters for deleting derived resources");

package/src/models/deriveddestroyresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9a631d609b52
  */
 
 import * as z from "zod";
@@ -22,8 +23,12 @@ export type Invalidation = {
 };
 
 export const Invalidation$zodSchema: z.ZodType<Invalidation> = z.object({
-  took: z.number().optional(),
-  urls: z.array(z.string()).optional(),
+  took: z.number().optional().describe(
+    "Time taken for CDN invalidation in seconds",
+  ),
+  urls: z.array(z.string()).optional().describe(
+    "Array of URLs that were invalidated",
+  ),
 });
 
 /**
@@ -38,7 +43,11 @@ export type DerivedDestroyResponse = {
 export const DerivedDestroyResponse$zodSchema: z.ZodType<
   DerivedDestroyResponse
 > = z.object({
-  deleted: z.record(z.string(), Deleted$zodSchema).optional(),
+  deleted: z.record(z.string(), Deleted$zodSchema).optional().describe(
+    "Map of derived resource IDs to deletion status",
+  ),
   invalidation: z.lazy(() => Invalidation$zodSchema).optional(),
-  unauthorized: z.array(z.string()).optional(),
+  unauthorized: z.array(z.string()).optional().describe(
+    "Array of derived resource IDs that were not authorized to be deleted",
+  ),
 }).describe("Response for derived resource deletion");

package/src/models/destroyassetop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e8b735f037d4
  */
 
 import * as z from "zod";
@@ -28,26 +29,28 @@ export const DestroyAssetRequest$zodSchema: z.ZodType<DestroyAssetRequest> = z
       "Whether to invalidate CDN cached copies of the asset",
     ),
     public_id: z.string().describe("The public ID of the asset."),
-    resource_type: ResourceType$zodSchema,
+    resource_type: ResourceType$zodSchema.describe("The type of resource."),
   });
 
 /**
- * Indicates successful deletion
+ * Result of the deletion operation
  */
 export const DestroyAssetResult = {
   Ok: "ok",
+  NotFound: "not found",
 } as const;
 /**
- * Indicates successful deletion
+ * Result of the deletion operation
  */
 export type DestroyAssetResult = ClosedEnum<typeof DestroyAssetResult>;
 
 export const DestroyAssetResult$zodSchema = z.enum([
   "ok",
-]).describe("Indicates successful deletion");
+  "not found",
+]).describe("Result of the deletion operation");
 
 /**
- * Asset/resource destroyed successfully
+ * Asset/resource destroyed successfully or not found
  */
 export type DestroyAssetResponseBody = {
   result?: DestroyAssetResult | undefined;
@@ -56,8 +59,10 @@ export type DestroyAssetResponseBody = {
 export const DestroyAssetResponseBody$zodSchema: z.ZodType<
   DestroyAssetResponseBody
 > = z.object({
-  result: DestroyAssetResult$zodSchema.optional(),
-}).describe("Asset/resource destroyed successfully");
+  result: DestroyAssetResult$zodSchema.optional().describe(
+    "Result of the deletion operation",
+  ),
+}).describe("Asset/resource destroyed successfully or not found");
 
 export type DestroyAssetResponse = ApiError | DestroyAssetResponseBody;
 

package/src/models/destroybyassetidop.ts

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

package/src/models/destroyfolderop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 729a07413143
  */
 
 import * as z from "zod";
@@ -29,7 +30,7 @@ export type DestroyFolderResponseBody = { deleted: Array<string> };
 export const DestroyFolderResponseBody$zodSchema: z.ZodType<
   DestroyFolderResponseBody
 > = z.object({
-  deleted: z.array(z.string()),
+  deleted: z.array(z.string()).describe("List of deleted folder paths"),
 }).describe("Folder deleted successfully");
 
 export type DestroyFolderResponse = DestroyFolderResponseBody | ApiError;

package/src/models/destroyrequest.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 55d8b3c6e136
  */
 
 import * as z from "zod";
@@ -15,11 +16,23 @@ export type DestroyRequest = {
 };
 
 export const DestroyRequest$zodSchema: z.ZodType<DestroyRequest> = z.object({
-  api_key: z.string().optional(),
-  asset_id: z.string(),
-  callback: z.string().optional(),
-  invalidate: z.boolean().optional(),
-  notification_url: z.string().optional(),
-  signature: z.string().optional(),
-  timestamp: z.int().optional(),
+  api_key: z.string().optional().describe(
+    "The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.",
+  ),
+  asset_id: z.string().describe("The ID of the asset to delete."),
+  callback: z.string().optional().describe(
+    "URL for redirect after operation completion.",
+  ),
+  invalidate: z.boolean().optional().describe(
+    "Whether to invalidate CDN cache. Default is false.",
+  ),
+  notification_url: z.string().optional().describe(
+    "URL to receive completion notification.",
+  ),
+  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.",
+  ),
 });

package/src/models/destroyresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d820256ef5c9
  */
 
 import * as z from "zod";
@@ -28,6 +29,8 @@ export type DestroyResponse = {
 };
 
 export const DestroyResponse$zodSchema: z.ZodType<DestroyResponse> = z.object({
-  asset_folder: z.string().optional(),
-  result: Result$zodSchema,
+  asset_folder: z.string().optional().describe(
+    "The asset folder path. Only included when folder decoupling is enabled.",
+  ),
+  result: Result$zodSchema.describe("The result of the deletion operation."),
 });

package/src/models/direction.ts

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

package/src/models/downloadassetop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dee26fb4539d
  */
 
 import * as z from "zod";
@@ -46,7 +47,7 @@ export const DownloadAssetRequest$zodSchema: z.ZodType<DownloadAssetRequest> = z
       "The format to convert the asset to before downloading.",
     ).optional(),
     public_id: z.string().describe("The public ID of the asset."),
-    resource_type: ResourceType$zodSchema,
+    resource_type: ResourceType$zodSchema.describe("The type of resource."),
     signature: z.string().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",
     ).optional(),
@@ -59,7 +60,9 @@ export const DownloadAssetRequest$zodSchema: z.ZodType<DownloadAssetRequest> = z
     transformation: z.string().describe(
       "A transformation to apply to the asset before downloading.",
     ).optional(),
-    type: StorageType$zodSchema.optional(),
+    type: StorageType$zodSchema.optional().describe(
+      "The storage type of the asset. Default is \"upload\".",
+    ),
   });
 
 export type DownloadAssetResponse =

package/src/models/downloadbackupassetop.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 363c7ad4fafa
  */
 
 import * as z from "zod";
@@ -45,7 +46,7 @@ export const DownloadBackupAssetRequest$zodSchema: z.ZodType<
 export type NotFoundError = { message?: string | undefined };
 
 export const NotFoundError$zodSchema: z.ZodType<NotFoundError> = z.object({
-  message: z.string().optional(),
+  message: z.string().optional().describe("Specified version does not exist"),
 });
 
 /**
@@ -69,8 +70,10 @@ export type DownloadBackupAssetUnauthorizedError = {
 export const DownloadBackupAssetUnauthorizedError$zodSchema: z.ZodType<
   DownloadBackupAssetUnauthorizedError
 > = z.object({
-  http_code: z.int().optional(),
-  message: z.string().optional(),
+  http_code: z.int().optional().describe("The HTTP status code."),
+  message: z.string().optional().describe(
+    "Invalid Signature or timestamp expired.",
+  ),
 });
 
 /**
@@ -93,8 +96,10 @@ export type BadRequestError = {
 };
 
 export const BadRequestError$zodSchema: z.ZodType<BadRequestError> = z.object({
-  http_code: z.int().optional(),
-  message: z.string().optional(),
+  http_code: z.int().optional().describe("The HTTP status code."),
+  message: z.string().optional().describe(
+    "A problem with one of the parameters or timestamp.",
+  ),
 });
 
 /**

package/src/models/errors/apierror.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e2280e075454
  */
 
 export class APIError extends Error {

package/src/models/errors/httpclienterrors.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6948de76af99
  */
 
 /**

package/src/models/errors/sdkvalidationerror.ts

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