@cloudinary/apps-api 2.2605.88 → 2.2605.91

package/docs/MetadataRuleOrCondition.md

@@ -0,0 +1,35 @@
+
+# MetadataRuleOrCondition
+
+Holds when any nested condition holds.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`or` | [Array<MetadataRuleCondition>](MetadataRuleCondition.md)
+
+## Example
+
+```typescript
+import type { MetadataRuleOrCondition } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "or": null,
+} satisfies MetadataRuleOrCondition
+
+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 MetadataRuleOrCondition
+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/MetadataRuleResult.md

@@ -0,0 +1,45 @@
+
+# MetadataRuleResult
+
+What the rule does to its target field when the condition holds.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enable` | boolean
+`disable` | boolean
+`hide` | boolean
+`activate_values` | [MetadataRuleResultActivateValues](MetadataRuleResultActivateValues.md)
+`apply_value` | [MetadataRuleResultApplyValue](MetadataRuleResultApplyValue.md)
+`set_mandatory` | boolean
+
+## Example
+
+```typescript
+import type { MetadataRuleResult } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enable": null,
+  "disable": null,
+  "hide": null,
+  "activate_values": null,
+  "apply_value": null,
+  "set_mandatory": null,
+} satisfies MetadataRuleResult
+
+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 MetadataRuleResult
+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/MetadataRuleResultActivateValues.md

@@ -0,0 +1,37 @@
+
+# MetadataRuleResultActivateValues
+
+Restricts the field\'s selectable options. \"all\" re-enables every option.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`external_ids` | Array<string>
+`mode` | string
+
+## Example
+
+```typescript
+import type { MetadataRuleResultActivateValues } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "external_ids": null,
+  "mode": null,
+} satisfies MetadataRuleResultActivateValues
+
+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 MetadataRuleResultActivateValues
+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/MetadataRuleResultActivateValuesAnyOf.md

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

@@ -0,0 +1,37 @@
+
+# MetadataRuleResultApplyValue
+
+Sets an inferred value on the field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`value` | [MetadataRuleResultApplyValueValue](MetadataRuleResultApplyValueValue.md)
+`mode` | string
+
+## Example
+
+```typescript
+import type { MetadataRuleResultApplyValue } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "value": null,
+  "mode": null,
+} satisfies MetadataRuleResultApplyValue
+
+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 MetadataRuleResultApplyValue
+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/MetadataRuleResultApplyValueValue.md

@@ -0,0 +1,37 @@
+
+# MetadataRuleResultApplyValueValue
+
+A plain value, or the resolved option (enum field) or options (set field)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`external_id` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { MetadataRuleResultApplyValueValue } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "external_id": null,
+  "value": null,
+} satisfies MetadataRuleResultApplyValueValue
+
+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 MetadataRuleResultApplyValueValue
+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/PlatformApi.md

@@ -103,7 +103,7 @@ example().catch(console.error);
 
 Deploy a DAM app bundle
 
-deploy a DAM app to https://dam.cloudinary.app/{app_id}/{env}/{version}/ and optionally updates the app\'s appUrl and manifest from cloudinary.app.json in the bundle.
+deploy a DAM app to https://apps.cloudinary.com/{app_id}/{env}/{version}/ and optionally updates the app\'s appUrl and manifest from cloudinary.app.json in the bundle.
 
 ### Example
 
@@ -832,7 +832,7 @@ example().catch(console.error);
 
 Refresh a Cloudinary token
 
-Exchanges the current gateway bearer token for a fresh underlying Cloudinary token of the specified type (oauth or console). Returns a 401 and invalidates the session if the token cannot be refreshed.
+Exchanges the current gateway bearer token for a fresh underlying Cloudinary token of the specified type (oauth or console). Returns a 401 and invalidates the session if the token cannot be refreshed. Refreshing a `console` token is deprecated: console tokens will not be refreshable, so refresh the `oauth` token instead. Console refresh responses carry `Deprecation: true` and a `Warning` header.
 
 ### Example
 
@@ -852,7 +852,7 @@ async function example() {
   const api = new PlatformApi(config);
 
   const body = {
-    // 'oauth' | 'console'
+    // 'oauth' | 'console' | Token type to refresh. `console` is deprecated: console tokens will not be refreshable, use `oauth`.
     type: type_example,
     // string | Target Cloudinary cloud name. Required when using an account-level token that is not scoped to a cloud. This header, the request subdomain, and the token\'s own cloud must match wherever more than one is present — no source overrides another, and any disagreement is rejected with 400. (optional)
     xCldCloudName: xCldCloudName_example,
@@ -875,7 +875,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **type** | `oauth`, `console` |  | [Defaults to `undefined`] [Enum: oauth, console] |
+| **type** | `oauth`, `console` | Token type to refresh. `console` is deprecated: console tokens will not be refreshable, use `oauth`. | [Defaults to `undefined`] [Enum: oauth, console] |
 | **xCldCloudName** | `string` | Target Cloudinary cloud name. Required when using an account-level token that is not scoped to a cloud. This header, the request subdomain, and the token\'s own cloud must match wherever more than one is present — no source overrides another, and any disagreement is rejected with 400. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -895,7 +895,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful operation |  -  |
+| **200** | Successful operation |  * Deprecation - &#x60;true&#x60; when refreshing a &#x60;console&#x60; token, which is deprecated. <br>  * Warning - Deprecation notice when refreshing a &#x60;console&#x60; token. <br>  |
 | **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)

package/docs/TemplateChanges.md

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

@@ -0,0 +1,50 @@
+
+# TemplateUpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`publicId` | string
+`externalId` | string
+`transformation` | string
+`canvas` | [TemplateWriteRequestCanvas](TemplateWriteRequestCanvas.md)
+`variables` | [Array<CldtTemplateVariable>](CldtTemplateVariable.md)
+`provenance` | [TemplateWriteRequestProvenance](TemplateWriteRequestProvenance.md)
+`exportScale` | number
+`basePublicId` | string
+`deliveryParams` | string
+
+## Example
+
+```typescript
+import type { TemplateUpdateRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "publicId": null,
+  "externalId": null,
+  "transformation": null,
+  "canvas": null,
+  "variables": null,
+  "provenance": null,
+  "exportScale": null,
+  "basePublicId": null,
+  "deliveryParams": null,
+} satisfies TemplateUpdateRequest
+
+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 TemplateUpdateRequest
+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/TemplateWriteAsset.md

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

