@cloudinary/apps-api 2.2605.49

package/docs/ContextualMetadataField.md

@@ -0,0 +1,34 @@
+
+# ContextualMetadataField
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+
+## Example
+
+```typescript
+import type { ContextualMetadataField } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+} satisfies ContextualMetadataField
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ContextualMetadataField
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateAssetMetadataFieldRequest.md

@@ -0,0 +1,42 @@
+
+# CreateAssetMetadataFieldRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`external_id` | string
+`label` | string
+`type` | string
+`mandatory` | boolean
+`restrictions` | string
+
+## Example
+
+```typescript
+import type { CreateAssetMetadataFieldRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "external_id": null,
+  "label": null,
+  "type": null,
+  "mandatory": null,
+  "restrictions": null,
+} satisfies CreateAssetMetadataFieldRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateAssetMetadataFieldRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateCollectionRequest.md

@@ -0,0 +1,40 @@
+
+# CreateCollectionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`kind` | string
+`description` | string
+`dynamic_filters` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CreateCollectionRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "kind": null,
+  "description": null,
+  "dynamic_filters": null,
+} satisfies CreateCollectionRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateCollectionRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateCollectionResponse.md

@@ -0,0 +1,34 @@
+
+# CreateCollectionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`collection` | [Collection](Collection.md)
+
+## Example
+
+```typescript
+import type { CreateCollectionResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "collection": null,
+} satisfies CreateCollectionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateCollectionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateFolderRequest.md

@@ -0,0 +1,36 @@
+
+# CreateFolderRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parent_id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { CreateFolderRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parent_id": null,
+  "name": null,
+} satisfies CreateFolderRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateFolderRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateFolderResponse.md

@@ -0,0 +1,34 @@
+
+# CreateFolderResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`folder` | [CreateFolderResponseFolder](CreateFolderResponseFolder.md)
+
+## Example
+
+```typescript
+import type { CreateFolderResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "folder": null,
+} satisfies CreateFolderResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateFolderResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateFolderResponseFolder.md

@@ -0,0 +1,48 @@
+
+# CreateFolderResponseFolder
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`path` | string
+`resource_count` | number
+`id` | string
+`last_uploaded_at` | string
+`total_bytes` | number
+`is_shared` | boolean
+`viewable_parents` | [Array<CreateFolderResponseFolderViewableParentsInner>](CreateFolderResponseFolderViewableParentsInner.md)
+
+## Example
+
+```typescript
+import type { CreateFolderResponseFolder } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "path": null,
+  "resource_count": null,
+  "id": null,
+  "last_uploaded_at": null,
+  "total_bytes": null,
+  "is_shared": null,
+  "viewable_parents": null,
+} satisfies CreateFolderResponseFolder
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateFolderResponseFolder
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateFolderResponseFolderViewableParentsInner.md

@@ -0,0 +1,36 @@
+
+# CreateFolderResponseFolderViewableParentsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`external_id` | string
+
+## Example
+
+```typescript
+import type { CreateFolderResponseFolderViewableParentsInner } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "external_id": null,
+} satisfies CreateFolderResponseFolderViewableParentsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateFolderResponseFolderViewableParentsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateMetadataFieldResponse.md

@@ -0,0 +1,38 @@
+
+# CreateMetadataFieldResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field_id` | string
+`external_id` | string
+`already_exists` | boolean
+
+## Example
+
+```typescript
+import type { CreateMetadataFieldResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "field_id": null,
+  "external_id": null,
+  "already_exists": null,
+} satisfies CreateMetadataFieldResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateMetadataFieldResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateNamespaceTokenRequest.md

@@ -0,0 +1,36 @@
+
+# CreateNamespaceTokenRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`namespace` | string
+`secret` | string
+
+## Example
+
+```typescript
+import type { CreateNamespaceTokenRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "namespace": null,
+  "secret": null,
+} satisfies CreateNamespaceTokenRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateNamespaceTokenRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Customer.md

