@cloudinary/apps-api 2.2605.49

package/docs/DamAppResponseAppMessageParamsValue.md

@@ -0,0 +1,36 @@
+
+# DamAppResponseAppMessageParamsValue
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`attributes` | Array<string>
+
+## Example
+
+```typescript
+import type { DamAppResponseAppMessageParamsValue } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "attributes": null,
+} satisfies DamAppResponseAppMessageParamsValue
+
+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 DamAppResponseAppMessageParamsValue
+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/DamAppResponseAppMessageParamsValueAnyOf.md

@@ -0,0 +1,36 @@
+
+# DamAppResponseAppMessageParamsValueAnyOf
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`attributes` | Array<string>
+
+## Example
+
+```typescript
+import type { DamAppResponseAppMessageParamsValueAnyOf } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "attributes": null,
+} satisfies DamAppResponseAppMessageParamsValueAnyOf
+
+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 DamAppResponseAppMessageParamsValueAnyOf
+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/DamAppResponseAssetAmountLimit.md

@@ -0,0 +1,33 @@
+
+# DamAppResponseAssetAmountLimit
+
+Max assets passed to the app; empty string means no limit
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DamAppResponseAssetAmountLimit } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DamAppResponseAssetAmountLimit
+
+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 DamAppResponseAssetAmountLimit
+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/DamAppUserSnapshot.md

@@ -0,0 +1,40 @@
+
+# DamAppUserSnapshot
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`first_name` | string
+`last_name` | string
+`external_id` | string
+
+## Example
+
+```typescript
+import type { DamAppUserSnapshot } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "first_name": null,
+  "last_name": null,
+  "external_id": null,
+} satisfies DamAppUserSnapshot
+
+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 DamAppUserSnapshot
+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/DeleteFolderResponse.md

@@ -0,0 +1,36 @@
+
+# DeleteFolderResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fully_deleted` | boolean
+`id` | string
+
+## Example
+
+```typescript
+import type { DeleteFolderResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fully_deleted": null,
+  "id": null,
+} satisfies DeleteFolderResponse
+
+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 DeleteFolderResponse
+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/DeployApp200Response.md

@@ -0,0 +1,38 @@
+
+# DeployApp200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deployed_url` | string
+`app_url` | string
+`app_url_updated` | boolean
+
+## Example
+
+```typescript
+import type { DeployApp200Response } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deployed_url": null,
+  "app_url": null,
+  "app_url_updated": null,
+} satisfies DeployApp200Response
+
+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 DeployApp200Response
+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/DeployApp207Response.md

@@ -0,0 +1,40 @@
+
+# DeployApp207Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deployed_url` | string
+`app_url` | string
+`app_url_updated` | boolean
+`error` | string
+
+## Example
+
+```typescript
+import type { DeployApp207Response } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deployed_url": null,
+  "app_url": null,
+  "app_url_updated": null,
+  "error": null,
+} satisfies DeployApp207Response
+
+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 DeployApp207Response
+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/DeployApp400Response.md

@@ -0,0 +1,34 @@
+
+# DeployApp400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+
+## Example
+
+```typescript
+import type { DeployApp400Response } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies DeployApp400Response
+
+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 DeployApp400Response
+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/DeployAppRequest.md

@@ -0,0 +1,40 @@
+
+# DeployAppRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bundle` | Blob
+`env` | string
+`version` | string
+`update_app_url` | string
+
+## Example
+
+```typescript
+import type { DeployAppRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bundle": null,
+  "env": null,
+  "version": null,
+  "update_app_url": null,
+} satisfies DeployAppRequest
+
+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 DeployAppRequest
+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/DownloadAssetRequest.md

@@ -0,0 +1,40 @@
+
+# DownloadAssetRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`external_id` | string
+`public_id` | string
+`target_filename` | string
+`transformation` | string
+
+## Example
+
+```typescript
+import type { DownloadAssetRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "external_id": null,
+  "public_id": null,
+  "target_filename": null,
+  "transformation": null,
+} satisfies DownloadAssetRequest
+
+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 DownloadAssetRequest
+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/DownloadAssetResponse.md

@@ -0,0 +1,34 @@
+
+# DownloadAssetResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`redirect` | string
+
+## Example
+
+```typescript
+import type { DownloadAssetResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "redirect": null,
+} satisfies DownloadAssetResponse
+
+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 DownloadAssetResponse
+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/DownloadCollectionResponse.md

@@ -0,0 +1,36 @@
+
+# DownloadCollectionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`secure_url` | string
+
+## Example
+
+```typescript
+import type { DownloadCollectionResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "secure_url": null,
+} satisfies DownloadCollectionResponse
+
+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 DownloadCollectionResponse
+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/ErrorResponse.md

@@ -0,0 +1,34 @@
+
+# ErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+
+## Example
+
+```typescript
+import type { ErrorResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies ErrorResponse
+
+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 ErrorResponse
+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/ErrorWithMessageResponse.md

@@ -0,0 +1,36 @@
+
+# ErrorWithMessageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { ErrorWithMessageResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "message": null,
+} satisfies ErrorWithMessageResponse
+
+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 ErrorWithMessageResponse
+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/FieldAggregation.md

@@ -0,0 +1,36 @@
+
+# FieldAggregation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`buckets` | [Array<FieldAggregationBucketsInner>](FieldAggregationBucketsInner.md)
+
+## Example
+
+```typescript
+import type { FieldAggregation } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "buckets": null,
+} satisfies FieldAggregation
+
+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 FieldAggregation
+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/FieldAggregationBucketsInner.md

@@ -0,0 +1,36 @@
+
+# FieldAggregationBucketsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`doc_count` | number
+
+## Example
+
+```typescript
+import type { FieldAggregationBucketsInner } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "doc_count": null,
+} satisfies FieldAggregationBucketsInner
+
+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 FieldAggregationBucketsInner
+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/FontDefinition.md

@@ -0,0 +1,38 @@
+
+# FontDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`family` | string
+`variants` | Array<string>
+`subsets` | Array<string>
+
+## Example
+
+```typescript
+import type { FontDefinition } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "family": null,
+  "variants": null,
+  "subsets": null,
+} satisfies FontDefinition
+
+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 FontDefinition
+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/FontLookupResponse.md

@@ -0,0 +1,34 @@
+
+# FontLookupResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fonts` | [Array<FontLookupResponseFontsInner>](FontLookupResponseFontsInner.md)
+
+## Example
+
+```typescript
+import type { FontLookupResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fonts": null,
+} satisfies FontLookupResponse
+
+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 FontLookupResponse
+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)
+
+