@cloudinary/apps-api 2.2605.49

package/docs/UpdateCollectionRequest.md

@@ -0,0 +1,38 @@
+
+# UpdateCollectionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`dynamic_filters` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { UpdateCollectionRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "dynamic_filters": null,
+} satisfies UpdateCollectionRequest
+
+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 UpdateCollectionRequest
+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/UpdateCollectionResponse.md

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

@@ -0,0 +1,210 @@
+# UploadApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deprecatedPostCloudinaryUploadCloudNameResourceTypeTags**](UploadApi.md#deprecatedpostcloudinaryuploadcloudnameresourcetypetags) | **POST** /cloudinary/upload/{cloud_name}/{resource_type}/tags |  |
+| [**deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload**](UploadApi.md#deprecatedpostcloudinaryuploadcloudnameresourcetypeupload) | **POST** /cloudinary/upload/{cloud_name}/{resource_type}/upload | Upload an asset to Cloudinary |
+
+
+
+## deprecatedPostCloudinaryUploadCloudNameResourceTypeTags
+
+> UpdateAssetTagsResponse deprecatedPostCloudinaryUploadCloudNameResourceTypeTags(cloudName, resourceType, updateAssetTagsRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostCloudinaryUploadCloudNameResourceTypeTagsRequest } 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 UploadApi(config);
+
+  const body = {
+    // string
+    cloudName: cloudName_example,
+    // string | The resource type (e.g., image, video, raw)
+    resourceType: resourceType_example,
+    // UpdateAssetTagsRequest (optional)
+    updateAssetTagsRequest: ...,
+  } satisfies DeprecatedPostCloudinaryUploadCloudNameResourceTypeTagsRequest;
+
+  try {
+    const data = await api.deprecatedPostCloudinaryUploadCloudNameResourceTypeTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **cloudName** | `string` |  | [Defaults to `undefined`] |
+| **resourceType** | `string` | The resource type (e.g., image, video, raw) | [Defaults to `undefined`] |
+| **updateAssetTagsRequest** | [UpdateAssetTagsRequest](UpdateAssetTagsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UpdateAssetTagsResponse**](UpdateAssetTagsResponse.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** | Tag added successfully |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload
+
+> UploadAssetResponse deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload(cloudName, resourceType, file, signature, apiKey, timestamp, publicId, folder, tags, type, resourceType2, overwrite, invalidate, context, metadata, transformation, format, eager, async)
+
+Upload an asset to Cloudinary
+
+Proxies an upload request to Cloudinary. Client must provide signature and api_key. Accepts multipart/form-data (with binary file) or application/json (with URL or base64 data URI).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadApi,
+} from '@cloudinary/apps-api';
+import type { DeprecatedPostCloudinaryUploadCloudNameResourceTypeUploadRequest } 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 UploadApi(config);
+
+  const body = {
+    // string
+    cloudName: cloudName_example,
+    // string | The resource type (image, video, raw, auto)
+    resourceType: resourceType_example,
+    // Blob | The binary file to upload
+    file: BINARY_DATA_HERE,
+    // string | The authentication signature for the upload request
+    signature: signature_example,
+    // string | The API key for authentication
+    apiKey: apiKey_example,
+    // string | Unix timestamp for signature validation (optional)
+    timestamp: timestamp_example,
+    // string | Custom public identifier for the uploaded asset (optional)
+    publicId: publicId_example,
+    // string | Folder name where the file should be stored (optional)
+    folder: folder_example,
+    // string | Comma-separated list of tags (optional)
+    tags: tags_example,
+    // string | Storage/delivery type (upload, private, authenticated) (optional)
+    type: type_example,
+    // string | The type of resource (image, video, raw, auto) (optional)
+    resourceType2: resourceType_example,
+    // string | Whether to overwrite an existing asset (true/false) (optional)
+    overwrite: overwrite_example,
+    // string | Whether to invalidate CDN cache (true/false) (optional)
+    invalidate: invalidate_example,
+    // string | Pipe-separated contextual metadata (optional)
+    context: context_example,
+    // string | Pipe-separated structured metadata (optional)
+    metadata: metadata_example,
+    // string | Transformation to apply on upload (optional)
+    transformation: transformation_example,
+    // string | Format to convert to (optional)
+    format: format_example,
+    // string | Eager transformations to generate (optional)
+    eager: eager_example,
+    // string | Whether to generate eager transformations asynchronously (true/false) (optional)
+    async: async_example,
+  } satisfies DeprecatedPostCloudinaryUploadCloudNameResourceTypeUploadRequest;
+
+  try {
+    const data = await api.deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **cloudName** | `string` |  | [Defaults to `undefined`] |
+| **resourceType** | `string` | The resource type (image, video, raw, auto) | [Defaults to `undefined`] |
+| **file** | `Blob` | The binary file to upload | [Defaults to `undefined`] |
+| **signature** | `string` | The authentication signature for the upload request | [Defaults to `undefined`] |
+| **apiKey** | `string` | The API key for authentication | [Defaults to `undefined`] |
+| **timestamp** | `string` | Unix timestamp for signature validation | [Optional] [Defaults to `undefined`] |
+| **publicId** | `string` | Custom public identifier for the uploaded asset | [Optional] [Defaults to `undefined`] |
+| **folder** | `string` | Folder name where the file should be stored | [Optional] [Defaults to `undefined`] |
+| **tags** | `string` | Comma-separated list of tags | [Optional] [Defaults to `undefined`] |
+| **type** | `string` | Storage/delivery type (upload, private, authenticated) | [Optional] [Defaults to `undefined`] |
+| **resourceType2** | `string` | The type of resource (image, video, raw, auto) | [Optional] [Defaults to `undefined`] |
+| **overwrite** | `string` | Whether to overwrite an existing asset (true/false) | [Optional] [Defaults to `undefined`] |
+| **invalidate** | `string` | Whether to invalidate CDN cache (true/false) | [Optional] [Defaults to `undefined`] |
+| **context** | `string` | Pipe-separated contextual metadata | [Optional] [Defaults to `undefined`] |
+| **metadata** | `string` | Pipe-separated structured metadata | [Optional] [Defaults to `undefined`] |
+| **transformation** | `string` | Transformation to apply on upload | [Optional] [Defaults to `undefined`] |
+| **format** | `string` | Format to convert to | [Optional] [Defaults to `undefined`] |
+| **eager** | `string` | Eager transformations to generate | [Optional] [Defaults to `undefined`] |
+| **async** | `string` | Whether to generate eager transformations asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadAssetResponse**](UploadAssetResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Asset uploaded successfully |  -  |
+
+[[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/UploadAssetRequest.md

@@ -0,0 +1,66 @@
+
+# UploadAssetRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`file` | Blob
+`signature` | string
+`api_key` | string
+`timestamp` | string
+`public_id` | string
+`folder` | string
+`tags` | string
+`type` | string
+`resource_type` | string
+`overwrite` | string
+`invalidate` | string
+`context` | string
+`metadata` | string
+`transformation` | string
+`format` | string
+`eager` | string
+`async` | string
+
+## Example
+
+```typescript
+import type { UploadAssetRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "file": null,
+  "signature": null,
+  "api_key": null,
+  "timestamp": null,
+  "public_id": null,
+  "folder": null,
+  "tags": null,
+  "type": null,
+  "resource_type": null,
+  "overwrite": null,
+  "invalidate": null,
+  "context": null,
+  "metadata": null,
+  "transformation": null,
+  "format": null,
+  "eager": null,
+  "async": null,
+} satisfies UploadAssetRequest
+
+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 UploadAssetRequest
+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/UploadAssetRequest1.md

@@ -0,0 +1,66 @@
+
+# UploadAssetRequest1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`file` | string
+`signature` | string
+`api_key` | string
+`timestamp` | number
+`public_id` | string
+`folder` | string
+`tags` | string
+`type` | string
+`resource_type` | string
+`overwrite` | boolean
+`invalidate` | boolean
+`context` | string
+`metadata` | string
+`transformation` | string
+`format` | string
+`eager` | string
+`async` | boolean
+
+## Example
+
+```typescript
+import type { UploadAssetRequest1 } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "file": null,
+  "signature": null,
+  "api_key": null,
+  "timestamp": null,
+  "public_id": null,
+  "folder": null,
+  "tags": null,
+  "type": null,
+  "resource_type": null,
+  "overwrite": null,
+  "invalidate": null,
+  "context": null,
+  "metadata": null,
+  "transformation": null,
+  "format": null,
+  "eager": null,
+  "async": null,
+} satisfies UploadAssetRequest1
+
+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 UploadAssetRequest1
+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/UploadAssetResponse.md

@@ -0,0 +1,64 @@
+
+# UploadAssetResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`public_id` | string
+`version` | number
+`signature` | string
+`width` | number
+`height` | number
+`format` | string
+`resource_type` | string
+`created_at` | string
+`tags` | Array<string>
+`bytes` | number
+`type` | string
+`etag` | string
+`placeholder` | boolean
+`url` | string
+`secure_url` | string
+`access_mode` | string
+
+## Example
+
+```typescript
+import type { UploadAssetResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "public_id": null,
+  "version": null,
+  "signature": null,
+  "width": null,
+  "height": null,
+  "format": null,
+  "resource_type": null,
+  "created_at": null,
+  "tags": null,
+  "bytes": null,
+  "type": null,
+  "etag": null,
+  "placeholder": null,
+  "url": null,
+  "secure_url": null,
+  "access_mode": null,
+} satisfies UploadAssetResponse
+
+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 UploadAssetResponse
+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)
+
+