@cloudinary/apps-api 2.2605.85 → 2.2605.86

package/docs/{CreateAssetMetadataFieldRequestDatasourceValuesInner.md → MetadataRuleAppliedOption.md}

@@ -1,5 +1,5 @@
 
-# CreateAssetMetadataFieldRequestDatasourceValuesInner
+# MetadataRuleAppliedOption
 
 
 ## Properties
@@ -12,13 +12,13 @@ Name | Type
 ## Example
 
 ```typescript
-import type { CreateAssetMetadataFieldRequestDatasourceValuesInner } from '@cloudinary/apps-api'
+import type { MetadataRuleAppliedOption } from '@cloudinary/apps-api'
 
 // TODO: Update the object below with actual values
 const example = {
   "external_id": null,
   "value": null,
-} satisfies CreateAssetMetadataFieldRequestDatasourceValuesInner
+} satisfies MetadataRuleAppliedOption
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as CreateAssetMetadataFieldRequestDatasourceValuesInner
+const exampleParsed = JSON.parse(exampleJSON) as MetadataRuleAppliedOption
 console.log(exampleParsed)
 ```
 

package/docs/MetadataRuleCondition.md

@@ -0,0 +1,44 @@
+
+# MetadataRuleCondition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`metadata_field_id` | string
+`populated` | boolean
+`includes` | Array<string>
+`equals` | [MetadataRuleFieldConditionEquals](MetadataRuleFieldConditionEquals.md)
+`and` | [Array<MetadataRuleCondition>](MetadataRuleCondition.md)
+`or` | [Array<MetadataRuleCondition>](MetadataRuleCondition.md)
+
+## Example
+
+```typescript
+import type { MetadataRuleCondition } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "metadata_field_id": null,
+  "populated": null,
+  "includes": null,
+  "equals": null,
+  "and": null,
+  "or": null,
+} satisfies MetadataRuleCondition
+
+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 MetadataRuleCondition
+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/MetadataRuleFieldCondition.md

@@ -0,0 +1,41 @@
+
+# MetadataRuleFieldCondition
+
+Tests one field\'s value. Every predicate present must hold.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`metadata_field_id` | string
+`populated` | boolean
+`includes` | Array<string>
+`equals` | [MetadataRuleFieldConditionEquals](MetadataRuleFieldConditionEquals.md)
+
+## Example
+
+```typescript
+import type { MetadataRuleFieldCondition } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "metadata_field_id": null,
+  "populated": null,
+  "includes": null,
+  "equals": null,
+} satisfies MetadataRuleFieldCondition
+
+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 MetadataRuleFieldCondition
+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/MetadataRuleFieldConditionEquals.md

@@ -0,0 +1,33 @@
+
+# MetadataRuleFieldConditionEquals
+
+The field\'s value equals this value, or this set of option external ids
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MetadataRuleFieldConditionEquals } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MetadataRuleFieldConditionEquals
+
+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 MetadataRuleFieldConditionEquals
+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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudinary/apps-api",
-  "version": "2.2605.85",
+  "version": "2.2605.86",
   "description": "OpenAPI client for @cloudinary/apps-api",
   "author": "OpenAPI-Generator",
   "main": "./dist/index.js",

package/src/apis/AssetManagementApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -45,6 +45,7 @@ import type {
   ListCollectionsResponse,
   ListContextualMetadataFieldsResponse,
   ListMetadataFieldsResponse,
+  ListMetadataRulesResponse,
   ListPortalsResponse,
   ListPublicLinksResponse,
   ListSavedSearchesResponse,
@@ -139,6 +140,8 @@ import {
     ListContextualMetadataFieldsResponseToJSON,
     ListMetadataFieldsResponseFromJSON,
     ListMetadataFieldsResponseToJSON,
+    ListMetadataRulesResponseFromJSON,
+    ListMetadataRulesResponseToJSON,
     ListPortalsResponseFromJSON,
     ListPortalsResponseToJSON,
     ListPublicLinksResponseFromJSON,
@@ -344,6 +347,10 @@ export interface AssetManagementApiListAssetMetadataFieldsRequest {
     xCldCloudName?: string;
 }
 
+export interface AssetManagementApiListAssetMetadataRulesRequest {
+    xCldCloudName?: string;
+}
+
 export interface AssetManagementApiListAssetsByFolderRequest {
     folderId?: string;
     resourceType?: ListAssetsByFolderResourceTypeEnum;
@@ -1754,6 +1761,49 @@ export class AssetManagementApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns all conditional metadata rules for the cloud, active and inactive. Each rule targets one structured metadata field (metadata_field_id) and holds a condition and a result. dependency_sort lists field ids in evaluation order, and items follow that order.
+     * List conditional metadata rules
+     */
+    async listAssetMetadataRulesRaw(requestParameters: AssetManagementApiListAssetMetadataRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMetadataRulesResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xCldCloudName'] != null) {
+            headerParameters['X-Cld-Cloud-Name'] = String(requestParameters['xCldCloudName']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v2605/asset-management/assets/metadata/rules`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListMetadataRulesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns all conditional metadata rules for the cloud, active and inactive. Each rule targets one structured metadata field (metadata_field_id) and holds a condition and a result. dependency_sort lists field ids in evaluation order, and items follow that order.
+     * List conditional metadata rules
+     */
+    async listAssetMetadataRules(requestParameters: AssetManagementApiListAssetMetadataRulesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMetadataRulesResponse> {
+        const response = await this.listAssetMetadataRulesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns assets within a folder identified by folder_id, with optional resource_type filter, sorting, and cursor-based pagination.
      * List assets in a folder

package/src/apis/ConsoleApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/MediaApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PlatformApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/UploadApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/UtilsApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddCollectionAssetsRequest.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddCollectionAssetsResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddPortalCollectionsRequest.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/Addon.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddonSubscription.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AiVisionGeneralResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyticsResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyzeAiVisionGeneralRequest.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyzeAiVisionGeneralRequestSource.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageErrorResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageGetResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageSetErrorResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageSetResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.85
+ * The version of the OpenAPI document: 2.2605.86
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).