@cloudinary/apps-api 2.2605.49

package/docs/UtilsApi.md

@@ -0,0 +1,745 @@
+# UtilsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deprecatedGetUtilsAppStorageNamespaceTokenLevelKey**](UtilsApi.md#deprecatedgetutilsappstoragenamespacetokenlevelkey) | **GET** /utils/app_storage/{namespace_token}/{level}/{key} | Get persistent storage value |
+| [**deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh**](UtilsApi.md#deprecatedgetutilsauthcloudinarytokentyperefresh) | **GET** /utils/auth/cloudinary/token/{type}/refresh | res console |
+| [**deprecatedGetUtilsBackreferenceAssetAssetId**](UtilsApi.md#deprecatedgetutilsbackreferenceassetassetid) | **GET** /utils/backreference/asset/{assetId} | List asset backreferences |
+| [**deprecatedGetUtilsFontsGoogleWebFonts**](UtilsApi.md#deprecatedgetutilsfontsgooglewebfonts) | **GET** /utils/fonts/google/web-fonts | google web fonts listing |
+| [**deprecatedGetUtilsValidateToken**](UtilsApi.md#deprecatedgetutilsvalidatetoken) | **GET** /utils/validate_token | validate JWT token |
+| [**deprecatedPostUtilsAnalytics**](UtilsApi.md#deprecatedpostutilsanalytics) | **POST** /utils/analytics | Submit analytics events |
+| [**deprecatedPostUtilsBackreferenceAsset**](UtilsApi.md#deprecatedpostutilsbackreferenceasset) | **POST** /utils/backreference/asset | Manage asset backreferences |
+| [**deprecatedPostUtilsFontsLookup**](UtilsApi.md#deprecatedpostutilsfontslookup) | **POST** /utils/fonts/lookup | lookup fonts |
+| [**deprecatedPostUtilsFontsProvision**](UtilsApi.md#deprecatedpostutilsfontsprovision) | **POST** /utils/fonts/provision | lookup fonts |
+| [**deprecatedPutUtilsAppStorageNamespaceTokenLevelKey**](UtilsApi.md#deprecatedpututilsappstoragenamespacetokenlevelkey) | **PUT** /utils/app_storage/{namespace_token}/{level}/{key} | Set persistent storage value |
+
+
+
+## deprecatedGetUtilsAppStorageNamespaceTokenLevelKey
+
+> AppStorageGetResponse deprecatedGetUtilsAppStorageNamespaceTokenLevelKey(namespaceToken, level, key)
+
+Get persistent storage value
+
+Retrieve a value from persistent storage. Personal storage is user-scoped, shared storage is customer-scoped.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // string | Encrypted namespace token minted via the namespace-token endpoint
+    namespaceToken: namespaceToken_example,
+    // 'personal' | 'shared' | Storage level: personal (user-scoped) or shared (customer-scoped)
+    level: level_example,
+    // string | User-defined key name
+    key: key_example,
+  } satisfies DeprecatedGetUtilsAppStorageNamespaceTokenLevelKeyRequest;
+
+  try {
+    const data = await api.deprecatedGetUtilsAppStorageNamespaceTokenLevelKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **namespaceToken** | `string` | Encrypted namespace token minted via the namespace-token endpoint | [Defaults to `undefined`] |
+| **level** | `personal`, `shared` | Storage level: personal (user-scoped) or shared (customer-scoped) | [Defaults to `undefined`] [Enum: personal, shared] |
+| **key** | `string` | User-defined key name | [Defaults to `undefined`] |
+
+### Return type
+
+[**AppStorageGetResponse**](AppStorageGetResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Value retrieved successfully |  -  |
+| **400** | Invalid namespace_token |  -  |
+| **404** | Key not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh
+
+> RefreshTokenResponse deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh(type)
+
+res console
+
+thumbnail
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // 'oauth' | 'console'
+    type: type_example,
+  } satisfies DeprecatedGetUtilsAuthCloudinaryTokenTypeRefreshRequest;
+
+  try {
+    const data = await api.deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **type** | `oauth`, `console` |  | [Defaults to `undefined`] [Enum: oauth, console] |
+
+### Return type
+
+[**RefreshTokenResponse**](RefreshTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **401** | Invalid or expired session |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedGetUtilsBackreferenceAssetAssetId
+
+> ListBackreferencesResponse deprecatedGetUtilsBackreferenceAssetAssetId(assetId, system, tenant, includeRemoved)
+
+List asset backreferences
+
+Get active backreferences for an asset, optionally filtered by system/tenant. Pass includeRemoved=true to include backreferences whose current action is remove.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedGetUtilsBackreferenceAssetAssetIdRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // string | Cloudinary asset id
+    assetId: assetId_example,
+    // string | Filter by system name (e.g., \'monday\') (optional)
+    system: system_example,
+    // string | Filter by tenant/workspace ID (requires system) (optional)
+    tenant: tenant_example,
+    // boolean | Include backreferences whose current action is remove (optional)
+    includeRemoved: true,
+  } satisfies DeprecatedGetUtilsBackreferenceAssetAssetIdRequest;
+
+  try {
+    const data = await api.deprecatedGetUtilsBackreferenceAssetAssetId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` | Cloudinary asset id | [Defaults to `undefined`] |
+| **system** | `string` | Filter by system name (e.g., \'monday\') | [Optional] [Defaults to `undefined`] |
+| **tenant** | `string` | Filter by tenant/workspace ID (requires system) | [Optional] [Defaults to `undefined`] |
+| **includeRemoved** | `boolean` | Include backreferences whose current action is remove | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListBackreferencesResponse**](ListBackreferencesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **404** | Asset not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedGetUtilsFontsGoogleWebFonts
+
+> GoogleFontListingResponse deprecatedGetUtilsFontsGoogleWebFonts()
+
+google web fonts listing
+
+Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedGetUtilsFontsGoogleWebFontsRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const api = new UtilsApi();
+
+  try {
+    const data = await api.deprecatedGetUtilsFontsGoogleWebFonts();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GoogleFontListingResponse**](GoogleFontListingResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedGetUtilsValidateToken
+
+> ValidateTokenResponse deprecatedGetUtilsValidateToken()
+
+validate JWT token
+
+validate api-gateway token validity
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedGetUtilsValidateTokenRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  try {
+    const data = await api.deprecatedGetUtilsValidateToken();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ValidateTokenResponse**](ValidateTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Token is valid |  -  |
+| **401** | Invalid or expired token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPostUtilsAnalytics
+
+> AnalyticsResponse deprecatedPostUtilsAnalytics(trackAnalyticsEventRequest)
+
+Submit analytics events
+
+Endpoint to submit analytics events for tracking and analysis
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostUtilsAnalyticsRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const api = new UtilsApi();
+
+  const body = {
+    // TrackAnalyticsEventRequest (optional)
+    trackAnalyticsEventRequest: ...,
+  } satisfies DeprecatedPostUtilsAnalyticsRequest;
+
+  try {
+    const data = await api.deprecatedPostUtilsAnalytics(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **trackAnalyticsEventRequest** | [TrackAnalyticsEventRequest](TrackAnalyticsEventRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AnalyticsResponse**](AnalyticsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Analytics events successfully processed |  -  |
+| **400** | Bad request - invalid event data |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPostUtilsBackreferenceAsset
+
+> UpdateBackreferencesResponse deprecatedPostUtilsBackreferenceAsset(updateAssetBackreferencesRequest)
+
+Manage asset backreferences
+
+Create, update, or remove backreferences linking assets to 3rd party systems
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostUtilsBackreferenceAssetRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // UpdateAssetBackreferencesRequest (optional)
+    updateAssetBackreferencesRequest: ...,
+  } satisfies DeprecatedPostUtilsBackreferenceAssetRequest;
+
+  try {
+    const data = await api.deprecatedPostUtilsBackreferenceAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateAssetBackreferencesRequest** | [UpdateAssetBackreferencesRequest](UpdateAssetBackreferencesRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UpdateBackreferencesResponse**](UpdateBackreferencesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **400** | Bad request - invalid location or parameters |  -  |
+| **404** | Asset not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPostUtilsFontsLookup
+
+> FontLookupResponse deprecatedPostUtilsFontsLookup(lookupFontRequest)
+
+lookup fonts
+
+Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostUtilsFontsLookupRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // LookupFontRequest (optional)
+    lookupFontRequest: ...,
+  } satisfies DeprecatedPostUtilsFontsLookupRequest;
+
+  try {
+    const data = await api.deprecatedPostUtilsFontsLookup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **lookupFontRequest** | [LookupFontRequest](LookupFontRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FontLookupResponse**](FontLookupResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPostUtilsFontsProvision
+
+> FontProvisioningResponse deprecatedPostUtilsFontsProvision(provisionFontRequest)
+
+lookup fonts
+
+Lookup fonts by checking availability in Cloudinary system fonts and Google Fonts
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostUtilsFontsProvisionRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // ProvisionFontRequest (optional)
+    provisionFontRequest: ...,
+  } satisfies DeprecatedPostUtilsFontsProvisionRequest;
+
+  try {
+    const data = await api.deprecatedPostUtilsFontsProvision(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **provisionFontRequest** | [ProvisionFontRequest](ProvisionFontRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FontProvisioningResponse**](FontProvisioningResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPutUtilsAppStorageNamespaceTokenLevelKey
+
+> AppStorageSetResponse deprecatedPutUtilsAppStorageNamespaceTokenLevelKey(namespaceToken, level, key, setAppStorageValueRequest)
+
+Set persistent storage 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).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UtilsApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UtilsApi(config);
+
+  const body = {
+    // string | Encrypted namespace token minted via the namespace-token endpoint
+    namespaceToken: namespaceToken_example,
+    // 'personal' | 'shared' | Storage level: personal (user-scoped) or shared (customer-scoped)
+    level: level_example,
+    // string | User-defined key name
+    key: key_example,
+    // SetAppStorageValueRequest (optional)
+    setAppStorageValueRequest: ...,
+  } satisfies DeprecatedPutUtilsAppStorageNamespaceTokenLevelKeyRequest;
+
+  try {
+    const data = await api.deprecatedPutUtilsAppStorageNamespaceTokenLevelKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **namespaceToken** | `string` | Encrypted namespace token minted via the namespace-token endpoint | [Defaults to `undefined`] |
+| **level** | `personal`, `shared` | Storage level: personal (user-scoped) or shared (customer-scoped) | [Defaults to `undefined`] [Enum: personal, shared] |
+| **key** | `string` | User-defined key name | [Defaults to `undefined`] |
+| **setAppStorageValueRequest** | [SetAppStorageValueRequest](SetAppStorageValueRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AppStorageSetResponse**](AppStorageSetResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Value stored successfully |  -  |
+| **400** | Invalid namespace_token |  -  |
+| **403** | Forbidden - only admins can write to shared storage |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+