@@ -0,0 +1,92 @@
+
+# Customer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`account_id` | string
+`cloud_name` | string
+`display_name` | string
+`account_external_id` | string
+`created_at` | string
+`cname` | string
+`api_key` | string
+`base_url` | string
+`secure_base_url` | string
+`upload_limits` | [CustomerUploadLimits](CustomerUploadLimits.md)
+`external_id` | string
+`geo` | string
+`media_optimizer` | boolean
+`programmable_media_editing` | boolean
+`media_management` | boolean
+`product_id` | number
+`product_name` | string
+`block_display_customer_images` | boolean
+`description` | string
+`capabilities` | any
+`status` | string
+`cdn_url_type` | string
+`strict_transformations` | boolean
+`backup` | boolean
+`media_library_original_filename` | boolean
+`etag_as_public_id` | boolean
+`is_untrusted` | boolean
+`folder_decoupling_enabled` | boolean
+`granular_permissions_enabled` | boolean
+
+## Example
+
+```typescript
+import type { Customer } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "account_id": null,
+  "cloud_name": null,
+  "display_name": null,
+  "account_external_id": null,
+  "created_at": null,
+  "cname": null,
+  "api_key": null,
+  "base_url": null,
+  "secure_base_url": null,
+  "upload_limits": null,
+  "external_id": null,
+  "geo": null,
+  "media_optimizer": null,
+  "programmable_media_editing": null,
+  "media_management": null,
+  "product_id": null,
+  "product_name": null,
+  "block_display_customer_images": null,
+  "description": null,
+  "capabilities": null,
+  "status": null,
+  "cdn_url_type": null,
+  "strict_transformations": null,
+  "backup": null,
+  "media_library_original_filename": null,
+  "etag_as_public_id": null,
+  "is_untrusted": null,
+  "folder_decoupling_enabled": null,
+  "granular_permissions_enabled": null,
+} satisfies Customer
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Customer
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CustomerListMeta.md

@@ -0,0 +1,48 @@
+
+# CustomerListMeta
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`max_product_environments` | number
+`current_product_environments_count` | number
+`total_active` | number
+`current_page` | number
+`next_page` | number
+`total_pages` | number
+`page_size` | number
+`total_entries` | number
+
+## Example
+
+```typescript
+import type { CustomerListMeta } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "max_product_environments": null,
+  "current_product_environments_count": null,
+  "total_active": null,
+  "current_page": null,
+  "next_page": null,
+  "total_pages": null,
+  "page_size": null,
+  "total_entries": null,
+} satisfies CustomerListMeta
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CustomerListMeta
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CustomerUploadLimits.md

@@ -0,0 +1,42 @@
+
+# CustomerUploadLimits
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`image_max_size_bytes` | number
+`video_max_size_bytes` | number
+`raw_max_size_bytes` | number
+`image_max_px` | number
+`asset_max_total_px` | number
+
+## Example
+
+```typescript
+import type { CustomerUploadLimits } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "image_max_size_bytes": null,
+  "video_max_size_bytes": null,
+  "raw_max_size_bytes": null,
+  "image_max_px": null,
+  "asset_max_total_px": null,
+} satisfies CustomerUploadLimits
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CustomerUploadLimits
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DamAppErrorResponse.md

@@ -0,0 +1,34 @@
+
+# DamAppErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+
+## Example
+
+```typescript
+import type { DamAppErrorResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies DamAppErrorResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DamAppErrorResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DamAppResponse.md

@@ -0,0 +1,68 @@
+
+# DamAppResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`appName` | string
+`appDescription` | string
+`appId` | string
+`appUrl` | string
+`actionIcon` | string
+`appUrlParams` | { [key: string]: any; }
+`appMessageParams` | [{ [key: string]: DamAppResponseAppMessageParamsValue; }](DamAppResponseAppMessageParamsValue.md)
+`appActive` | boolean
+`appTitle` | string
+`assetFormat` | Array<string>
+`appSupportedDevices` | Array<string>
+`assetAmountLimit` | [DamAppResponseAssetAmountLimit](DamAppResponseAssetAmountLimit.md)
+`selectionType` | Array<string>
+`userCreatedBy` | [DamAppUserSnapshot](DamAppUserSnapshot.md)
+`userUpdatedBy` | [DamAppUserSnapshot](DamAppUserSnapshot.md)
+`availability` | string
+`hasManifest` | boolean
+`manifest` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { DamAppResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "appName": null,
+  "appDescription": null,
+  "appId": null,
+  "appUrl": null,
+  "actionIcon": null,
+  "appUrlParams": null,
+  "appMessageParams": null,
+  "appActive": null,
+  "appTitle": null,
+  "assetFormat": null,
+  "appSupportedDevices": null,
+  "assetAmountLimit": null,
+  "selectionType": null,
+  "userCreatedBy": null,
+  "userUpdatedBy": null,
+  "availability": null,
+  "hasManifest": null,
+  "manifest": null,
+} satisfies DamAppResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DamAppResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+