@cloudinary/apps-api 2.2605.72 → 2.2605.74

package/docs/AssetManagementApi.md

@@ -13,10 +13,12 @@ All URIs are relative to *http://localhost*
 | [**createPortal**](AssetManagementApi.md#createportaloperation) | **POST** /v2605/asset-management/portals | Create a portal |
 | [**createPublicLink**](AssetManagementApi.md#createpubliclinkoperation) | **POST** /v2605/asset-management/{subject_type}/{subject_id}/public-links | Create a public link for an entity |
 | [**createSavedSearch**](AssetManagementApi.md#createsavedsearchoperation) | **POST** /v2605/asset-management/saved-searches | Create a saved search |
+| [**createTransformation**](AssetManagementApi.md#createtransformationoperation) | **POST** /v2605/asset-management/transformations | Create a named transformation |
 | [**deleteFolder**](AssetManagementApi.md#deletefolder) | **DELETE** /v2605/asset-management/folders/{id} | Delete a folder |
 | [**deletePortal**](AssetManagementApi.md#deleteportal) | **DELETE** /v2605/asset-management/portals/{id} | Delete a portal |
 | [**deletePublicLink**](AssetManagementApi.md#deletepubliclink) | **DELETE** /v2605/asset-management/{subject_type}/{subject_id}/public-links/{id} | Revoke a public link |
 | [**deleteSavedSearch**](AssetManagementApi.md#deletesavedsearch) | **DELETE** /v2605/asset-management/saved-searches/{id} | Delete a saved search |
+| [**deleteTransformation**](AssetManagementApi.md#deletetransformation) | **DELETE** /v2605/asset-management/transformations/{signature} | Delete a named transformation |
 | [**destroyCollection**](AssetManagementApi.md#destroycollection) | **DELETE** /v2605/asset-management/collections/{collection_id} | Delete a collection |
 | [**downloadAsset**](AssetManagementApi.md#downloadassetoperation) | **POST** /v2605/asset-management/assets/download | Generate a download URL for an asset |
 | [**downloadCollection**](AssetManagementApi.md#downloadcollection) | **POST** /v2605/asset-management/collections/{collection_id}/download | Download a collection as an archive |
@@ -42,6 +44,7 @@ All URIs are relative to *http://localhost*
 | [**showCollection**](AssetManagementApi.md#showcollection) | **GET** /v2605/asset-management/collections/{collection_id} | Get a single collection with its assets |
 | [**showPortal**](AssetManagementApi.md#showportal) | **GET** /v2605/asset-management/portals/{id} | Get a portal |
 | [**showSavedSearch**](AssetManagementApi.md#showsavedsearch) | **GET** /v2605/asset-management/saved-searches/{id} | Get a saved search |
+| [**showTransformation**](AssetManagementApi.md#showtransformation) | **GET** /v2605/asset-management/transformations/{signature} | Get a named transformation |
 | [**updateAssetBackreferences**](AssetManagementApi.md#updateassetbackreferencesoperation) | **POST** /v2605/asset-management/backreferences/assets | Create, update, or remove asset backreferences |
 | [**updateAssetMetadata**](AssetManagementApi.md#updateassetmetadataoperation) | **PATCH** /v2605/asset-management/assets/metadata | Update asset contextual and structured metadata |
 | [**updateAssetTags**](AssetManagementApi.md#updateassettagsoperation) | **POST** /v2605/asset-management/assets/{resource_type}/tags | Add or remove a tag on assets |
@@ -50,6 +53,7 @@ All URIs are relative to *http://localhost*
 | [**updatePortal**](AssetManagementApi.md#updateportaloperation) | **PUT** /v2605/asset-management/portals/{id} | Update a portal |
 | [**updatePublicLink**](AssetManagementApi.md#updatepubliclinkoperation) | **PUT** /v2605/asset-management/{subject_type}/{subject_id}/public-links/{id} | Update a public link |
 | [**updateSavedSearch**](AssetManagementApi.md#updatesavedsearch) | **PUT** /v2605/asset-management/saved-searches/{id} | Update a saved search |
+| [**updateTransformation**](AssetManagementApi.md#updatetransformationoperation) | **PUT** /v2605/asset-management/transformations/{signature} | Update a named transformation |
 
 
 
@@ -765,6 +769,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createTransformation
+
+> Transformation createTransformation(xCldCloudName, createTransformationRequest)
+
+Create a named transformation
+
+Defines a new named transformation in the cloud from a transformation string
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetManagementApi,
+} from '@cloudinary/apps-api';
+import type { CreateTransformationOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AssetManagementApi(config);
+
+  const body = {
+    // 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,
+    // CreateTransformationRequest (optional)
+    createTransformationRequest: ...,
+  } satisfies CreateTransformationOperationRequest;
+
+  try {
+    const data = await api.createTransformation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **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`] |
+| **createTransformationRequest** | [CreateTransformationRequest](CreateTransformationRequest.md) |  | [Optional] |
+
+### Return type
+
+[**Transformation**](Transformation.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteFolder
 
 > DeleteFolderResponse deleteFolder(id, deleteResources, xCldCloudName)
@@ -1073,6 +1152,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteTransformation
+
+> DeleteTransformationResponse deleteTransformation(signature, xCldCloudName)
+
+Delete a named transformation
+
+Deletes a named transformation by signature
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetManagementApi,
+} from '@cloudinary/apps-api';
+import type { DeleteTransformationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AssetManagementApi(config);
+
+  const body = {
+    // string | Transformation signature, as returned in the `signature` field by listTransformations
+    signature: signature_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,
+  } satisfies DeleteTransformationRequest;
+
+  try {
+    const data = await api.deleteTransformation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **signature** | `string` | Transformation signature, as returned in the `signature` field by listTransformations | [Defaults to `undefined`] |
+| **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
+
+[**DeleteTransformationResponse**](DeleteTransformationResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## destroyCollection
 
 > Collection destroyCollection(collectionId, xCldCloudName)
@@ -3049,6 +3203,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## showTransformation
+
+> Transformation showTransformation(signature, xCldCloudName)
+
+Get a named transformation
+
+Returns a single named transformation by signature
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetManagementApi,
+} from '@cloudinary/apps-api';
+import type { ShowTransformationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AssetManagementApi(config);
+
+  const body = {
+    // string | Transformation signature, as returned in the `signature` field by listTransformations
+    signature: signature_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,
+  } satisfies ShowTransformationRequest;
+
+  try {
+    const data = await api.showTransformation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **signature** | `string` | Transformation signature, as returned in the `signature` field by listTransformations | [Defaults to `undefined`] |
+| **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
+
+[**Transformation**](Transformation.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## updateAssetBackreferences
 
 > UpdateBackreferencesResponse updateAssetBackreferences(xCldCloudName, updateAssetBackreferencesRequest)
@@ -3668,3 +3897,81 @@ example().catch(console.error);
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## updateTransformation
+
+> UpdateTransformationResponse updateTransformation(signature, xCldCloudName, updateTransformationRequest)
+
+Update a named transformation
+
+Updates a named transformation\'s definition, strict-transformation allowance, or preset usage
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetManagementApi,
+} from '@cloudinary/apps-api';
+import type { UpdateTransformationOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AssetManagementApi(config);
+
+  const body = {
+    // string | Transformation signature, as returned in the `signature` field by listTransformations
+    signature: signature_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,
+    // UpdateTransformationRequest (optional)
+    updateTransformationRequest: ...,
+  } satisfies UpdateTransformationOperationRequest;
+
+  try {
+    const data = await api.updateTransformation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **signature** | `string` | Transformation signature, as returned in the `signature` field by listTransformations | [Defaults to `undefined`] |
+| **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`] |
+| **updateTransformationRequest** | [UpdateTransformationRequest](UpdateTransformationRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UpdateTransformationResponse**](UpdateTransformationResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **403** | Forbidden |  -  |
+
+[[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/CreateTransformationRequest.md

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

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

@@ -9,12 +9,13 @@ Name | Type
 `signature` | string
 `name` | string
 `is_allowed_for_strict` | boolean
-`transformation` | string
+`transformation_string` | string
 `is_in_presets` | boolean
 `thumbnail_url` | string
 `preset_types` | Array<string>
 `created_at` | string
 `updated_at` | string
+`derived_resources_count` | [TransformationDerivedResourcesCount](TransformationDerivedResourcesCount.md)
 
 ## Example
 
@@ -26,12 +27,13 @@ const example = {
   "signature": null,
   "name": null,
   "is_allowed_for_strict": null,
-  "transformation": null,
+  "transformation_string": null,
   "is_in_presets": null,
   "thumbnail_url": null,
   "preset_types": null,
   "created_at": null,
   "updated_at": null,
+  "derived_resources_count": null,
 } satisfies Transformation
 
 console.log(example)

package/docs/TransformationDerivedResourcesCount.md

@@ -0,0 +1,37 @@
+
+# TransformationDerivedResourcesCount
+
+Number of derived assets produced by this transformation; relation is `eq` or `gte`
+
+## Properties
+
+Name | Type
+------------ | -------------
+`value` | number
+`relation` | string
+
+## Example
+
+```typescript
+import type { TransformationDerivedResourcesCount } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "value": null,
+  "relation": null,
+} satisfies TransformationDerivedResourcesCount
+
+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 TransformationDerivedResourcesCount
+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/UpdateTransformationRequest.md

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

@@ -0,0 +1,34 @@
+
+# UpdateTransformationResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { UpdateTransformationResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies UpdateTransformationResponse
+
+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 UpdateTransformationResponse
+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.72",
+  "version": "2.2605.74",
   "description": "OpenAPI client for @cloudinary/apps-api",
   "author": "OpenAPI-Generator",
   "main": "./dist/index.js",