uploadUpload.ts•5.73 kB
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { SDKCore } 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 {
UploadRequestRequest,
UploadRequestRequest$zodSchema,
UploadResponseResponse,
UploadResponseResponse$zodSchema,
} from "../models/uploadop.js";
import { APICall, APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
export enum UploadAcceptEnum {
applicationJsonAccept = "application/json",
textHtmlAccept = "text/html",
}
/**
* Uploads media assets (images, videos, raw files) to your Cloudinary product environment
*
* @remarks
* Uploads media assets (images, videos, raw files) to your Cloudinary product environment. The file is securely stored
* in the cloud with backup and revision history. Cloudinary automatically analyzes and saves important data about each
* asset, such as format, size, resolution, and prominent colors, which is indexed to enable searching on those attributes.
*
* Supports uploading from:
* - Local file paths (SDKs/MCP server only). For MCP server path MUST start with file://
* - Remote HTTP/HTTPS URLs
* - Base64 Data URIs (max ~60 MB)
* - Private storage buckets (S3 or Google Storage)
* - FTP addresses
*
* The uploaded asset is immediately available for transformation and delivery upon successful upload.
*/
export function uploadUpload(
client$: SDKCore,
request: UploadRequestRequest,
options?: RequestOptions,
): APIPromise<
Result<
UploadResponseResponse,
| APIError
| SDKValidationError
| UnexpectedClientError
| InvalidRequestError
| RequestAbortedError
| RequestTimeoutError
| ConnectionError
>
> {
return new APIPromise($do(
client$,
request,
options,
));
}
async function $do(
client$: SDKCore,
request: UploadRequestRequest,
options?: RequestOptions & { acceptHeaderOverride?: UploadAcceptEnum },
): Promise<
[
Result<
UploadResponseResponse,
| APIError
| SDKValidationError
| UnexpectedClientError
| InvalidRequestError
| RequestAbortedError
| RequestTimeoutError
| ConnectionError
>,
APICall,
]
> {
const parsed$ = safeParse(
request,
(value$) => UploadRequestRequest$zodSchema.parse(value$),
"Input validation failed",
);
if (!parsed$.ok) {
return [parsed$, { status: "invalid" }];
}
const payload$ = parsed$.value;
const body$ = encodeJSON("body", payload$.upload_request, { 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}/upload")(
pathParams$,
);
const headers$ = new Headers(compactMap({
"Content-Type": "application/json",
Accept: options?.acceptHeaderOverride
|| "application/json;q=1, text/html;q=0",
}));
const securityInput = await extractSecurity(client$._options.security);
const requestSecurity = resolveGlobalSecurity(securityInput);
const context = {
baseURL: options?.serverURL ?? client$._baseURL ?? "",
operationID: "upload",
oAuth2Scopes: [],
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$,
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<
UploadResponseResponse,
| APIError
| SDKValidationError
| UnexpectedClientError
| InvalidRequestError
| RequestAbortedError
| RequestTimeoutError
| ConnectionError
>(
M.json(200, UploadResponseResponse$zodSchema, { key: "oneOf" }),
M.text(302, UploadResponseResponse$zodSchema, {
ctype: "text/html",
key: "html_redirect",
}),
M.json([400, 401, 403, 404], UploadResponseResponse$zodSchema, {
key: "api_error",
}),
)(response, req$, { extraFields: responseFields$ });
return [result$, { status: "complete", request: req$, response }];
}