@@ -0,0 +1,40 @@
+
+# TemplateWriteFailureResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`upstream_status` | number
+`changes` | [TemplateChanges](TemplateChanges.md)
+`previous` | [TemplateWriteFailureResponsePrevious](TemplateWriteFailureResponsePrevious.md)
+
+## Example
+
+```typescript
+import type { TemplateWriteFailureResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "upstream_status": null,
+  "changes": null,
+  "previous": null,
+} satisfies TemplateWriteFailureResponse
+
+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 TemplateWriteFailureResponse
+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/TemplateWriteFailureResponsePrevious.md

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

@@ -0,0 +1,52 @@
+
+# TemplateWriteRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`publicId` | string
+`externalId` | string
+`transformation` | string
+`canvas` | [TemplateWriteRequestCanvas](TemplateWriteRequestCanvas.md)
+`variables` | [Array<CldtTemplateVariable>](CldtTemplateVariable.md)
+`provenance` | [TemplateWriteRequestProvenance](TemplateWriteRequestProvenance.md)
+`exportScale` | number
+`basePublicId` | string
+`deliveryParams` | string
+
+## Example
+
+```typescript
+import type { TemplateWriteRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "publicId": null,
+  "externalId": null,
+  "transformation": null,
+  "canvas": null,
+  "variables": null,
+  "provenance": null,
+  "exportScale": null,
+  "basePublicId": null,
+  "deliveryParams": null,
+} satisfies TemplateWriteRequest
+
+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 TemplateWriteRequest
+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/TemplateWriteRequestCanvas.md

@@ -0,0 +1,37 @@
+
+# TemplateWriteRequestCanvas
+
+Design canvas size in pixels
+
+## Properties
+
+Name | Type
+------------ | -------------
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { TemplateWriteRequestCanvas } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "width": null,
+  "height": null,
+} satisfies TemplateWriteRequestCanvas
+
+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 TemplateWriteRequestCanvas
+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/TemplateWriteRequestProvenance.md

@@ -0,0 +1,45 @@
+
+# TemplateWriteRequestProvenance
+
+Where this template came from
+
+## Properties
+
+Name | Type
+------------ | -------------
+`platform` | string
+`documentId` | string
+`url` | string
+`createdBy` | string
+`createdAt` | string
+`sourceContext` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { TemplateWriteRequestProvenance } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "platform": null,
+  "documentId": null,
+  "url": null,
+  "createdBy": null,
+  "createdAt": null,
+  "sourceContext": null,
+} satisfies TemplateWriteRequestProvenance
+
+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 TemplateWriteRequestProvenance
+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/TemplateWriteResponse.md

@@ -0,0 +1,40 @@
+
+# TemplateWriteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`template` | [CldtTemplate](CldtTemplate.md)
+`asset` | [TemplateWriteAsset](TemplateWriteAsset.md)
+`transformation` | { [key: string]: any; }
+`changes` | [TemplateChanges](TemplateChanges.md)
+
+## Example
+
+```typescript
+import type { TemplateWriteResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "template": null,
+  "asset": null,
+  "transformation": null,
+  "changes": null,
+} satisfies TemplateWriteResponse
+
+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 TemplateWriteResponse
+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/UtilsApi.md

@@ -125,7 +125,7 @@ async function example() {
   const api = new UtilsApi(config);
 
   const body = {
-    // 'oauth' | 'console'
+    // 'oauth' | 'console' | Token type to refresh. `console` is deprecated: console tokens will not be refreshable, use `oauth`.
     type: type_example,
     // string | Target Cloudinary cloud name. Required when using an account-level token that is not scoped to a cloud. This header, the request subdomain, and the token\'s own cloud must match wherever more than one is present — no source overrides another, and any disagreement is rejected with 400. (optional)
     xCldCloudName: xCldCloudName_example,
@@ -148,7 +148,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **type** | `oauth`, `console` |  | [Defaults to `undefined`] [Enum: oauth, console] |
+| **type** | `oauth`, `console` | Token type to refresh. `console` is deprecated: console tokens will not be refreshable, use `oauth`. | [Defaults to `undefined`] [Enum: oauth, console] |
 | **xCldCloudName** | `string` | Target Cloudinary cloud name. Required when using an account-level token that is not scoped to a cloud. This header, the request subdomain, and the token\'s own cloud must match wherever more than one is present — no source overrides another, and any disagreement is rejected with 400. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -168,7 +168,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful operation |  -  |
+| **200** | Successful operation |  * Deprecation - &#x60;true&#x60; when refreshing a &#x60;console&#x60; token, which is deprecated. <br>  * Warning - Deprecation notice when refreshing a &#x60;console&#x60; token. <br>  |
 | **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)