@cloudinary/asset-management-mcp 0.6.0

package/src/funcs/assetsDownloadAsset.ts

@@ -0,0 +1,250 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CloudinaryAssetMgmtCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  DownloadAssetRequest,
+  DownloadAssetRequest$zodSchema,
+  DownloadAssetResponse,
+  DownloadAssetResponse$zodSchema,
+} from "../models/downloadassetop.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { ResourceType } from "../models/resourcetype.js";
+import { StorageType } from "../models/storagetype.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum DownloadAssetAcceptEnum {
+  applicationJsonAccept = "application/json",
+  applicationOctetStreamAccept = "application/octet-stream",
+  videoWildcardAccept = "video/*",
+  imageWildcardAccept = "image/*",
+}
+
+/**
+ * Generates a download link for a specific asset (image)
+ */
+export function assetsDownloadAsset(
+  client$: CloudinaryAssetMgmtCore,
+  resource_type: ResourceType,
+  public_id: string,
+  format?: string | undefined,
+  type?: StorageType | undefined,
+  expires_at?: number | undefined,
+  attachment?: boolean | undefined,
+  target_filename?: string | undefined,
+  transformation?: string | undefined,
+  api_key?: string | undefined,
+  signature?: string | undefined,
+  timestamp?: number | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    DownloadAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    resource_type,
+    public_id,
+    format,
+    type,
+    expires_at,
+    attachment,
+    target_filename,
+    transformation,
+    api_key,
+    signature,
+    timestamp,
+    options,
+  ));
+}
+
+async function $do(
+  client$: CloudinaryAssetMgmtCore,
+  resource_type: ResourceType,
+  public_id: string,
+  format?: string | undefined,
+  type?: StorageType | undefined,
+  expires_at?: number | undefined,
+  attachment?: boolean | undefined,
+  target_filename?: string | undefined,
+  transformation?: string | undefined,
+  api_key?: string | undefined,
+  signature?: string | undefined,
+  timestamp?: number | undefined,
+  options?: RequestOptions & { acceptHeaderOverride?: DownloadAssetAcceptEnum },
+): Promise<
+  [
+    Result<
+      DownloadAssetResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input$: DownloadAssetRequest = {
+    resource_type: resource_type,
+    public_id: public_id,
+    format: format,
+    type: type,
+    expires_at: expires_at,
+    attachment: attachment,
+    target_filename: target_filename,
+    transformation: transformation,
+    api_key: api_key,
+    signature: signature,
+    timestamp: timestamp,
+  };
+
+  const parsed$ = safeParse(
+    input$,
+    (value$) => DownloadAssetRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    cloud_name: encodeSimple("cloud_name", client$._options.cloud_name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    resource_type: encodeSimple("resource_type", payload$.resource_type, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/v1_1/{cloud_name}/{resource_type}/download")(
+    pathParams$,
+  );
+  const query$ = encodeFormQuery({
+    "api_key": payload$.api_key,
+    "attachment": payload$.attachment,
+    "expires_at": payload$.expires_at,
+    "format": payload$.format,
+    "public_id": payload$.public_id,
+    "signature": payload$.signature,
+    "target_filename": payload$.target_filename,
+    "timestamp": payload$.timestamp,
+    "transformation": payload$.transformation,
+    "type": payload$.type,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, application/octet-stream;q=0.8, video/*;q=0.5, image/*;q=0",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "downloadAsset",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    DownloadAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.bytes(200, DownloadAssetResponse$zodSchema, {
+      key: "twoHundredApplicationOctetStreamBytes",
+    }),
+    M.bytes(200, DownloadAssetResponse$zodSchema, {
+      ctype: "image/*",
+      key: "twoHundredImageWildcardBytes",
+    }),
+    M.bytes(200, DownloadAssetResponse$zodSchema, {
+      ctype: "video/*",
+      key: "twoHundredVideoWildcardBytes",
+    }),
+    M.json([400, 401, 403, 404], DownloadAssetResponse$zodSchema, {
+      key: "api_error",
+    }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/funcs/assetsDownloadBackupAsset.ts

@@ -0,0 +1,228 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CloudinaryAssetMgmtCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  DownloadBackupAssetRequest,
+  DownloadBackupAssetRequest$zodSchema,
+  DownloadBackupAssetResponse,
+  DownloadBackupAssetResponse$zodSchema,
+} from "../models/downloadbackupassetop.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum DownloadBackupAssetAcceptEnum {
+  applicationJsonAccept = "application/json",
+  textPlainAccept = "text/plain",
+  applicationOctetStreamAccept = "application/octet-stream",
+  videoWildcardAccept = "video/*",
+  imageWildcardAccept = "image/*",
+}
+
+/**
+ * Download a backup copy of an asset
+ */
+export function assetsDownloadBackupAsset(
+  client$: CloudinaryAssetMgmtCore,
+  asset_id: string,
+  version_id: string,
+  api_key?: string | undefined,
+  signature?: string | undefined,
+  timestamp?: number | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    DownloadBackupAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    asset_id,
+    version_id,
+    api_key,
+    signature,
+    timestamp,
+    options,
+  ));
+}
+
+async function $do(
+  client$: CloudinaryAssetMgmtCore,
+  asset_id: string,
+  version_id: string,
+  api_key?: string | undefined,
+  signature?: string | undefined,
+  timestamp?: number | undefined,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: DownloadBackupAssetAcceptEnum;
+  },
+): Promise<
+  [
+    Result<
+      DownloadBackupAssetResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input$: DownloadBackupAssetRequest = {
+    asset_id: asset_id,
+    version_id: version_id,
+    api_key: api_key,
+    signature: signature,
+    timestamp: timestamp,
+  };
+
+  const parsed$ = safeParse(
+    input$,
+    (value$) => DownloadBackupAssetRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    cloud_name: encodeSimple("cloud_name", client$._options.cloud_name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/v1_1/{cloud_name}/download_backup")(
+    pathParams$,
+  );
+  const query$ = encodeFormQuery({
+    "api_key": payload$.api_key,
+    "asset_id": payload$.asset_id,
+    "signature": payload$.signature,
+    "timestamp": payload$.timestamp,
+    "version_id": payload$.version_id,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/plain;q=0.8, application/octet-stream;q=0.6, video/*;q=0.4, image/*;q=0",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "downloadBackupAsset",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    DownloadBackupAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.bytes(200, DownloadBackupAssetResponse$zodSchema, {
+      key: "twoHundredApplicationOctetStreamBytes",
+    }),
+    M.bytes(200, DownloadBackupAssetResponse$zodSchema, {
+      ctype: "text/plain",
+      key: "twoHundredTextPlainBytes",
+    }),
+    M.bytes(200, DownloadBackupAssetResponse$zodSchema, {
+      ctype: "image/*",
+      key: "twoHundredImageWildcardBytes",
+    }),
+    M.bytes(200, DownloadBackupAssetResponse$zodSchema, {
+      ctype: "video/*",
+      key: "twoHundredVideoWildcardBytes",
+    }),
+    M.json(400, DownloadBackupAssetResponse$zodSchema, {
+      key: "fourHundredApplicationJsonObject",
+    }),
+    M.json(401, DownloadBackupAssetResponse$zodSchema, {
+      key: "fourHundredAndOneApplicationJsonObject",
+    }),
+    M.json(404, DownloadBackupAssetResponse$zodSchema, {
+      key: "fourHundredAndFourApplicationJsonObject",
+    }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/funcs/assetsExplicitAsset.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CloudinaryAssetMgmtCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  ExplicitAssetRequest,
+  ExplicitAssetRequest$zodSchema,
+  ExplicitAssetRequestBody,
+  ExplicitAssetResponse,
+  ExplicitAssetResponse$zodSchema,
+} from "../models/explicitassetop.js";
+import { ResourceType } from "../models/resourcetype.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Apply operations on an existing asset
+ *
+ * @remarks
+ * Applies actions such as transformations, tags, or metadata updates to an existing asset without re-uploading it.
+ * This is useful for applying new transformations, adding tags, or updating metadata on assets that are already in your cloud.
+ *
+ * Note: Always prefer delivery URL transformations over this method, unless eager transformations are specifically required.
+ */
+export function assetsExplicitAsset(
+  client$: CloudinaryAssetMgmtCore,
+  resource_type: ResourceType,
+  RequestBody: ExplicitAssetRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    ExplicitAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    resource_type,
+    RequestBody,
+    options,
+  ));
+}
+
+async function $do(
+  client$: CloudinaryAssetMgmtCore,
+  resource_type: ResourceType,
+  RequestBody: ExplicitAssetRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      ExplicitAssetResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input$: ExplicitAssetRequest = {
+    resource_type: resource_type,
+    RequestBody: RequestBody,
+  };
+
+  const parsed$ = safeParse(
+    input$,
+    (value$) => ExplicitAssetRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = encodeJSON("body", payload$.RequestBody, { explode: true });
+
+  const pathParams$ = {
+    cloud_name: encodeSimple("cloud_name", client$._options.cloud_name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    resource_type: encodeSimple("resource_type", payload$.resource_type, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/v1_1/{cloud_name}/{resource_type}/explicit")(
+    pathParams$,
+  );
+
+  const headers$ = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "explicitAsset",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    ExplicitAssetResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, ExplicitAssetResponse$zodSchema, { key: "upload_response" }),
+    M.json([400, 401, 403, 404], ExplicitAssetResponse$zodSchema, {
+      key: "api_error",
+    }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}