@cloudinary/apps-api 2.2605.49

package/dist/esm/apis/MediaApi.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.49
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AiVisionGeneralResponse, AnalyzeAiVisionGeneralRequest, FontLookupResponse, FontProvisioningResponse, GoogleFontListingResponse, LookupFontRequest, PrepareUploadRequest, PrepareUploadResponse, ProvisionFontRequest, SignAndUploadResponse, ThumbnailsTokenResponse, UploadAssetResponse } from '../models/index';
+export interface MediaApiAnalyzeAiVisionGeneralOperationRequest {
+    analyzeAiVisionGeneralRequest?: AnalyzeAiVisionGeneralRequest;
+}
+export interface MediaApiCreateThumbnailTokenRequest {
+    validFor?: number;
+}
+export interface MediaApiGetThumbnailRequest {
+    resourceType: GetThumbnailResourceTypeEnum;
+    type: GetThumbnailTypeEnum;
+    version: string;
+    variant: GetThumbnailVariantEnum;
+    publicId: string;
+    token?: string;
+}
+export interface MediaApiLookupFontOperationRequest {
+    lookupFontRequest?: LookupFontRequest;
+}
+export interface MediaApiPrepareUploadOperationRequest {
+    prepareUploadRequest?: PrepareUploadRequest;
+}
+export interface MediaApiProvisionFontOperationRequest {
+    provisionFontRequest?: ProvisionFontRequest;
+}
+export interface MediaApiSignAndUploadRequest {
+    file: Blob;
+    resourceType?: string;
+    publicId?: string;
+    folder?: string;
+    assetFolder?: string;
+    tags?: string;
+    type?: string;
+    overwrite?: string;
+    invalidate?: string;
+    context?: string;
+    metadata?: string;
+    transformation?: string;
+    format?: string;
+    eager?: string;
+    eagerAsync?: string;
+    eagerNotificationUrl?: string;
+    notificationUrl?: string;
+    displayName?: string;
+    useFilename?: string;
+    uniqueFilename?: string;
+    filenameOverride?: string;
+    accessMode?: string;
+    discardOriginalFilename?: string;
+    phash?: string;
+    async?: string;
+}
+export interface MediaApiUploadAssetRequest {
+    resourceType: string;
+    file: Blob;
+    signature: string;
+    apiKey: string;
+    timestamp?: string;
+    publicId?: string;
+    folder?: string;
+    tags?: string;
+    type?: string;
+    resourceType2?: string;
+    overwrite?: string;
+    invalidate?: string;
+    context?: string;
+    metadata?: string;
+    transformation?: string;
+    format?: string;
+    eager?: string;
+    async?: string;
+}
+/**
+ *
+ */
+export declare class MediaApi extends runtime.BaseAPI {
+    /**
+     * Proxies the public Cloudinary AI Vision Analyze API with the caller\'s OAuth token. Provide a source (uri or asset_id) and prompts; returns the model\'s responses. Requires the AI Vision add-on.
+     * Generate AI Vision analysis (e.g. alt text) for an asset
+     */
+    analyzeAiVisionGeneralRaw(requestParameters: MediaApiAnalyzeAiVisionGeneralOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiVisionGeneralResponse>>;
+    /**
+     * Proxies the public Cloudinary AI Vision Analyze API with the caller\'s OAuth token. Provide a source (uri or asset_id) and prompts; returns the model\'s responses. Requires the AI Vision add-on.
+     * Generate AI Vision analysis (e.g. alt text) for an asset
+     */
+    analyzeAiVisionGeneral(requestParameters?: MediaApiAnalyzeAiVisionGeneralOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiVisionGeneralResponse>;
+    /**
+     * Creates a short-lived token for authenticating thumbnail delivery requests. The token validity period defaults to the server setting but can be overridden with valid_for (in seconds).
+     * Generate a time-limited thumbnail access token
+     */
+    createThumbnailTokenRaw(requestParameters: MediaApiCreateThumbnailTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThumbnailsTokenResponse>>;
+    /**
+     * Creates a short-lived token for authenticating thumbnail delivery requests. The token validity period defaults to the server setting but can be overridden with valid_for (in seconds).
+     * Generate a time-limited thumbnail access token
+     */
+    createThumbnailToken(requestParameters?: MediaApiCreateThumbnailTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThumbnailsTokenResponse>;
+    /**
+     * Returns a pre-rendered thumbnail image for an asset in the specified variant (e.g. grid, preview, drilldown). Variant controls dimensions and format. If no token query param is provided, one is auto-generated.
+     * Fetch a rendered thumbnail for an asset
+     */
+    getThumbnailRaw(requestParameters: MediaApiGetThumbnailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns a pre-rendered thumbnail image for an asset in the specified variant (e.g. grid, preview, drilldown). Variant controls dimensions and format. If no token query param is provided, one is auto-generated.
+     * Fetch a rendered thumbnail for an asset
+     */
+    getThumbnail(requestParameters: MediaApiGetThumbnailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the full catalog of Google Web Fonts including font family name, available variants (weights/styles), and supported character subsets.
+     * List all available Google Web Fonts
+     */
+    listGoogleFontsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GoogleFontListingResponse>>;
+    /**
+     * Returns the full catalog of Google Web Fonts including font family name, available variants (weights/styles), and supported character subsets.
+     * List all available Google Web Fonts
+     */
+    listGoogleFonts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GoogleFontListingResponse>;
+    /**
+     * Checks whether each requested font is available as a Cloudinary system font or a Google Web Font. Returns resolution status and source for each font declaration.
+     * Look up font availability
+     */
+    lookupFontRaw(requestParameters: MediaApiLookupFontOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FontLookupResponse>>;
+    /**
+     * Checks whether each requested font is available as a Cloudinary system font or a Google Web Font. Returns resolution status and source for each font declaration.
+     * Look up font availability
+     */
+    lookupFont(requestParameters?: MediaApiLookupFontOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FontLookupResponse>;
+    /**
+     * Signs the provided upload parameters and returns a signature, api_key, and upload host. Use the returned credentials in a subsequent upload request. Requires Console authentication.
+     * Prepare and sign upload parameters
+     */
+    prepareUploadRaw(requestParameters: MediaApiPrepareUploadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PrepareUploadResponse>>;
+    /**
+     * Signs the provided upload parameters and returns a signature, api_key, and upload host. Use the returned credentials in a subsequent upload request. Requires Console authentication.
+     * Prepare and sign upload parameters
+     */
+    prepareUpload(requestParameters?: MediaApiPrepareUploadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PrepareUploadResponse>;
+    /**
+     * Resolves fonts against Cloudinary system fonts and Google Web Fonts, then uploads any Google-sourced fonts to the cloud (optionally into a target folder). Returns resolution details for each font. Requires OAuth authentication.
+     * Provision fonts into the cloud
+     */
+    provisionFontRaw(requestParameters: MediaApiProvisionFontOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FontProvisioningResponse>>;
+    /**
+     * Resolves fonts against Cloudinary system fonts and Google Web Fonts, then uploads any Google-sourced fonts to the cloud (optionally into a target folder). Returns resolution details for each font. Requires OAuth authentication.
+     * Provision fonts into the cloud
+     */
+    provisionFont(requestParameters?: MediaApiProvisionFontOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FontProvisioningResponse>;
+    /**
+     * Combines parameter signing and file upload into a single request. The gateway signs via Console API internally, then proxies the upload to Cloudinary. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires Console authentication.
+     * Sign and upload an asset in one step
+     */
+    signAndUploadRaw(requestParameters: MediaApiSignAndUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignAndUploadResponse>>;
+    /**
+     * Combines parameter signing and file upload into a single request. The gateway signs via Console API internally, then proxies the upload to Cloudinary. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires Console authentication.
+     * Sign and upload an asset in one step
+     */
+    signAndUpload(requestParameters: MediaApiSignAndUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignAndUploadResponse>;
+    /**
+     * Uploads a file to Cloudinary using a signature and api_key obtained from the prepare endpoint. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires OAuth authentication.
+     * Upload an asset with a pre-signed signature
+     */
+    uploadAssetRaw(requestParameters: MediaApiUploadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadAssetResponse>>;
+    /**
+     * Uploads a file to Cloudinary using a signature and api_key obtained from the prepare endpoint. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires OAuth authentication.
+     * Upload an asset with a pre-signed signature
+     */
+    uploadAsset(requestParameters: MediaApiUploadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadAssetResponse>;
+}
+/**
+ * @export
+ */
+export declare const GetThumbnailResourceTypeEnum: {
+    readonly Image: "image";
+    readonly Video: "video";
+    readonly Raw: "raw";
+};
+export type GetThumbnailResourceTypeEnum = typeof GetThumbnailResourceTypeEnum[keyof typeof GetThumbnailResourceTypeEnum];
+/**
+ * @export
+ */
+export declare const GetThumbnailTypeEnum: {
+    readonly Upload: "upload";
+    readonly Private: "private";
+    readonly Authenticated: "authenticated";
+};
+export type GetThumbnailTypeEnum = typeof GetThumbnailTypeEnum[keyof typeof GetThumbnailTypeEnum];
+/**
+ * @export
+ */
+export declare const GetThumbnailVariantEnum: {
+    readonly Grid: "grid";
+    readonly GridLandscape: "grid_landscape";
+    readonly GridSquare: "grid_square";
+    readonly GridAnimatedLandscape: "grid_animated_landscape";
+    readonly GridAnimatedSquare: "grid_animated_square";
+    readonly Preview: "preview";
+    readonly Drilldown: "drilldown";
+    readonly Template: "template";
+    readonly TemplatePrimary: "template_primary";
+    readonly FolderThumbnail: "folder_thumbnail";
+    readonly GetInfo: "get_info";
+    readonly List: "list";
+    readonly ListV2: "list_v2";
+    readonly Square90: "square90";
+    readonly GridPreview: "grid_preview";
+    readonly GridLargePreview: "grid_large_preview";
+    readonly GridLargePreviewV2: "grid_large_preview_v2";
+    readonly AssetPickerGrid: "asset_picker_grid";
+    readonly GridVideoSquare: "grid_video_square";
+    readonly GridVideoLandscape: "grid_video_landscape";
+    readonly MediaEditorWidget: "media_editor_widget";
+    readonly PlayVideo: "play_video";
+    readonly HlsVideoPreview: "hls_video_preview";
+    readonly VideoSegment: "video_segment";
+    readonly VideoStream: "video_stream";
+    readonly AudioStream: "audio_stream";
+    readonly AudioSegment: "audio_segment";
+};
+export type GetThumbnailVariantEnum = typeof GetThumbnailVariantEnum[keyof typeof GetThumbnailVariantEnum];