@cloudinary/apps-api
v2.2605.52
Published
OpenAPI client for @cloudinary/apps-api
Downloads
444
Readme
@cloudinary/apps-api
A TypeScript SDK client for the localhost API.
Usage
First, install the SDK from npm.
npm install @cloudinary/apps-api --saveNext, try it out.
import {
Configuration,
AssetManagementApi,
} from '@cloudinary/apps-api';
import type { AddCollectionAssetsOperationRequest } 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 | Collection external ID
collectionId: collectionId_example,
// AddCollectionAssetsRequest (optional)
addCollectionAssetsRequest: ...,
} satisfies AddCollectionAssetsOperationRequest;
try {
const data = await api.addCollectionAssets(body);
console.log(data);
} catch (error) {
console.error(error);
}
}
// Run the test
example().catch(console.error);Documentation
API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AssetManagementApi | addCollectionAssets | POST /v2605/asset-management/collections/{collection_id}/assets | Add assets to a collection AssetManagementApi | autocompleteAssets | GET /v2605/asset-management/assets/autocomplete | Autocomplete across assets, folders, collections, tags, and metadata AssetManagementApi | createAssetMetadataField | POST /v2605/asset-management/assets/metadata/fields | Create a structured metadata field definition AssetManagementApi | createCollection | POST /v2605/asset-management/collections | Create a collection AssetManagementApi | createFolder | POST /v2605/asset-management/folders | Create a folder AssetManagementApi | deleteFolder | DELETE /v2605/asset-management/folders/{id} | Delete a folder AssetManagementApi | destroyCollection | DELETE /v2605/asset-management/collections/{collection_id} | Delete a collection AssetManagementApi | downloadAsset | POST /v2605/asset-management/assets/download | Generate a download URL for an asset AssetManagementApi | downloadCollection | POST /v2605/asset-management/collections/{collection_id}/download | Download a collection as an archive AssetManagementApi | listAssetBackreferences | GET /v2605/asset-management/backreferences/assets/{assetId} | List backreferences for an asset AssetManagementApi | listAssetContextFields | GET /v2605/asset-management/assets/metadata/context-fields | List contextual metadata fields AssetManagementApi | listAssetHistory | GET /v2605/asset-management/assets/{external_id}/asset-history | List asset audit history AssetManagementApi | listAssetMetadataFields | GET /v2605/asset-management/assets/metadata/fields | List structured metadata field definitions AssetManagementApi | listAssetsByFolder | GET /v2605/asset-management/assets/by-folder | List assets in a folder AssetManagementApi | listCollections | GET /v2605/asset-management/collections | List collections AssetManagementApi | listSubfolders | GET /v2605/asset-management/folders/subfolders | List child folders AssetManagementApi | listTransformations | GET /v2605/asset-management/transformations | List named transformations AssetManagementApi | removeCollectionAssets | DELETE /v2605/asset-management/collections/{collection_id}/assets | Remove assets from a collection AssetManagementApi | searchAssets | POST /v2605/asset-management/assets/search | Search assets using Cloudinary expression language AssetManagementApi | searchCollections | POST /v2605/asset-management/collections/search | Search collections AssetManagementApi | searchTemplates | GET /v2605/asset-management/templates | Search creative automation templates AssetManagementApi | showCollection | GET /v2605/asset-management/collections/{collection_id} | Get a single collection with its assets AssetManagementApi | updateAssetBackreferences | POST /v2605/asset-management/backreferences/assets | Create, update, or remove asset backreferences AssetManagementApi | updateAssetMetadata | PATCH /v2605/asset-management/assets/metadata | Update asset contextual and structured metadata AssetManagementApi | updateAssetTags | POST /v2605/asset-management/assets/{resource_type}/tags | Add or remove a tag on assets AssetManagementApi | updateCollection | PUT /v2605/asset-management/collections/{collection_id} | Update a collection ConsoleApi | deprecatedDeleteCloudinaryConsoleFoldersId | DELETE /cloudinary/console/folders/{id} | Deletes a folder by its external ID. Fails upstream if the folder still contains assets. ConsoleApi | deprecatedGetCloudinaryConsoleAuthCredentials | GET /cloudinary/console/auth/credentials | Get current user and cloud credentials ConsoleApi | deprecatedGetCloudinaryConsoleAutocomplete | GET /cloudinary/console/autocomplete | Autocomplete for assets, folders, collections tags and metadata-field-options search ConsoleApi | deprecatedGetCloudinaryConsoleCustomers | GET /cloudinary/console/customers | Lists customers ConsoleApi | deprecatedGetCloudinaryConsoleFoldersSubfolders | GET /cloudinary/console/folders/subfolders | Lists folders in path ConsoleApi | deprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudName | GET /cloudinary/console/handlers/customers/by_cloud/{cloud_name} | customer by cloud ConsoleApi | deprecatedGetCloudinaryConsoleHandlersMetadataContextFields | GET /cloudinary/console/handlers/metadata/context-fields | List contextual metadata fields ConsoleApi | deprecatedGetCloudinaryConsoleHandlersMetadataFields | GET /cloudinary/console/handlers/metadata/fields | List structured metadata fields ConsoleApi | deprecatedGetCloudinaryConsoleRestResourcesByFolder | GET /cloudinary/console/rest_resources/by_folder | Lists resources in a folder ConsoleApi | deprecatedGetCloudinaryConsoleTransformations | GET /cloudinary/console/transformations | List of named Transformations ConsoleApi | deprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariant | GET /cloudinary/res-console/thumbnails/{cloud_name}/{resource_type}/{type}/{version}/{variant} | res console ConsoleApi | deprecatedPatchCloudinaryConsoleHandlersAssetMetadata | PATCH /cloudinary/console/handlers/asset/metadata | res console ConsoleApi | deprecatedPostCloudinaryConsoleAuthPrepareUpload | POST /cloudinary/console/auth/prepare_upload | Get current user and cloud credentials ConsoleApi | deprecatedPostCloudinaryConsoleAuthThumbnailsToken | POST /cloudinary/console/auth/thumbnails_token | Get thumbnail token ConsoleApi | deprecatedPostCloudinaryConsoleFolders | POST /cloudinary/console/folders | Creates a new subfolder under the specified parent folder, or under root if no parent is given.2 ConsoleApi | deprecatedPostCloudinaryConsoleHandlersSignAndUpload | POST /cloudinary/console/handlers/sign_and_upload | Sign and upload an asset to Cloudinary ConsoleApi | deprecatedPostCloudinaryConsoleOperationsDownload | POST /cloudinary/console/operations/download | Downloads a resource ConsoleApi | deprecatedPostCloudinaryConsoleSearch | POST /cloudinary/console/search | Search resources MediaApi | analyzeAiVisionGeneral | POST /v2605/media/analysis/ai-vision | Generate AI Vision analysis (e.g. alt text) for an asset MediaApi | createThumbnailToken | POST /v2605/media/thumbnails/token | Generate a time-limited thumbnail access token MediaApi | getThumbnail | GET /v2605/media/thumbnails/{resource_type}/{type}/{version}/{variant} | Fetch a rendered thumbnail for an asset MediaApi | listGoogleFonts | GET /v2605/media/fonts/google/web-fonts | List all available Google Web Fonts MediaApi | lookupFont | POST /v2605/media/fonts/lookup | Look up font availability MediaApi | prepareUpload | POST /v2605/media/uploads/prepare | Prepare and sign upload parameters MediaApi | provisionFont | POST /v2605/media/fonts/provision | Provision fonts into the cloud MediaApi | signAndUpload | POST /v2605/media/uploads/sign-and-upload | Sign and upload an asset in one step MediaApi | uploadAsset | POST /v2605/media/uploads/{resource_type} | Upload an asset with a pre-signed signature PlatformApi | createNamespaceToken | POST /v2605/platform/apps/storage/namespace-token | Create a namespace token for shared app storage PlatformApi | deployApp | POST /v2605/platform/apps/{app_id}/deploy | Deploy a DAM app bundle PlatformApi | getApp | GET /v2605/platform/apps/{app_id} | Get a DAM app PlatformApi | getAppStorageValue | GET /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Get a value from app persistent storage PlatformApi | getAuthCredentials | GET /v2605/platform/auth/credentials | Get current user and cloud identity PlatformApi | getCustomerByCloud | GET /v2605/platform/customers/by-cloud/{cloud_name} | Get a customer by cloud name PlatformApi | listCustomers | GET /v2605/platform/customers | List customers (clouds) accessible to the user PlatformApi | refreshCloudinaryToken | GET /v2605/platform/auth/tokens/cloudinary/{type}/refresh | Refresh a Cloudinary token PlatformApi | setAppStorageValue | PUT /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Set a value in app persistent storage PlatformApi | trackAnalyticsEvent | POST /v2605/platform/analytics | Submit analytics events PlatformApi | updateApp | PUT /v2605/platform/apps/{app_id} | Update DAM app configuration PlatformApi | validateToken | GET /v2605/platform/auth/tokens/validate | Validate a gateway token UploadApi | deprecatedPostCloudinaryUploadCloudNameResourceTypeTags | POST /cloudinary/upload/{cloud_name}/{resource_type}/tags | UploadApi | deprecatedPostCloudinaryUploadCloudNameResourceTypeUpload | POST /cloudinary/upload/{cloud_name}/{resource_type}/upload | Upload an asset to Cloudinary UtilsApi | deprecatedGetUtilsAppStorageNamespaceTokenLevelKey | GET /utils/app_storage/{namespace_token}/{level}/{key} | Get persistent storage value UtilsApi | deprecatedGetUtilsAuthCloudinaryTokenTypeRefresh | GET /utils/auth/cloudinary/token/{type}/refresh | res console UtilsApi | deprecatedGetUtilsBackreferenceAssetAssetId | GET /utils/backreference/asset/{assetId} | List asset backreferences UtilsApi | deprecatedGetUtilsFontsGoogleWebFonts | GET /utils/fonts/google/web-fonts | google web fonts listing UtilsApi | deprecatedGetUtilsValidateToken | GET /utils/validate_token | validate JWT token UtilsApi | deprecatedPostUtilsAnalytics | POST /utils/analytics | Submit analytics events UtilsApi | deprecatedPostUtilsBackreferenceAsset | POST /utils/backreference/asset | Manage asset backreferences UtilsApi | deprecatedPostUtilsFontsLookup | POST /utils/fonts/lookup | lookup fonts UtilsApi | deprecatedPostUtilsFontsProvision | POST /utils/fonts/provision | lookup fonts UtilsApi | deprecatedPutUtilsAppStorageNamespaceTokenLevelKey | PUT /utils/app_storage/{namespace_token}/{level}/{key} | Set persistent storage value
Models
- AddCollectionAssetsRequest
- AddCollectionAssetsResponse
- AiVisionGeneralResponse
- AnalyticsResponse
- AnalyzeAiVisionGeneralRequest
- AnalyzeAiVisionGeneralRequestSource
- AppStorageErrorResponse
- AppStorageGetResponse
- AppStorageSetErrorResponse
- AppStorageSetResponse
- Asset
- AssetHistoryResponse
- AssetHistoryResponseAssetHistoryInner
- AssetSearchResponse
- AuthCredentialsResponse
- AuthCustomer
- AuthUser
- AutocompleteAsset
- AutocompleteAssetCustomer
- AutocompleteAssetCustomerCustomer
- AutocompleteAssetCustomerCustomerCdnConfigAttrs
- AutocompleteAssetCustomerCustomerConfig
- AutocompleteAssetCustomerCustomerConfigFlagProbabilities
- AutocompleteAssetCustomerCustomerConfigHookTimeouts
- AutocompleteAssetCustomerCustomerLimits
- AutocompleteAssetFullProps
- AutocompleteAssetFullPropsCreatedBy
- AutocompleteFolder
- AutocompleteResponse
- BackreferenceHistoryEntry
- BackreferenceResult
- BackreferenceResultBackref
- CldtTemplate
- CldtTemplateCanvas
- CldtTemplateProvenance
- CldtTemplateVariable
- Collection
- CollectionPermissions
- ContextualMetadataField
- CreateAssetMetadataFieldRequest
- CreateCollectionRequest
- CreateCollectionResponse
- CreateFolderRequest
- CreateFolderResponse
- CreateFolderResponseFolder
- CreateFolderResponseFolderViewableParentsInner
- CreateMetadataFieldResponse
- CreateNamespaceTokenRequest
- Customer
- CustomerListMeta
- CustomerUploadLimits
- DamAppErrorResponse
- DamAppResponse
- DamAppResponseAppMessageParamsValue
- DamAppResponseAppMessageParamsValueAnyOf
- DamAppResponseAssetAmountLimit
- DamAppUserSnapshot
- DeleteFolderResponse
- DeployApp200Response
- DeployApp207Response
- DeployApp400Response
- DeployAppRequest
- DownloadAssetRequest
- DownloadAssetResponse
- DownloadCollectionResponse
- ErrorResponse
- ErrorWithMessageResponse
- FieldAggregation
- FieldAggregationBucketsInner
- FontDefinition
- FontLookupResponse
- FontLookupResponseFontsInner
- FontProvisioningResponse
- ForbiddenResponse
- GoogleFontListingResponse
- ListAssetsByFolderResponse
- ListAssetsByFolderResponseMeta
- ListBackreferencesResponse
- ListBackreferencesResponseBackrefsInner
- ListCollectionsResponse
- ListContextualMetadataFieldsResponse
- ListCustomersResponse
- ListMetadataFieldsResponse
- ListSubfoldersResponse
- ListSubfoldersResponseFoldersInner
- ListTransformationsResponse
- LocationSegment
- LookupFontRequest
- LookupFontRequestFontsInner
- NamespaceTokenCreateErrorResponse
- NamespaceTokenCreateResponse
- PrepareUploadRequest
- PrepareUploadRequestUploadParams
- PrepareUploadResponse
- ProvisionFontRequest
- RefreshTokenErrorResponse
- RefreshTokenResponse
- RemoveCollectionAssetsRequest
- RemoveCollectionAssetsResponse
- ResourceActor
- SearchAsset
- SearchCollectionsRequest
- SearchCollectionsResponse
- SetAppStorageValueRequest
- SignAndUploadRequest
- SignAndUploadRequest1
- SignAndUploadResponse
- StructuredMetadataField
- TemplateResourceTuple
- TemplateSearchResponse
- ThumbnailsTokenResponse
- TrackAnalyticsEventRequest
- Transformation
- UpdateAppRequest
- UpdateAssetBackreferencesRequest
- UpdateAssetMetadataRequest
- UpdateAssetMetadataRequestMetadataValue
- UpdateAssetMetadataResponse
- UpdateAssetTagsRequest
- UpdateAssetTagsResponse
- UpdateBackreferencesResponse
- UpdateCollectionRequest
- UpdateCollectionResponse
- UploadAssetRequest
- UploadAssetRequest1
- UploadAssetResponse
- ValidateTokenResponse
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: HTTP Bearer Token authentication (JWT)
About
This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:
- API version:
2.2605.52 - Package version:
2.2605.52 - Generator version:
7.17.0 - Build package:
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen
The generated npm module supports the following:
- Environments
- Node.js
- Webpack
- Browserify
- Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
- Module systems
- CommonJS
- ES6 module system
Development
Building
To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:
npm install
npm run buildPublishing
Once you've built the package, you can publish it to npm:
npm publish