@cloudinary/apps-api 2.2605.49

package/dist/apis/UtilsApi.js

@@ -0,0 +1,461 @@
+"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.DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = exports.DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum = exports.DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = exports.UtilsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['namespaceToken'] == null) {
+                throw new runtime.RequiredError('namespaceToken', 'Required parameter "namespaceToken" was null or undefined when calling deprecatedGetUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            if (requestParameters['level'] == null) {
+                throw new runtime.RequiredError('level', 'Required parameter "level" was null or undefined when calling deprecatedGetUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            if (requestParameters['key'] == null) {
+                throw new runtime.RequiredError('key', 'Required parameter "key" was null or undefined when calling deprecatedGetUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            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}`;
+                }
+            }
+            let urlPath = `/utils/app_storage/{namespace_token}/{level}/{key}`;
+            urlPath = urlPath.replace(`{${"namespace_token"}}`, encodeURIComponent(String(requestParameters['namespaceToken'])));
+            urlPath = urlPath.replace(`{${"level"}}`, encodeURIComponent(String(requestParameters['level'])));
+            urlPath = urlPath.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AppStorageGetResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Retrieve a value from persistent storage. Personal storage is user-scoped, shared storage is customer-scoped.
+     * Get persistent storage value
+     * @deprecated
+     */
+    deprecatedGetUtilsAppStorageNamespaceTokenLevelKey(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * thumbnail
+     * res console
+     * @deprecated
+     */
+    deprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['type'] == null) {
+                throw new runtime.RequiredError('type', 'Required parameter "type" was null or undefined when calling deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh().');
+            }
+            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}`;
+                }
+            }
+            let urlPath = `/utils/auth/cloudinary/token/{type}/refresh`;
+            urlPath = urlPath.replace(`{${"type"}}`, encodeURIComponent(String(requestParameters['type'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RefreshTokenResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * thumbnail
+     * res console
+     * @deprecated
+     */
+    deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['assetId'] == null) {
+                throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling deprecatedGetUtilsBackreferenceAssetAssetId().');
+            }
+            const queryParameters = {};
+            if (requestParameters['system'] != null) {
+                queryParameters['system'] = requestParameters['system'];
+            }
+            if (requestParameters['tenant'] != null) {
+                queryParameters['tenant'] = requestParameters['tenant'];
+            }
+            if (requestParameters['includeRemoved'] != null) {
+                queryParameters['includeRemoved'] = requestParameters['includeRemoved'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/utils/backreference/asset/{assetId}`;
+            urlPath = urlPath.replace(`{${"assetId"}}`, encodeURIComponent(String(requestParameters['assetId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListBackreferencesResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedGetUtilsBackreferenceAssetAssetIdRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * google web fonts listing
+     * @deprecated
+     */
+    deprecatedGetUtilsFontsGoogleWebFontsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/utils/fonts/google/web-fonts`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GoogleFontListingResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * google web fonts listing
+     * @deprecated
+     */
+    deprecatedGetUtilsFontsGoogleWebFonts(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedGetUtilsFontsGoogleWebFontsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * validate api-gateway token validity
+     * validate JWT token
+     * @deprecated
+     */
+    deprecatedGetUtilsValidateTokenRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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}`;
+                }
+            }
+            let urlPath = `/utils/validate_token`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ValidateTokenResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * validate api-gateway token validity
+     * validate JWT token
+     * @deprecated
+     */
+    deprecatedGetUtilsValidateToken(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedGetUtilsValidateTokenRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Endpoint to submit analytics events for tracking and analysis
+     * Submit analytics events
+     * @deprecated
+     */
+    deprecatedPostUtilsAnalyticsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/utils/analytics`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.TrackAnalyticsEventRequestToJSON)(requestParameters['trackAnalyticsEventRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AnalyticsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Endpoint to submit analytics events for tracking and analysis
+     * Submit analytics events
+     * @deprecated
+     */
+    deprecatedPostUtilsAnalytics() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.deprecatedPostUtilsAnalyticsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Create, update, or remove backreferences linking assets to 3rd party systems
+     * Manage asset backreferences
+     * @deprecated
+     */
+    deprecatedPostUtilsBackreferenceAssetRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = `/utils/backreference/asset`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateAssetBackreferencesRequestToJSON)(requestParameters['updateAssetBackreferencesRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateBackreferencesResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create, update, or remove backreferences linking assets to 3rd party systems
+     * Manage asset backreferences
+     * @deprecated
+     */
+    deprecatedPostUtilsBackreferenceAsset() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.deprecatedPostUtilsBackreferenceAssetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsLookupRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = `/utils/fonts/lookup`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.LookupFontRequestToJSON)(requestParameters['lookupFontRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FontLookupResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsLookup() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.deprecatedPostUtilsFontsLookupRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsProvisionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = `/utils/fonts/provision`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ProvisionFontRequestToJSON)(requestParameters['provisionFontRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FontProvisioningResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+     * lookup fonts
+     * @deprecated
+     */
+    deprecatedPostUtilsFontsProvision() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.deprecatedPostUtilsFontsProvisionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['namespaceToken'] == null) {
+                throw new runtime.RequiredError('namespaceToken', 'Required parameter "namespaceToken" was null or undefined when calling deprecatedPutUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            if (requestParameters['level'] == null) {
+                throw new runtime.RequiredError('level', 'Required parameter "level" was null or undefined when calling deprecatedPutUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            if (requestParameters['key'] == null) {
+                throw new runtime.RequiredError('key', 'Required parameter "key" was null or undefined when calling deprecatedPutUtilsAppStorageNamespaceTokenLevelKey().');
+            }
+            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 = `/utils/app_storage/{namespace_token}/{level}/{key}`;
+            urlPath = urlPath.replace(`{${"namespace_token"}}`, encodeURIComponent(String(requestParameters['namespaceToken'])));
+            urlPath = urlPath.replace(`{${"level"}}`, encodeURIComponent(String(requestParameters['level'])));
+            urlPath = urlPath.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.SetAppStorageValueRequestToJSON)(requestParameters['setAppStorageValueRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AppStorageSetResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.UtilsApi = UtilsApi;
+/**
+ * @export
+ */
+exports.DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = {
+    Personal: 'personal',
+    Shared: 'shared'
+};
+/**
+ * @export
+ */
+exports.DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshTypeEnum = {
+    Oauth: 'oauth',
+    Console: 'console'
+};
+/**
+ * @export
+ */
+exports.DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyLevelEnum = {
+    Personal: 'personal',
+    Shared: 'shared'
+};

package/dist/apis/index.d.ts

@@ -0,0 +1,6 @@
+export * from './AssetManagementApi';
+export * from './ConsoleApi';
+export * from './MediaApi';
+export * from './PlatformApi';
+export * from './UploadApi';
+export * from './UtilsApi';

package/dist/apis/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AssetManagementApi"), exports);
+__exportStar(require("./ConsoleApi"), exports);
+__exportStar(require("./MediaApi"), exports);
+__exportStar(require("./PlatformApi"), exports);
+__exportStar(require("./UploadApi"), exports);
+__exportStar(require("./UtilsApi"), exports);