@cloudinary/apps-api 2.2605.49

package/dist/apis/UploadApi.js

@@ -0,0 +1,198 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class UploadApi extends runtime.BaseAPI {
+    /**
+     * @deprecated
+     */
+    deprecatedPostCloudinaryUploadCloudNameResourceTypeTagsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['cloudName'] == null) {
+                throw new runtime.RequiredError('cloudName', 'Required parameter "cloudName" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeTags().');
+            }
+            if (requestParameters['resourceType'] == null) {
+                throw new runtime.RequiredError('resourceType', 'Required parameter "resourceType" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeTags().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/cloudinary/upload/{cloud_name}/{resource_type}/tags`;
+            urlPath = urlPath.replace(`{${"cloud_name"}}`, encodeURIComponent(String(requestParameters['cloudName'])));
+            urlPath = urlPath.replace(`{${"resource_type"}}`, encodeURIComponent(String(requestParameters['resourceType'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateAssetTagsRequestToJSON)(requestParameters['updateAssetTagsRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateAssetTagsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * @deprecated
+     */
+    deprecatedPostCloudinaryUploadCloudNameResourceTypeTags(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedPostCloudinaryUploadCloudNameResourceTypeTagsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Proxies an upload request to Cloudinary. Client must provide signature and api_key. Accepts multipart/form-data (with binary file) or application/json (with URL or base64 data URI).
+     * Upload an asset to Cloudinary
+     * @deprecated
+     */
+    deprecatedPostCloudinaryUploadCloudNameResourceTypeUploadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['cloudName'] == null) {
+                throw new runtime.RequiredError('cloudName', 'Required parameter "cloudName" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload().');
+            }
+            if (requestParameters['resourceType'] == null) {
+                throw new runtime.RequiredError('resourceType', 'Required parameter "resourceType" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload().');
+            }
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload().');
+            }
+            if (requestParameters['signature'] == null) {
+                throw new runtime.RequiredError('signature', 'Required parameter "signature" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload().');
+            }
+            if (requestParameters['apiKey'] == null) {
+                throw new runtime.RequiredError('apiKey', 'Required parameter "apiKey" was null or undefined when calling deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+                { contentType: 'application/json' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['file'] != null) {
+                formParams.append('file', requestParameters['file']);
+            }
+            if (requestParameters['signature'] != null) {
+                formParams.append('signature', requestParameters['signature']);
+            }
+            if (requestParameters['apiKey'] != null) {
+                formParams.append('api_key', requestParameters['apiKey']);
+            }
+            if (requestParameters['timestamp'] != null) {
+                formParams.append('timestamp', requestParameters['timestamp']);
+            }
+            if (requestParameters['publicId'] != null) {
+                formParams.append('public_id', requestParameters['publicId']);
+            }
+            if (requestParameters['folder'] != null) {
+                formParams.append('folder', requestParameters['folder']);
+            }
+            if (requestParameters['tags'] != null) {
+                formParams.append('tags', requestParameters['tags']);
+            }
+            if (requestParameters['type'] != null) {
+                formParams.append('type', requestParameters['type']);
+            }
+            if (requestParameters['resourceType2'] != null) {
+                formParams.append('resource_type', requestParameters['resourceType2']);
+            }
+            if (requestParameters['overwrite'] != null) {
+                formParams.append('overwrite', requestParameters['overwrite']);
+            }
+            if (requestParameters['invalidate'] != null) {
+                formParams.append('invalidate', requestParameters['invalidate']);
+            }
+            if (requestParameters['context'] != null) {
+                formParams.append('context', requestParameters['context']);
+            }
+            if (requestParameters['metadata'] != null) {
+                formParams.append('metadata', requestParameters['metadata']);
+            }
+            if (requestParameters['transformation'] != null) {
+                formParams.append('transformation', requestParameters['transformation']);
+            }
+            if (requestParameters['format'] != null) {
+                formParams.append('format', requestParameters['format']);
+            }
+            if (requestParameters['eager'] != null) {
+                formParams.append('eager', requestParameters['eager']);
+            }
+            if (requestParameters['async'] != null) {
+                formParams.append('async', requestParameters['async']);
+            }
+            let urlPath = `/cloudinary/upload/{cloud_name}/{resource_type}/upload`;
+            urlPath = urlPath.replace(`{${"cloud_name"}}`, encodeURIComponent(String(requestParameters['cloudName'])));
+            urlPath = urlPath.replace(`{${"resource_type"}}`, encodeURIComponent(String(requestParameters['resourceType'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UploadAssetResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Proxies an upload request to Cloudinary. Client must provide signature and api_key. Accepts multipart/form-data (with binary file) or application/json (with URL or base64 data URI).
+     * Upload an asset to Cloudinary
+     * @deprecated
+     */
+    deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedPostCloudinaryUploadCloudNameResourceTypeUploadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.UploadApi = UploadApi;

package/dist/apis/UtilsApi.d.ts

@@ -0,0 +1,194 @@
+/**
+ * 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 { AnalyticsResponse, AppStorageGetResponse, AppStorageSetResponse, FontLookupResponse, FontProvisioningResponse, GoogleFontListingResponse, ListBackreferencesResponse, LookupFontRequest, ProvisionFontRequest, RefreshTokenResponse, SetAppStorageValueRequest, TrackAnalyticsEventRequest, UpdateAssetBackreferencesRequest, UpdateBackreferencesResponse, ValidateTokenResponse } from '../models/index';
+export interface UtilsApiDeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRequest {
+    namespaceToken: string;
+    level: DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum;
+    key: string;
+}
+export interface UtilsApiDeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRequest {
+    type: DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum;
+}
+export interface UtilsApiDeprecatedGetUtilsBackreferenceAssetAssetIdRequest {
+    assetId: string;
+    system?: string;
+    tenant?: string;
+    includeRemoved?: boolean | null;
+}
+export interface UtilsApiDeprecatedPostUtilsAnalyticsRequest {
+    trackAnalyticsEventRequest?: TrackAnalyticsEventRequest;
+}
+export interface UtilsApiDeprecatedPostUtilsBackreferenceAssetRequest {
+    updateAssetBackreferencesRequest?: UpdateAssetBackreferencesRequest;
+}
+export interface UtilsApiDeprecatedPostUtilsFontsLookupRequest {
+    lookupFontRequest?: LookupFontRequest;
+}
+export interface UtilsApiDeprecatedPostUtilsFontsProvisionRequest {
+    provisionFontRequest?: ProvisionFontRequest;
+}
+export interface UtilsApiDeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRequest {
+    namespaceToken: string;
+    level: DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum;
+    key: string;
+    setAppStorageValueRequest?: SetAppStorageValueRequest;
+}
+/**
+ *
+ */
+export declare class UtilsApi extends runtime.BaseAPI {
+    /**
+     * Retrieve a value from persistent storage. Personal storage is user-scoped, shared storage is customer-scoped.
+     * Get persistent storage value
+     * @deprecated
+     */
+    deprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRaw(requestParameters: UtilsApiDeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppStorageGetResponse>>;
+    /**
+     * Retrieve a value from persistent storage. Personal storage is user-scoped, shared storage is customer-scoped.
+     * Get persistent storage value
+     * @deprecated
+     */
+    deprecatedGetUtilsAppStorageNamespaceTokenLevelKey(requestParameters: UtilsApiDeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppStorageGetResponse>;
+    /**
+     * thumbnail
+     * res console
+     * @deprecated
+     */
+    deprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRaw(requestParameters: UtilsApiDeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefreshTokenResponse>>;
+    /**
+     * thumbnail
+     * res console
+     * @deprecated
+     */
+    deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh(requestParameters: UtilsApiDeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefreshTokenResponse>;
+    /**
+     * Get active backreferences for an asset, optionally filtered by system/tenant. Pass includeRemoved=true to include backreferences whose current action is remove.
+     * List asset backreferences
+     * @deprecated
+     */
+    deprecatedGetUtilsBackreferenceAssetAssetIdRaw(requestParameters: UtilsApiDeprecatedGetUtilsBackreferenceAssetAssetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBackreferencesResponse>>;
+    /**
+     * Get active backreferences for an asset, optionally filtered by system/tenant. Pass includeRemoved=true to include backreferences whose current action is remove.
+     * List asset backreferences
+     * @deprecated
+     */
+    deprecatedGetUtilsBackreferenceAssetAssetId(requestParameters: UtilsApiDeprecatedGetUtilsBackreferenceAssetAssetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBackreferencesResponse>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * google web fonts listing
+     * @deprecated
+     */
+    deprecatedGetUtilsFontsGoogleWebFontsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GoogleFontListingResponse>>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * google web fonts listing
+     * @deprecated
+     */
+    deprecatedGetUtilsFontsGoogleWebFonts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GoogleFontListingResponse>;
+    /**
+     * validate api-gateway token validity
+     * validate JWT token
+     * @deprecated
+     */
+    deprecatedGetUtilsValidateTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidateTokenResponse>>;
+    /**
+     * validate api-gateway token validity
+     * validate JWT token
+     * @deprecated
+     */
+    deprecatedGetUtilsValidateToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidateTokenResponse>;
+    /**
+     * Endpoint to submit analytics events for tracking and analysis
+     * Submit analytics events
+     * @deprecated
+     */
+    deprecatedPostUtilsAnalyticsRaw(requestParameters: UtilsApiDeprecatedPostUtilsAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticsResponse>>;
+    /**
+     * Endpoint to submit analytics events for tracking and analysis
+     * Submit analytics events
+     * @deprecated
+     */
+    deprecatedPostUtilsAnalytics(requestParameters?: UtilsApiDeprecatedPostUtilsAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticsResponse>;
+    /**
+     * Create, update, or remove backreferences linking assets to 3rd party systems
+     * Manage asset backreferences
+     * @deprecated
+     */
+    deprecatedPostUtilsBackreferenceAssetRaw(requestParameters: UtilsApiDeprecatedPostUtilsBackreferenceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateBackreferencesResponse>>;
+    /**
+     * Create, update, or remove backreferences linking assets to 3rd party systems
+     * Manage asset backreferences
+     * @deprecated
+     */
+    deprecatedPostUtilsBackreferenceAsset(requestParameters?: UtilsApiDeprecatedPostUtilsBackreferenceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateBackreferencesResponse>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsLookupRaw(requestParameters: UtilsApiDeprecatedPostUtilsFontsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FontLookupResponse>>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsLookup(requestParameters?: UtilsApiDeprecatedPostUtilsFontsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FontLookupResponse>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsProvisionRaw(requestParameters: UtilsApiDeprecatedPostUtilsFontsProvisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FontProvisioningResponse>>;
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsProvision(requestParameters?: UtilsApiDeprecatedPostUtilsFontsProvisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FontProvisioningResponse>;
+    /**
+     * Store a value in persistent storage. Personal storage is user-scoped (full access). Shared storage is customer-scoped (admins can write, non-admins read-only).
+     * Set persistent storage value
+     * @deprecated
+     */
+    deprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRaw(requestParameters: UtilsApiDeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppStorageSetResponse>>;
+    /**
+     * Store a value in persistent storage. Personal storage is user-scoped (full access). Shared storage is customer-scoped (admins can write, non-admins read-only).
+     * Set persistent storage value
+     * @deprecated
+     */
+    deprecatedPutUtilsAppStorageNamespaceTokenLevelKey(requestParameters: UtilsApiDeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppStorageSetResponse>;
+}
+/**
+ * @export
+ */
+export declare const DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum: {
+    readonly Personal: "personal";
+    readonly Shared: "shared";
+};
+export type DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = typeof DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum[keyof typeof DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum];
+/**
+ * @export
+ */
+export declare const DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum: {
+    readonly Oauth: "oauth";
+    readonly Console: "console";
+};
+export type DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum = typeof DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum[keyof typeof DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum];
+/**
+ * @export
+ */
+export declare const DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum: {
+    readonly Personal: "personal";
+    readonly Shared: "shared";
+};
+export type DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = typeof DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum[keyof typeof DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum];