@cloudinary/apps-api 2.2605.56 → 2.2605.60

package/docs/UploadPreset.md

@@ -0,0 +1,46 @@
+
+# UploadPreset
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`customer_id` | string
+`name` | string
+`unsigned` | boolean
+`settings` | [UploadPresetSettings](UploadPresetSettings.md)
+`is_upload_default` | boolean
+`is_media_library_default` | boolean
+
+## Example
+
+```typescript
+import type { UploadPreset } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "customer_id": null,
+  "name": null,
+  "unsigned": null,
+  "settings": null,
+  "is_upload_default": null,
+  "is_media_library_default": null,
+} satisfies UploadPreset
+
+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 UploadPreset
+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/UploadPresetSettings.md

@@ -0,0 +1,154 @@
+
+# UploadPresetSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`public_id` | string
+`public_id_prefix` | string
+`display_name` | string
+`asset_folder` | string
+`use_asset_folder_as_public_id_prefix` | boolean
+`folder` | string
+`use_filename` | boolean
+`use_filename_as_display_name` | boolean
+`unique_filename` | boolean
+`unique_display_name` | boolean
+`filename_override` | string
+`type` | [UploadPresetSettingsType](UploadPresetSettingsType.md)
+`access_control` | [UploadPresetSettingsAccessControl](UploadPresetSettingsAccessControl.md)
+`access_mode` | [UploadPresetSettingsAccessMode](UploadPresetSettingsAccessMode.md)
+`discard_original_filename` | boolean
+`overwrite` | boolean
+`tags` | [UploadPresetSettingsTags](UploadPresetSettingsTags.md)
+`context` | [UploadPresetSettingsContext](UploadPresetSettingsContext.md)
+`metadata` | [UploadPresetSettingsMetadata](UploadPresetSettingsMetadata.md)
+`clear_invalid` | boolean
+`colors` | boolean
+`faces` | boolean
+`quality_analysis` | boolean
+`accessibility_analysis` | boolean
+`cinemagraph_analysis` | boolean
+`image_metadata` | boolean
+`media_metadata` | boolean
+`exif` | boolean
+`phash` | boolean
+`visual_search` | boolean
+`auto_tagging` | [UploadPresetSettingsAutoTagging](UploadPresetSettingsAutoTagging.md)
+`categorization` | string
+`detection` | string
+`auto_chaptering` | boolean
+`auto_transcription` | [UploadPresetSettingsAutoTranscription](UploadPresetSettingsAutoTranscription.md)
+`auto_video_details` | boolean
+`ocr` | string
+`moderation` | string
+`background_removal` | string
+`raw_convert` | string
+`eager` | [UploadPresetSettingsEager](UploadPresetSettingsEager.md)
+`eager_async` | boolean
+`eager_notification_url` | string
+`transformation` | [UploadPresetSettingsTransformation](UploadPresetSettingsTransformation.md)
+`format` | string
+`responsive_breakpoints` | [UploadPresetSettingsResponsiveBreakpoints](UploadPresetSettingsResponsiveBreakpoints.md)
+`allowed_formats` | [UpdateAssetMetadataRequestMetadataValue](UpdateAssetMetadataRequestMetadataValue.md)
+`async` | boolean
+`backup` | boolean
+`callback` | string
+`eval` | string
+`on_success` | string
+`headers` | [UploadPresetSettingsHeaders](UploadPresetSettingsHeaders.md)
+`invalidate` | boolean
+`notification_url` | string
+`proxy` | string
+`return_delete_token` | boolean
+`disallow_public_id` | boolean
+`max_file_size` | [UploadPresetSettingsAutoTagging](UploadPresetSettingsAutoTagging.md)
+`parameter_whitelist` | [UploadPresetSettingsParameterWhitelist](UploadPresetSettingsParameterWhitelist.md)
+`live` | boolean
+
+## Example
+
+```typescript
+import type { UploadPresetSettings } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "public_id": null,
+  "public_id_prefix": null,
+  "display_name": null,
+  "asset_folder": null,
+  "use_asset_folder_as_public_id_prefix": null,
+  "folder": null,
+  "use_filename": null,
+  "use_filename_as_display_name": null,
+  "unique_filename": null,
+  "unique_display_name": null,
+  "filename_override": null,
+  "type": null,
+  "access_control": null,
+  "access_mode": null,
+  "discard_original_filename": null,
+  "overwrite": null,
+  "tags": null,
+  "context": null,
+  "metadata": null,
+  "clear_invalid": null,
+  "colors": null,
+  "faces": null,
+  "quality_analysis": null,
+  "accessibility_analysis": null,
+  "cinemagraph_analysis": null,
+  "image_metadata": null,
+  "media_metadata": null,
+  "exif": null,
+  "phash": null,
+  "visual_search": null,
+  "auto_tagging": null,
+  "categorization": null,
+  "detection": null,
+  "auto_chaptering": null,
+  "auto_transcription": null,
+  "auto_video_details": null,
+  "ocr": null,
+  "moderation": null,
+  "background_removal": null,
+  "raw_convert": null,
+  "eager": null,
+  "eager_async": null,
+  "eager_notification_url": null,
+  "transformation": null,
+  "format": null,
+  "responsive_breakpoints": null,
+  "allowed_formats": null,
+  "async": null,
+  "backup": null,
+  "callback": null,
+  "eval": null,
+  "on_success": null,
+  "headers": null,
+  "invalidate": null,
+  "notification_url": null,
+  "proxy": null,
+  "return_delete_token": null,
+  "disallow_public_id": null,
+  "max_file_size": null,
+  "parameter_whitelist": null,
+  "live": null,
+} satisfies UploadPresetSettings
+
+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 UploadPresetSettings
+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/UploadPresetSettingsAccessControl.md

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,46 @@
+
+# UploadPresetSettingsResponsiveBreakpoints
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`create_derived` | boolean
+`format` | string
+`transformation` | string
+`max_width` | number
+`min_width` | number
+`bytes_step` | number
+`max_images` | number
+
+## Example
+
+```typescript
+import type { UploadPresetSettingsResponsiveBreakpoints } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "create_derived": null,
+  "format": null,
+  "transformation": null,
+  "max_width": null,
+  "min_width": null,
+  "bytes_step": null,
+  "max_images": null,
+} satisfies UploadPresetSettingsResponsiveBreakpoints
+
+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 UploadPresetSettingsResponsiveBreakpoints
+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/UploadPresetSettingsResponsiveBreakpointsAnyOf.md

@@ -0,0 +1,46 @@
+
+# UploadPresetSettingsResponsiveBreakpointsAnyOf
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`create_derived` | boolean
+`format` | string
+`transformation` | string
+`max_width` | number
+`min_width` | number
+`bytes_step` | number
+`max_images` | number
+
+## Example
+
+```typescript
+import type { UploadPresetSettingsResponsiveBreakpointsAnyOf } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "create_derived": null,
+  "format": null,
+  "transformation": null,
+  "max_width": null,
+  "min_width": null,
+  "bytes_step": null,
+  "max_images": null,
+} satisfies UploadPresetSettingsResponsiveBreakpointsAnyOf
+
+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 UploadPresetSettingsResponsiveBreakpointsAnyOf
+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)
+
+