@cloudinary/apps-api 2.2605.52 → 2.2605.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +50 -0
- package/README.md +47 -2
- package/dist/apis/AssetManagementApi.d.ts +244 -2
- package/dist/apis/AssetManagementApi.js +765 -27
- package/dist/apis/ConsoleApi.d.ts +1 -1
- package/dist/apis/ConsoleApi.js +1 -1
- package/dist/apis/MediaApi.d.ts +1 -1
- package/dist/apis/MediaApi.js +1 -1
- package/dist/apis/PlatformApi.d.ts +37 -2
- package/dist/apis/PlatformApi.js +105 -1
- package/dist/apis/UploadApi.d.ts +1 -1
- package/dist/apis/UploadApi.js +1 -1
- package/dist/apis/UtilsApi.d.ts +1 -1
- package/dist/apis/UtilsApi.js +1 -1
- package/dist/esm/apis/AssetManagementApi.d.ts +244 -2
- package/dist/esm/apis/AssetManagementApi.js +766 -28
- package/dist/esm/apis/ConsoleApi.d.ts +1 -1
- package/dist/esm/apis/ConsoleApi.js +1 -1
- package/dist/esm/apis/MediaApi.d.ts +1 -1
- package/dist/esm/apis/MediaApi.js +1 -1
- package/dist/esm/apis/PlatformApi.d.ts +37 -2
- package/dist/esm/apis/PlatformApi.js +106 -2
- package/dist/esm/apis/UploadApi.d.ts +1 -1
- package/dist/esm/apis/UploadApi.js +1 -1
- package/dist/esm/apis/UtilsApi.d.ts +1 -1
- package/dist/esm/apis/UtilsApi.js +1 -1
- package/dist/esm/models/AddCollectionAssetsRequest.d.ts +1 -1
- package/dist/esm/models/AddCollectionAssetsRequest.js +1 -1
- package/dist/esm/models/AddCollectionAssetsResponse.d.ts +1 -1
- package/dist/esm/models/AddCollectionAssetsResponse.js +1 -1
- package/dist/esm/models/AddPortalCollectionsRequest.d.ts +32 -0
- package/dist/esm/models/AddPortalCollectionsRequest.js +43 -0
- package/dist/esm/models/AiVisionGeneralResponse.d.ts +1 -1
- package/dist/esm/models/AiVisionGeneralResponse.js +1 -1
- package/dist/esm/models/AnalyticsResponse.d.ts +1 -1
- package/dist/esm/models/AnalyticsResponse.js +1 -1
- package/dist/esm/models/AnalyzeAiVisionGeneralRequest.d.ts +1 -1
- package/dist/esm/models/AnalyzeAiVisionGeneralRequest.js +1 -1
- package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.d.ts +1 -1
- package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.js +1 -1
- package/dist/esm/models/AppStorageErrorResponse.d.ts +1 -1
- package/dist/esm/models/AppStorageErrorResponse.js +1 -1
- package/dist/esm/models/AppStorageGetResponse.d.ts +1 -1
- package/dist/esm/models/AppStorageGetResponse.js +1 -1
- package/dist/esm/models/AppStorageSetErrorResponse.d.ts +1 -1
- package/dist/esm/models/AppStorageSetErrorResponse.js +1 -1
- package/dist/esm/models/AppStorageSetResponse.d.ts +1 -1
- package/dist/esm/models/AppStorageSetResponse.js +1 -1
- package/dist/esm/models/Asset.d.ts +1 -1
- package/dist/esm/models/Asset.js +1 -1
- package/dist/esm/models/AssetHistoryResponse.d.ts +1 -1
- package/dist/esm/models/AssetHistoryResponse.js +1 -1
- package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.d.ts +1 -1
- package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.js +1 -1
- package/dist/esm/models/AssetLastDelivery.d.ts +38 -0
- package/dist/esm/models/AssetLastDelivery.js +43 -0
- package/dist/esm/models/AssetSearchResponse.d.ts +1 -1
- package/dist/esm/models/AssetSearchResponse.js +1 -1
- package/dist/esm/models/AuthCredentialsResponse.d.ts +1 -1
- package/dist/esm/models/AuthCredentialsResponse.js +1 -1
- package/dist/esm/models/AuthCustomer.d.ts +1 -1
- package/dist/esm/models/AuthCustomer.js +1 -1
- package/dist/esm/models/AuthUser.d.ts +1 -1
- package/dist/esm/models/AuthUser.js +1 -1
- package/dist/esm/models/AutocompleteAsset.d.ts +1 -1
- package/dist/esm/models/AutocompleteAsset.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomer.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomer.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomer.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomer.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.js +1 -1
- package/dist/esm/models/AutocompleteAssetFullProps.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetFullProps.js +1 -1
- package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.d.ts +1 -1
- package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.js +1 -1
- package/dist/esm/models/AutocompleteFolder.d.ts +1 -1
- package/dist/esm/models/AutocompleteFolder.js +1 -1
- package/dist/esm/models/AutocompleteResponse.d.ts +1 -1
- package/dist/esm/models/AutocompleteResponse.js +1 -1
- package/dist/esm/models/BackreferenceHistoryEntry.d.ts +1 -1
- package/dist/esm/models/BackreferenceHistoryEntry.js +1 -1
- package/dist/esm/models/BackreferenceResult.d.ts +1 -1
- package/dist/esm/models/BackreferenceResult.js +1 -1
- package/dist/esm/models/BackreferenceResultBackref.d.ts +1 -1
- package/dist/esm/models/BackreferenceResultBackref.js +1 -1
- package/dist/esm/models/CldtTemplate.d.ts +1 -1
- package/dist/esm/models/CldtTemplate.js +1 -1
- package/dist/esm/models/CldtTemplateCanvas.d.ts +1 -1
- package/dist/esm/models/CldtTemplateCanvas.js +1 -1
- package/dist/esm/models/CldtTemplateProvenance.d.ts +1 -1
- package/dist/esm/models/CldtTemplateProvenance.js +1 -1
- package/dist/esm/models/CldtTemplateVariable.d.ts +1 -1
- package/dist/esm/models/CldtTemplateVariable.js +1 -1
- package/dist/esm/models/Collection.d.ts +1 -1
- package/dist/esm/models/Collection.js +1 -1
- package/dist/esm/models/CollectionPermissions.d.ts +1 -1
- package/dist/esm/models/CollectionPermissions.js +1 -1
- package/dist/esm/models/ContextualMetadataField.d.ts +1 -1
- package/dist/esm/models/ContextualMetadataField.js +1 -1
- package/dist/esm/models/CreateAssetMetadataFieldRequest.d.ts +1 -1
- package/dist/esm/models/CreateAssetMetadataFieldRequest.js +1 -1
- package/dist/esm/models/CreateCollectionRequest.d.ts +1 -1
- package/dist/esm/models/CreateCollectionRequest.js +1 -1
- package/dist/esm/models/CreateCollectionResponse.d.ts +1 -1
- package/dist/esm/models/CreateCollectionResponse.js +1 -1
- package/dist/esm/models/CreateFolderRequest.d.ts +1 -1
- package/dist/esm/models/CreateFolderRequest.js +1 -1
- package/dist/esm/models/CreateFolderResponse.d.ts +1 -1
- package/dist/esm/models/CreateFolderResponse.js +1 -1
- package/dist/esm/models/CreateFolderResponseFolder.d.ts +1 -1
- package/dist/esm/models/CreateFolderResponseFolder.js +1 -1
- package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.d.ts +1 -1
- package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.js +1 -1
- package/dist/esm/models/CreateMetadataFieldResponse.d.ts +1 -1
- package/dist/esm/models/CreateMetadataFieldResponse.js +1 -1
- package/dist/esm/models/CreateNamespaceTokenRequest.d.ts +1 -1
- package/dist/esm/models/CreateNamespaceTokenRequest.js +1 -1
- package/dist/esm/models/CreatePortalRequest.d.ts +74 -0
- package/dist/esm/models/CreatePortalRequest.js +55 -0
- package/dist/esm/models/CreatePublicLinkRequest.d.ts +44 -0
- package/dist/esm/models/CreatePublicLinkRequest.js +45 -0
- package/dist/esm/models/CreateSavedSearchRequest.d.ts +68 -0
- package/dist/esm/models/CreateSavedSearchRequest.js +58 -0
- package/dist/esm/models/CreateSavedSearchRequestSharedWithInner.d.ts +38 -0
- package/dist/esm/models/CreateSavedSearchRequestSharedWithInner.js +43 -0
- package/dist/esm/models/Customer.d.ts +1 -1
- package/dist/esm/models/Customer.js +1 -1
- package/dist/esm/models/CustomerListMeta.d.ts +1 -1
- package/dist/esm/models/CustomerListMeta.js +1 -1
- package/dist/esm/models/CustomerUploadLimits.d.ts +1 -1
- package/dist/esm/models/CustomerUploadLimits.js +1 -1
- package/dist/esm/models/DamAppErrorResponse.d.ts +1 -1
- package/dist/esm/models/DamAppErrorResponse.js +1 -1
- package/dist/esm/models/DamAppResponse.d.ts +1 -1
- package/dist/esm/models/DamAppResponse.js +1 -1
- package/dist/esm/models/DamAppResponseAppMessageParamsValue.d.ts +1 -1
- package/dist/esm/models/DamAppResponseAppMessageParamsValue.js +1 -1
- package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +1 -1
- package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.js +1 -1
- package/dist/esm/models/DamAppResponseAssetAmountLimit.d.ts +1 -1
- package/dist/esm/models/DamAppResponseAssetAmountLimit.js +1 -1
- package/dist/esm/models/DamAppUserSnapshot.d.ts +1 -1
- package/dist/esm/models/DamAppUserSnapshot.js +1 -1
- package/dist/esm/models/DashboardDataResponse.d.ts +42 -0
- package/dist/esm/models/DashboardDataResponse.js +43 -0
- package/dist/esm/models/DeleteFolderResponse.d.ts +1 -1
- package/dist/esm/models/DeleteFolderResponse.js +1 -1
- package/dist/esm/models/DeployApp200Response.d.ts +1 -1
- package/dist/esm/models/DeployApp200Response.js +1 -1
- package/dist/esm/models/DeployApp207Response.d.ts +1 -1
- package/dist/esm/models/DeployApp207Response.js +1 -1
- package/dist/esm/models/DeployApp400Response.d.ts +1 -1
- package/dist/esm/models/DeployApp400Response.js +1 -1
- package/dist/esm/models/DeployAppRequest.d.ts +1 -1
- package/dist/esm/models/DeployAppRequest.js +1 -1
- package/dist/esm/models/DownloadAssetRequest.d.ts +1 -1
- package/dist/esm/models/DownloadAssetRequest.js +1 -1
- package/dist/esm/models/DownloadAssetResponse.d.ts +1 -1
- package/dist/esm/models/DownloadAssetResponse.js +1 -1
- package/dist/esm/models/DownloadCollectionResponse.d.ts +1 -1
- package/dist/esm/models/DownloadCollectionResponse.js +1 -1
- package/dist/esm/models/ErrorResponse.d.ts +1 -1
- package/dist/esm/models/ErrorResponse.js +1 -1
- package/dist/esm/models/ErrorWithMessageResponse.d.ts +1 -1
- package/dist/esm/models/ErrorWithMessageResponse.js +1 -1
- package/dist/esm/models/FieldAggregation.d.ts +1 -1
- package/dist/esm/models/FieldAggregation.js +1 -1
- package/dist/esm/models/FieldAggregationBucketsInner.d.ts +1 -1
- package/dist/esm/models/FieldAggregationBucketsInner.js +1 -1
- package/dist/esm/models/FontDefinition.d.ts +1 -1
- package/dist/esm/models/FontDefinition.js +1 -1
- package/dist/esm/models/FontLookupResponse.d.ts +1 -1
- package/dist/esm/models/FontLookupResponse.js +1 -1
- package/dist/esm/models/FontLookupResponseFontsInner.d.ts +1 -1
- package/dist/esm/models/FontLookupResponseFontsInner.js +1 -1
- package/dist/esm/models/FontProvisioningResponse.d.ts +1 -1
- package/dist/esm/models/FontProvisioningResponse.js +1 -1
- package/dist/esm/models/ForbiddenResponse.d.ts +1 -1
- package/dist/esm/models/ForbiddenResponse.js +1 -1
- package/dist/esm/models/GetAssetsLastDeliveryRequest.d.ts +32 -0
- package/dist/esm/models/GetAssetsLastDeliveryRequest.js +43 -0
- package/dist/esm/models/GoogleFontListingResponse.d.ts +1 -1
- package/dist/esm/models/GoogleFontListingResponse.js +1 -1
- package/dist/esm/models/LastDeliveryResponse.d.ts +33 -0
- package/dist/esm/models/LastDeliveryResponse.js +42 -0
- package/dist/esm/models/ListAssetsByFolderResponse.d.ts +1 -1
- package/dist/esm/models/ListAssetsByFolderResponse.js +1 -1
- package/dist/esm/models/ListAssetsByFolderResponseMeta.d.ts +1 -1
- package/dist/esm/models/ListAssetsByFolderResponseMeta.js +1 -1
- package/dist/esm/models/ListBackreferencesResponse.d.ts +1 -1
- package/dist/esm/models/ListBackreferencesResponse.js +1 -1
- package/dist/esm/models/ListBackreferencesResponseBackrefsInner.d.ts +1 -1
- package/dist/esm/models/ListBackreferencesResponseBackrefsInner.js +1 -1
- package/dist/esm/models/ListCollectionsResponse.d.ts +1 -1
- package/dist/esm/models/ListCollectionsResponse.js +1 -1
- package/dist/esm/models/ListContextualMetadataFieldsResponse.d.ts +1 -1
- package/dist/esm/models/ListContextualMetadataFieldsResponse.js +1 -1
- package/dist/esm/models/ListCustomersResponse.d.ts +1 -1
- package/dist/esm/models/ListCustomersResponse.js +1 -1
- package/dist/esm/models/ListMetadataFieldsResponse.d.ts +1 -1
- package/dist/esm/models/ListMetadataFieldsResponse.js +1 -1
- package/dist/esm/models/ListPortalsResponse.d.ts +41 -0
- package/dist/esm/models/ListPortalsResponse.js +44 -0
- package/dist/esm/models/ListPublicLinksResponse.d.ts +33 -0
- package/dist/esm/models/ListPublicLinksResponse.js +42 -0
- package/dist/esm/models/ListSavedSearchesResponse.d.ts +33 -0
- package/dist/esm/models/ListSavedSearchesResponse.js +42 -0
- package/dist/esm/models/ListSubfoldersResponse.d.ts +1 -1
- package/dist/esm/models/ListSubfoldersResponse.js +1 -1
- package/dist/esm/models/ListSubfoldersResponseFoldersInner.d.ts +1 -1
- package/dist/esm/models/ListSubfoldersResponseFoldersInner.js +1 -1
- package/dist/esm/models/ListTransformationsResponse.d.ts +1 -1
- package/dist/esm/models/ListTransformationsResponse.js +1 -1
- package/dist/esm/models/ListUsersResponse.d.ts +45 -0
- package/dist/esm/models/ListUsersResponse.js +46 -0
- package/dist/esm/models/LocationSegment.d.ts +1 -1
- package/dist/esm/models/LocationSegment.js +1 -1
- package/dist/esm/models/LookupFontRequest.d.ts +1 -1
- package/dist/esm/models/LookupFontRequest.js +1 -1
- package/dist/esm/models/LookupFontRequestFontsInner.d.ts +1 -1
- package/dist/esm/models/LookupFontRequestFontsInner.js +1 -1
- package/dist/esm/models/NamespaceTokenCreateErrorResponse.d.ts +1 -1
- package/dist/esm/models/NamespaceTokenCreateErrorResponse.js +1 -1
- package/dist/esm/models/NamespaceTokenCreateResponse.d.ts +1 -1
- package/dist/esm/models/NamespaceTokenCreateResponse.js +1 -1
- package/dist/esm/models/Portal.d.ts +122 -0
- package/dist/esm/models/Portal.js +71 -0
- package/dist/esm/models/PrepareUploadRequest.d.ts +1 -1
- package/dist/esm/models/PrepareUploadRequest.js +1 -1
- package/dist/esm/models/PrepareUploadRequestUploadParams.d.ts +1 -1
- package/dist/esm/models/PrepareUploadRequestUploadParams.js +1 -1
- package/dist/esm/models/PrepareUploadResponse.d.ts +1 -1
- package/dist/esm/models/PrepareUploadResponse.js +1 -1
- package/dist/esm/models/ProvisionFontRequest.d.ts +1 -1
- package/dist/esm/models/ProvisionFontRequest.js +1 -1
- package/dist/esm/models/PublicLink.d.ts +68 -0
- package/dist/esm/models/PublicLink.js +53 -0
- package/dist/esm/models/PublicLinkResponse.d.ts +33 -0
- package/dist/esm/models/PublicLinkResponse.js +42 -0
- package/dist/esm/models/RefreshTokenErrorResponse.d.ts +1 -1
- package/dist/esm/models/RefreshTokenErrorResponse.js +1 -1
- package/dist/esm/models/RefreshTokenResponse.d.ts +1 -1
- package/dist/esm/models/RefreshTokenResponse.js +1 -1
- package/dist/esm/models/RelatedAsset.d.ts +62 -0
- package/dist/esm/models/RelatedAsset.js +61 -0
- package/dist/esm/models/RelatedAssetsResponse.d.ts +33 -0
- package/dist/esm/models/RelatedAssetsResponse.js +44 -0
- package/dist/esm/models/RemoveCollectionAssetsRequest.d.ts +1 -1
- package/dist/esm/models/RemoveCollectionAssetsRequest.js +1 -1
- package/dist/esm/models/RemoveCollectionAssetsResponse.d.ts +1 -1
- package/dist/esm/models/RemoveCollectionAssetsResponse.js +1 -1
- package/dist/esm/models/RemovePortalCollectionsRequest.d.ts +32 -0
- package/dist/esm/models/RemovePortalCollectionsRequest.js +43 -0
- package/dist/esm/models/ResourceActor.d.ts +1 -1
- package/dist/esm/models/ResourceActor.js +1 -1
- package/dist/esm/models/SavedSearch.d.ts +89 -0
- package/dist/esm/models/SavedSearch.js +60 -0
- package/dist/esm/models/SavedSearchPermission.d.ts +38 -0
- package/dist/esm/models/SavedSearchPermission.js +43 -0
- package/dist/esm/models/SearchAsset.d.ts +1 -1
- package/dist/esm/models/SearchAsset.js +1 -1
- package/dist/esm/models/SearchCollectionsRequest.d.ts +1 -1
- package/dist/esm/models/SearchCollectionsRequest.js +1 -1
- package/dist/esm/models/SearchCollectionsResponse.d.ts +1 -1
- package/dist/esm/models/SearchCollectionsResponse.js +1 -1
- package/dist/esm/models/SetAppStorageValueRequest.d.ts +1 -1
- package/dist/esm/models/SetAppStorageValueRequest.js +1 -1
- package/dist/esm/models/SignAndUploadRequest.d.ts +1 -1
- package/dist/esm/models/SignAndUploadRequest.js +1 -1
- package/dist/esm/models/SignAndUploadRequest1.d.ts +1 -1
- package/dist/esm/models/SignAndUploadRequest1.js +1 -1
- package/dist/esm/models/SignAndUploadResponse.d.ts +1 -1
- package/dist/esm/models/SignAndUploadResponse.js +1 -1
- package/dist/esm/models/StructuredMetadataField.d.ts +1 -1
- package/dist/esm/models/StructuredMetadataField.js +1 -1
- package/dist/esm/models/TemplateResourceTuple.d.ts +1 -1
- package/dist/esm/models/TemplateResourceTuple.js +1 -1
- package/dist/esm/models/TemplateSearchResponse.d.ts +1 -1
- package/dist/esm/models/TemplateSearchResponse.js +1 -1
- package/dist/esm/models/ThumbnailsTokenResponse.d.ts +1 -1
- package/dist/esm/models/ThumbnailsTokenResponse.js +1 -1
- package/dist/esm/models/TrackAnalyticsEventRequest.d.ts +1 -1
- package/dist/esm/models/TrackAnalyticsEventRequest.js +1 -1
- package/dist/esm/models/Transformation.d.ts +1 -1
- package/dist/esm/models/Transformation.js +1 -1
- package/dist/esm/models/UpdateAppRequest.d.ts +1 -1
- package/dist/esm/models/UpdateAppRequest.js +1 -1
- package/dist/esm/models/UpdateAssetBackreferencesRequest.d.ts +1 -1
- package/dist/esm/models/UpdateAssetBackreferencesRequest.js +1 -1
- package/dist/esm/models/UpdateAssetMetadataRequest.d.ts +1 -1
- package/dist/esm/models/UpdateAssetMetadataRequest.js +1 -1
- package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.d.ts +1 -1
- package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.js +1 -1
- package/dist/esm/models/UpdateAssetMetadataResponse.d.ts +1 -1
- package/dist/esm/models/UpdateAssetMetadataResponse.js +1 -1
- package/dist/esm/models/UpdateAssetTagsRequest.d.ts +1 -1
- package/dist/esm/models/UpdateAssetTagsRequest.js +1 -1
- package/dist/esm/models/UpdateAssetTagsResponse.d.ts +1 -1
- package/dist/esm/models/UpdateAssetTagsResponse.js +1 -1
- package/dist/esm/models/UpdateBackreferencesResponse.d.ts +1 -1
- package/dist/esm/models/UpdateBackreferencesResponse.js +1 -1
- package/dist/esm/models/UpdateCollectionRequest.d.ts +1 -1
- package/dist/esm/models/UpdateCollectionRequest.js +1 -1
- package/dist/esm/models/UpdateCollectionResponse.d.ts +1 -1
- package/dist/esm/models/UpdateCollectionResponse.js +1 -1
- package/dist/esm/models/UpdatePortalRequest.d.ts +80 -0
- package/dist/esm/models/UpdatePortalRequest.js +57 -0
- package/dist/esm/models/UpdatePublicLinkRequest.d.ts +50 -0
- package/dist/esm/models/UpdatePublicLinkRequest.js +47 -0
- package/dist/esm/models/UpdateSavedSearchResponse.d.ts +32 -0
- package/dist/esm/models/UpdateSavedSearchResponse.js +41 -0
- package/dist/esm/models/UploadAssetRequest.d.ts +1 -1
- package/dist/esm/models/UploadAssetRequest.js +1 -1
- package/dist/esm/models/UploadAssetRequest1.d.ts +1 -1
- package/dist/esm/models/UploadAssetRequest1.js +1 -1
- package/dist/esm/models/UploadAssetResponse.d.ts +1 -1
- package/dist/esm/models/UploadAssetResponse.js +1 -1
- package/dist/esm/models/User.d.ts +86 -0
- package/dist/esm/models/User.js +59 -0
- package/dist/esm/models/ValidateTokenResponse.d.ts +1 -1
- package/dist/esm/models/ValidateTokenResponse.js +1 -1
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/AddCollectionAssetsRequest.d.ts +1 -1
- package/dist/models/AddCollectionAssetsRequest.js +1 -1
- package/dist/models/AddCollectionAssetsResponse.d.ts +1 -1
- package/dist/models/AddCollectionAssetsResponse.js +1 -1
- package/dist/models/AddPortalCollectionsRequest.d.ts +32 -0
- package/dist/models/AddPortalCollectionsRequest.js +50 -0
- package/dist/models/AiVisionGeneralResponse.d.ts +1 -1
- package/dist/models/AiVisionGeneralResponse.js +1 -1
- package/dist/models/AnalyticsResponse.d.ts +1 -1
- package/dist/models/AnalyticsResponse.js +1 -1
- package/dist/models/AnalyzeAiVisionGeneralRequest.d.ts +1 -1
- package/dist/models/AnalyzeAiVisionGeneralRequest.js +1 -1
- package/dist/models/AnalyzeAiVisionGeneralRequestSource.d.ts +1 -1
- package/dist/models/AnalyzeAiVisionGeneralRequestSource.js +1 -1
- package/dist/models/AppStorageErrorResponse.d.ts +1 -1
- package/dist/models/AppStorageErrorResponse.js +1 -1
- package/dist/models/AppStorageGetResponse.d.ts +1 -1
- package/dist/models/AppStorageGetResponse.js +1 -1
- package/dist/models/AppStorageSetErrorResponse.d.ts +1 -1
- package/dist/models/AppStorageSetErrorResponse.js +1 -1
- package/dist/models/AppStorageSetResponse.d.ts +1 -1
- package/dist/models/AppStorageSetResponse.js +1 -1
- package/dist/models/Asset.d.ts +1 -1
- package/dist/models/Asset.js +1 -1
- package/dist/models/AssetHistoryResponse.d.ts +1 -1
- package/dist/models/AssetHistoryResponse.js +1 -1
- package/dist/models/AssetHistoryResponseAssetHistoryInner.d.ts +1 -1
- package/dist/models/AssetHistoryResponseAssetHistoryInner.js +1 -1
- package/dist/models/AssetLastDelivery.d.ts +38 -0
- package/dist/models/AssetLastDelivery.js +50 -0
- package/dist/models/AssetSearchResponse.d.ts +1 -1
- package/dist/models/AssetSearchResponse.js +1 -1
- package/dist/models/AuthCredentialsResponse.d.ts +1 -1
- package/dist/models/AuthCredentialsResponse.js +1 -1
- package/dist/models/AuthCustomer.d.ts +1 -1
- package/dist/models/AuthCustomer.js +1 -1
- package/dist/models/AuthUser.d.ts +1 -1
- package/dist/models/AuthUser.js +1 -1
- package/dist/models/AutocompleteAsset.d.ts +1 -1
- package/dist/models/AutocompleteAsset.js +1 -1
- package/dist/models/AutocompleteAssetCustomer.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomer.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomer.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomer.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfig.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfig.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerLimits.d.ts +1 -1
- package/dist/models/AutocompleteAssetCustomerCustomerLimits.js +1 -1
- package/dist/models/AutocompleteAssetFullProps.d.ts +1 -1
- package/dist/models/AutocompleteAssetFullProps.js +1 -1
- package/dist/models/AutocompleteAssetFullPropsCreatedBy.d.ts +1 -1
- package/dist/models/AutocompleteAssetFullPropsCreatedBy.js +1 -1
- package/dist/models/AutocompleteFolder.d.ts +1 -1
- package/dist/models/AutocompleteFolder.js +1 -1
- package/dist/models/AutocompleteResponse.d.ts +1 -1
- package/dist/models/AutocompleteResponse.js +1 -1
- package/dist/models/BackreferenceHistoryEntry.d.ts +1 -1
- package/dist/models/BackreferenceHistoryEntry.js +1 -1
- package/dist/models/BackreferenceResult.d.ts +1 -1
- package/dist/models/BackreferenceResult.js +1 -1
- package/dist/models/BackreferenceResultBackref.d.ts +1 -1
- package/dist/models/BackreferenceResultBackref.js +1 -1
- package/dist/models/CldtTemplate.d.ts +1 -1
- package/dist/models/CldtTemplate.js +1 -1
- package/dist/models/CldtTemplateCanvas.d.ts +1 -1
- package/dist/models/CldtTemplateCanvas.js +1 -1
- package/dist/models/CldtTemplateProvenance.d.ts +1 -1
- package/dist/models/CldtTemplateProvenance.js +1 -1
- package/dist/models/CldtTemplateVariable.d.ts +1 -1
- package/dist/models/CldtTemplateVariable.js +1 -1
- package/dist/models/Collection.d.ts +1 -1
- package/dist/models/Collection.js +1 -1
- package/dist/models/CollectionPermissions.d.ts +1 -1
- package/dist/models/CollectionPermissions.js +1 -1
- package/dist/models/ContextualMetadataField.d.ts +1 -1
- package/dist/models/ContextualMetadataField.js +1 -1
- package/dist/models/CreateAssetMetadataFieldRequest.d.ts +1 -1
- package/dist/models/CreateAssetMetadataFieldRequest.js +1 -1
- package/dist/models/CreateCollectionRequest.d.ts +1 -1
- package/dist/models/CreateCollectionRequest.js +1 -1
- package/dist/models/CreateCollectionResponse.d.ts +1 -1
- package/dist/models/CreateCollectionResponse.js +1 -1
- package/dist/models/CreateFolderRequest.d.ts +1 -1
- package/dist/models/CreateFolderRequest.js +1 -1
- package/dist/models/CreateFolderResponse.d.ts +1 -1
- package/dist/models/CreateFolderResponse.js +1 -1
- package/dist/models/CreateFolderResponseFolder.d.ts +1 -1
- package/dist/models/CreateFolderResponseFolder.js +1 -1
- package/dist/models/CreateFolderResponseFolderViewableParentsInner.d.ts +1 -1
- package/dist/models/CreateFolderResponseFolderViewableParentsInner.js +1 -1
- package/dist/models/CreateMetadataFieldResponse.d.ts +1 -1
- package/dist/models/CreateMetadataFieldResponse.js +1 -1
- package/dist/models/CreateNamespaceTokenRequest.d.ts +1 -1
- package/dist/models/CreateNamespaceTokenRequest.js +1 -1
- package/dist/models/CreatePortalRequest.d.ts +74 -0
- package/dist/models/CreatePortalRequest.js +62 -0
- package/dist/models/CreatePublicLinkRequest.d.ts +44 -0
- package/dist/models/CreatePublicLinkRequest.js +52 -0
- package/dist/models/CreateSavedSearchRequest.d.ts +68 -0
- package/dist/models/CreateSavedSearchRequest.js +66 -0
- package/dist/models/CreateSavedSearchRequestSharedWithInner.d.ts +38 -0
- package/dist/models/CreateSavedSearchRequestSharedWithInner.js +50 -0
- package/dist/models/Customer.d.ts +1 -1
- package/dist/models/Customer.js +1 -1
- package/dist/models/CustomerListMeta.d.ts +1 -1
- package/dist/models/CustomerListMeta.js +1 -1
- package/dist/models/CustomerUploadLimits.d.ts +1 -1
- package/dist/models/CustomerUploadLimits.js +1 -1
- package/dist/models/DamAppErrorResponse.d.ts +1 -1
- package/dist/models/DamAppErrorResponse.js +1 -1
- package/dist/models/DamAppResponse.d.ts +1 -1
- package/dist/models/DamAppResponse.js +1 -1
- package/dist/models/DamAppResponseAppMessageParamsValue.d.ts +1 -1
- package/dist/models/DamAppResponseAppMessageParamsValue.js +1 -1
- package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +1 -1
- package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.js +1 -1
- package/dist/models/DamAppResponseAssetAmountLimit.d.ts +1 -1
- package/dist/models/DamAppResponseAssetAmountLimit.js +1 -1
- package/dist/models/DamAppUserSnapshot.d.ts +1 -1
- package/dist/models/DamAppUserSnapshot.js +1 -1
- package/dist/models/DashboardDataResponse.d.ts +42 -0
- package/dist/models/DashboardDataResponse.js +50 -0
- package/dist/models/DeleteFolderResponse.d.ts +1 -1
- package/dist/models/DeleteFolderResponse.js +1 -1
- package/dist/models/DeployApp200Response.d.ts +1 -1
- package/dist/models/DeployApp200Response.js +1 -1
- package/dist/models/DeployApp207Response.d.ts +1 -1
- package/dist/models/DeployApp207Response.js +1 -1
- package/dist/models/DeployApp400Response.d.ts +1 -1
- package/dist/models/DeployApp400Response.js +1 -1
- package/dist/models/DeployAppRequest.d.ts +1 -1
- package/dist/models/DeployAppRequest.js +1 -1
- package/dist/models/DownloadAssetRequest.d.ts +1 -1
- package/dist/models/DownloadAssetRequest.js +1 -1
- package/dist/models/DownloadAssetResponse.d.ts +1 -1
- package/dist/models/DownloadAssetResponse.js +1 -1
- package/dist/models/DownloadCollectionResponse.d.ts +1 -1
- package/dist/models/DownloadCollectionResponse.js +1 -1
- package/dist/models/ErrorResponse.d.ts +1 -1
- package/dist/models/ErrorResponse.js +1 -1
- package/dist/models/ErrorWithMessageResponse.d.ts +1 -1
- package/dist/models/ErrorWithMessageResponse.js +1 -1
- package/dist/models/FieldAggregation.d.ts +1 -1
- package/dist/models/FieldAggregation.js +1 -1
- package/dist/models/FieldAggregationBucketsInner.d.ts +1 -1
- package/dist/models/FieldAggregationBucketsInner.js +1 -1
- package/dist/models/FontDefinition.d.ts +1 -1
- package/dist/models/FontDefinition.js +1 -1
- package/dist/models/FontLookupResponse.d.ts +1 -1
- package/dist/models/FontLookupResponse.js +1 -1
- package/dist/models/FontLookupResponseFontsInner.d.ts +1 -1
- package/dist/models/FontLookupResponseFontsInner.js +1 -1
- package/dist/models/FontProvisioningResponse.d.ts +1 -1
- package/dist/models/FontProvisioningResponse.js +1 -1
- package/dist/models/ForbiddenResponse.d.ts +1 -1
- package/dist/models/ForbiddenResponse.js +1 -1
- package/dist/models/GetAssetsLastDeliveryRequest.d.ts +32 -0
- package/dist/models/GetAssetsLastDeliveryRequest.js +50 -0
- package/dist/models/GoogleFontListingResponse.d.ts +1 -1
- package/dist/models/GoogleFontListingResponse.js +1 -1
- package/dist/models/LastDeliveryResponse.d.ts +33 -0
- package/dist/models/LastDeliveryResponse.js +49 -0
- package/dist/models/ListAssetsByFolderResponse.d.ts +1 -1
- package/dist/models/ListAssetsByFolderResponse.js +1 -1
- package/dist/models/ListAssetsByFolderResponseMeta.d.ts +1 -1
- package/dist/models/ListAssetsByFolderResponseMeta.js +1 -1
- package/dist/models/ListBackreferencesResponse.d.ts +1 -1
- package/dist/models/ListBackreferencesResponse.js +1 -1
- package/dist/models/ListBackreferencesResponseBackrefsInner.d.ts +1 -1
- package/dist/models/ListBackreferencesResponseBackrefsInner.js +1 -1
- package/dist/models/ListCollectionsResponse.d.ts +1 -1
- package/dist/models/ListCollectionsResponse.js +1 -1
- package/dist/models/ListContextualMetadataFieldsResponse.d.ts +1 -1
- package/dist/models/ListContextualMetadataFieldsResponse.js +1 -1
- package/dist/models/ListCustomersResponse.d.ts +1 -1
- package/dist/models/ListCustomersResponse.js +1 -1
- package/dist/models/ListMetadataFieldsResponse.d.ts +1 -1
- package/dist/models/ListMetadataFieldsResponse.js +1 -1
- package/dist/models/ListPortalsResponse.d.ts +41 -0
- package/dist/models/ListPortalsResponse.js +51 -0
- package/dist/models/ListPublicLinksResponse.d.ts +33 -0
- package/dist/models/ListPublicLinksResponse.js +49 -0
- package/dist/models/ListSavedSearchesResponse.d.ts +33 -0
- package/dist/models/ListSavedSearchesResponse.js +49 -0
- package/dist/models/ListSubfoldersResponse.d.ts +1 -1
- package/dist/models/ListSubfoldersResponse.js +1 -1
- package/dist/models/ListSubfoldersResponseFoldersInner.d.ts +1 -1
- package/dist/models/ListSubfoldersResponseFoldersInner.js +1 -1
- package/dist/models/ListTransformationsResponse.d.ts +1 -1
- package/dist/models/ListTransformationsResponse.js +1 -1
- package/dist/models/ListUsersResponse.d.ts +45 -0
- package/dist/models/ListUsersResponse.js +53 -0
- package/dist/models/LocationSegment.d.ts +1 -1
- package/dist/models/LocationSegment.js +1 -1
- package/dist/models/LookupFontRequest.d.ts +1 -1
- package/dist/models/LookupFontRequest.js +1 -1
- package/dist/models/LookupFontRequestFontsInner.d.ts +1 -1
- package/dist/models/LookupFontRequestFontsInner.js +1 -1
- package/dist/models/NamespaceTokenCreateErrorResponse.d.ts +1 -1
- package/dist/models/NamespaceTokenCreateErrorResponse.js +1 -1
- package/dist/models/NamespaceTokenCreateResponse.d.ts +1 -1
- package/dist/models/NamespaceTokenCreateResponse.js +1 -1
- package/dist/models/Portal.d.ts +122 -0
- package/dist/models/Portal.js +78 -0
- package/dist/models/PrepareUploadRequest.d.ts +1 -1
- package/dist/models/PrepareUploadRequest.js +1 -1
- package/dist/models/PrepareUploadRequestUploadParams.d.ts +1 -1
- package/dist/models/PrepareUploadRequestUploadParams.js +1 -1
- package/dist/models/PrepareUploadResponse.d.ts +1 -1
- package/dist/models/PrepareUploadResponse.js +1 -1
- package/dist/models/ProvisionFontRequest.d.ts +1 -1
- package/dist/models/ProvisionFontRequest.js +1 -1
- package/dist/models/PublicLink.d.ts +68 -0
- package/dist/models/PublicLink.js +60 -0
- package/dist/models/PublicLinkResponse.d.ts +33 -0
- package/dist/models/PublicLinkResponse.js +49 -0
- package/dist/models/RefreshTokenErrorResponse.d.ts +1 -1
- package/dist/models/RefreshTokenErrorResponse.js +1 -1
- package/dist/models/RefreshTokenResponse.d.ts +1 -1
- package/dist/models/RefreshTokenResponse.js +1 -1
- package/dist/models/RelatedAsset.d.ts +62 -0
- package/dist/models/RelatedAsset.js +68 -0
- package/dist/models/RelatedAssetsResponse.d.ts +33 -0
- package/dist/models/RelatedAssetsResponse.js +51 -0
- package/dist/models/RemoveCollectionAssetsRequest.d.ts +1 -1
- package/dist/models/RemoveCollectionAssetsRequest.js +1 -1
- package/dist/models/RemoveCollectionAssetsResponse.d.ts +1 -1
- package/dist/models/RemoveCollectionAssetsResponse.js +1 -1
- package/dist/models/RemovePortalCollectionsRequest.d.ts +32 -0
- package/dist/models/RemovePortalCollectionsRequest.js +50 -0
- package/dist/models/ResourceActor.d.ts +1 -1
- package/dist/models/ResourceActor.js +1 -1
- package/dist/models/SavedSearch.d.ts +89 -0
- package/dist/models/SavedSearch.js +67 -0
- package/dist/models/SavedSearchPermission.d.ts +38 -0
- package/dist/models/SavedSearchPermission.js +50 -0
- package/dist/models/SearchAsset.d.ts +1 -1
- package/dist/models/SearchAsset.js +1 -1
- package/dist/models/SearchCollectionsRequest.d.ts +1 -1
- package/dist/models/SearchCollectionsRequest.js +1 -1
- package/dist/models/SearchCollectionsResponse.d.ts +1 -1
- package/dist/models/SearchCollectionsResponse.js +1 -1
- package/dist/models/SetAppStorageValueRequest.d.ts +1 -1
- package/dist/models/SetAppStorageValueRequest.js +1 -1
- package/dist/models/SignAndUploadRequest.d.ts +1 -1
- package/dist/models/SignAndUploadRequest.js +1 -1
- package/dist/models/SignAndUploadRequest1.d.ts +1 -1
- package/dist/models/SignAndUploadRequest1.js +1 -1
- package/dist/models/SignAndUploadResponse.d.ts +1 -1
- package/dist/models/SignAndUploadResponse.js +1 -1
- package/dist/models/StructuredMetadataField.d.ts +1 -1
- package/dist/models/StructuredMetadataField.js +1 -1
- package/dist/models/TemplateResourceTuple.d.ts +1 -1
- package/dist/models/TemplateResourceTuple.js +1 -1
- package/dist/models/TemplateSearchResponse.d.ts +1 -1
- package/dist/models/TemplateSearchResponse.js +1 -1
- package/dist/models/ThumbnailsTokenResponse.d.ts +1 -1
- package/dist/models/ThumbnailsTokenResponse.js +1 -1
- package/dist/models/TrackAnalyticsEventRequest.d.ts +1 -1
- package/dist/models/TrackAnalyticsEventRequest.js +1 -1
- package/dist/models/Transformation.d.ts +1 -1
- package/dist/models/Transformation.js +1 -1
- package/dist/models/UpdateAppRequest.d.ts +1 -1
- package/dist/models/UpdateAppRequest.js +1 -1
- package/dist/models/UpdateAssetBackreferencesRequest.d.ts +1 -1
- package/dist/models/UpdateAssetBackreferencesRequest.js +1 -1
- package/dist/models/UpdateAssetMetadataRequest.d.ts +1 -1
- package/dist/models/UpdateAssetMetadataRequest.js +1 -1
- package/dist/models/UpdateAssetMetadataRequestMetadataValue.d.ts +1 -1
- package/dist/models/UpdateAssetMetadataRequestMetadataValue.js +1 -1
- package/dist/models/UpdateAssetMetadataResponse.d.ts +1 -1
- package/dist/models/UpdateAssetMetadataResponse.js +1 -1
- package/dist/models/UpdateAssetTagsRequest.d.ts +1 -1
- package/dist/models/UpdateAssetTagsRequest.js +1 -1
- package/dist/models/UpdateAssetTagsResponse.d.ts +1 -1
- package/dist/models/UpdateAssetTagsResponse.js +1 -1
- package/dist/models/UpdateBackreferencesResponse.d.ts +1 -1
- package/dist/models/UpdateBackreferencesResponse.js +1 -1
- package/dist/models/UpdateCollectionRequest.d.ts +1 -1
- package/dist/models/UpdateCollectionRequest.js +1 -1
- package/dist/models/UpdateCollectionResponse.d.ts +1 -1
- package/dist/models/UpdateCollectionResponse.js +1 -1
- package/dist/models/UpdatePortalRequest.d.ts +80 -0
- package/dist/models/UpdatePortalRequest.js +64 -0
- package/dist/models/UpdatePublicLinkRequest.d.ts +50 -0
- package/dist/models/UpdatePublicLinkRequest.js +54 -0
- package/dist/models/UpdateSavedSearchResponse.d.ts +32 -0
- package/dist/models/UpdateSavedSearchResponse.js +48 -0
- package/dist/models/UploadAssetRequest.d.ts +1 -1
- package/dist/models/UploadAssetRequest.js +1 -1
- package/dist/models/UploadAssetRequest1.d.ts +1 -1
- package/dist/models/UploadAssetRequest1.js +1 -1
- package/dist/models/UploadAssetResponse.d.ts +1 -1
- package/dist/models/UploadAssetResponse.js +1 -1
- package/dist/models/User.d.ts +86 -0
- package/dist/models/User.js +66 -0
- package/dist/models/ValidateTokenResponse.d.ts +1 -1
- package/dist/models/ValidateTokenResponse.js +1 -1
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/AddPortalCollectionsRequest.md +34 -0
- package/docs/AssetLastDelivery.md +36 -0
- package/docs/AssetManagementApi.md +1690 -351
- package/docs/CreatePortalRequest.md +48 -0
- package/docs/CreatePublicLinkRequest.md +38 -0
- package/docs/CreateSavedSearchRequest.md +42 -0
- package/docs/CreateSavedSearchRequestSharedWithInner.md +36 -0
- package/docs/DashboardDataResponse.md +36 -0
- package/docs/GetAssetsLastDeliveryRequest.md +34 -0
- package/docs/LastDeliveryResponse.md +34 -0
- package/docs/ListPortalsResponse.md +36 -0
- package/docs/ListPublicLinksResponse.md +34 -0
- package/docs/ListSavedSearchesResponse.md +34 -0
- package/docs/ListUsersResponse.md +38 -0
- package/docs/PlatformApi.md +173 -0
- package/docs/Portal.md +64 -0
- package/docs/PublicLink.md +46 -0
- package/docs/PublicLinkResponse.md +34 -0
- package/docs/RelatedAsset.md +44 -0
- package/docs/RelatedAssetsResponse.md +34 -0
- package/docs/RemovePortalCollectionsRequest.md +34 -0
- package/docs/SavedSearch.md +52 -0
- package/docs/SavedSearchPermission.md +36 -0
- package/docs/UpdatePortalRequest.md +50 -0
- package/docs/UpdatePublicLinkRequest.md +40 -0
- package/docs/UpdateSavedSearchResponse.md +34 -0
- package/docs/User.md +52 -0
- package/package.json +1 -1
- package/src/apis/AssetManagementApi.ts +1173 -138
- package/src/apis/ConsoleApi.ts +1 -1
- package/src/apis/MediaApi.ts +1 -1
- package/src/apis/PlatformApi.ts +153 -1
- package/src/apis/UploadApi.ts +1 -1
- package/src/apis/UtilsApi.ts +1 -1
- package/src/models/AddCollectionAssetsRequest.ts +1 -1
- package/src/models/AddCollectionAssetsResponse.ts +1 -1
- package/src/models/AddPortalCollectionsRequest.ts +66 -0
- package/src/models/AiVisionGeneralResponse.ts +1 -1
- package/src/models/AnalyticsResponse.ts +1 -1
- package/src/models/AnalyzeAiVisionGeneralRequest.ts +1 -1
- package/src/models/AnalyzeAiVisionGeneralRequestSource.ts +1 -1
- package/src/models/AppStorageErrorResponse.ts +1 -1
- package/src/models/AppStorageGetResponse.ts +1 -1
- package/src/models/AppStorageSetErrorResponse.ts +1 -1
- package/src/models/AppStorageSetResponse.ts +1 -1
- package/src/models/Asset.ts +1 -1
- package/src/models/AssetHistoryResponse.ts +1 -1
- package/src/models/AssetHistoryResponseAssetHistoryInner.ts +1 -1
- package/src/models/AssetLastDelivery.ts +73 -0
- package/src/models/AssetSearchResponse.ts +1 -1
- package/src/models/AuthCredentialsResponse.ts +1 -1
- package/src/models/AuthCustomer.ts +1 -1
- package/src/models/AuthUser.ts +1 -1
- package/src/models/AutocompleteAsset.ts +1 -1
- package/src/models/AutocompleteAssetCustomer.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomer.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomerConfig.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.ts +1 -1
- package/src/models/AutocompleteAssetCustomerCustomerLimits.ts +1 -1
- package/src/models/AutocompleteAssetFullProps.ts +1 -1
- package/src/models/AutocompleteAssetFullPropsCreatedBy.ts +1 -1
- package/src/models/AutocompleteFolder.ts +1 -1
- package/src/models/AutocompleteResponse.ts +1 -1
- package/src/models/BackreferenceHistoryEntry.ts +1 -1
- package/src/models/BackreferenceResult.ts +1 -1
- package/src/models/BackreferenceResultBackref.ts +1 -1
- package/src/models/CldtTemplate.ts +1 -1
- package/src/models/CldtTemplateCanvas.ts +1 -1
- package/src/models/CldtTemplateProvenance.ts +1 -1
- package/src/models/CldtTemplateVariable.ts +1 -1
- package/src/models/Collection.ts +1 -1
- package/src/models/CollectionPermissions.ts +1 -1
- package/src/models/ContextualMetadataField.ts +1 -1
- package/src/models/CreateAssetMetadataFieldRequest.ts +1 -1
- package/src/models/CreateCollectionRequest.ts +1 -1
- package/src/models/CreateCollectionResponse.ts +1 -1
- package/src/models/CreateFolderRequest.ts +1 -1
- package/src/models/CreateFolderResponse.ts +1 -1
- package/src/models/CreateFolderResponseFolder.ts +1 -1
- package/src/models/CreateFolderResponseFolderViewableParentsInner.ts +1 -1
- package/src/models/CreateMetadataFieldResponse.ts +1 -1
- package/src/models/CreateNamespaceTokenRequest.ts +1 -1
- package/src/models/CreatePortalRequest.ts +121 -0
- package/src/models/CreatePublicLinkRequest.ts +81 -0
- package/src/models/CreateSavedSearchRequest.ts +117 -0
- package/src/models/CreateSavedSearchRequestSharedWithInner.ts +73 -0
- package/src/models/Customer.ts +1 -1
- package/src/models/CustomerListMeta.ts +1 -1
- package/src/models/CustomerUploadLimits.ts +1 -1
- package/src/models/DamAppErrorResponse.ts +1 -1
- package/src/models/DamAppResponse.ts +1 -1
- package/src/models/DamAppResponseAppMessageParamsValue.ts +1 -1
- package/src/models/DamAppResponseAppMessageParamsValueAnyOf.ts +1 -1
- package/src/models/DamAppResponseAssetAmountLimit.ts +1 -1
- package/src/models/DamAppUserSnapshot.ts +1 -1
- package/src/models/DashboardDataResponse.ts +73 -0
- package/src/models/DeleteFolderResponse.ts +1 -1
- package/src/models/DeployApp200Response.ts +1 -1
- package/src/models/DeployApp207Response.ts +1 -1
- package/src/models/DeployApp400Response.ts +1 -1
- package/src/models/DeployAppRequest.ts +1 -1
- package/src/models/DownloadAssetRequest.ts +1 -1
- package/src/models/DownloadAssetResponse.ts +1 -1
- package/src/models/DownloadCollectionResponse.ts +1 -1
- package/src/models/ErrorResponse.ts +1 -1
- package/src/models/ErrorWithMessageResponse.ts +1 -1
- package/src/models/FieldAggregation.ts +1 -1
- package/src/models/FieldAggregationBucketsInner.ts +1 -1
- package/src/models/FontDefinition.ts +1 -1
- package/src/models/FontLookupResponse.ts +1 -1
- package/src/models/FontLookupResponseFontsInner.ts +1 -1
- package/src/models/FontProvisioningResponse.ts +1 -1
- package/src/models/ForbiddenResponse.ts +1 -1
- package/src/models/GetAssetsLastDeliveryRequest.ts +66 -0
- package/src/models/GoogleFontListingResponse.ts +1 -1
- package/src/models/LastDeliveryResponse.ts +73 -0
- package/src/models/ListAssetsByFolderResponse.ts +1 -1
- package/src/models/ListAssetsByFolderResponseMeta.ts +1 -1
- package/src/models/ListBackreferencesResponse.ts +1 -1
- package/src/models/ListBackreferencesResponseBackrefsInner.ts +1 -1
- package/src/models/ListCollectionsResponse.ts +1 -1
- package/src/models/ListContextualMetadataFieldsResponse.ts +1 -1
- package/src/models/ListCustomersResponse.ts +1 -1
- package/src/models/ListMetadataFieldsResponse.ts +1 -1
- package/src/models/ListPortalsResponse.ts +81 -0
- package/src/models/ListPublicLinksResponse.ts +73 -0
- package/src/models/ListSavedSearchesResponse.ts +73 -0
- package/src/models/ListSubfoldersResponse.ts +1 -1
- package/src/models/ListSubfoldersResponseFoldersInner.ts +1 -1
- package/src/models/ListTransformationsResponse.ts +1 -1
- package/src/models/ListUsersResponse.ts +89 -0
- package/src/models/LocationSegment.ts +1 -1
- package/src/models/LookupFontRequest.ts +1 -1
- package/src/models/LookupFontRequestFontsInner.ts +1 -1
- package/src/models/NamespaceTokenCreateErrorResponse.ts +1 -1
- package/src/models/NamespaceTokenCreateResponse.ts +1 -1
- package/src/models/Portal.ts +185 -0
- package/src/models/PrepareUploadRequest.ts +1 -1
- package/src/models/PrepareUploadRequestUploadParams.ts +1 -1
- package/src/models/PrepareUploadResponse.ts +1 -1
- package/src/models/ProvisionFontRequest.ts +1 -1
- package/src/models/PublicLink.ts +113 -0
- package/src/models/PublicLinkResponse.ts +73 -0
- package/src/models/RefreshTokenErrorResponse.ts +1 -1
- package/src/models/RefreshTokenResponse.ts +1 -1
- package/src/models/RelatedAsset.ts +110 -0
- package/src/models/RelatedAssetsResponse.ts +74 -0
- package/src/models/RemoveCollectionAssetsRequest.ts +1 -1
- package/src/models/RemoveCollectionAssetsResponse.ts +1 -1
- package/src/models/RemovePortalCollectionsRequest.ts +66 -0
- package/src/models/ResourceActor.ts +1 -1
- package/src/models/SavedSearch.ts +145 -0
- package/src/models/SavedSearchPermission.ts +73 -0
- package/src/models/SearchAsset.ts +1 -1
- package/src/models/SearchCollectionsRequest.ts +1 -1
- package/src/models/SearchCollectionsResponse.ts +1 -1
- package/src/models/SetAppStorageValueRequest.ts +1 -1
- package/src/models/SignAndUploadRequest.ts +1 -1
- package/src/models/SignAndUploadRequest1.ts +1 -1
- package/src/models/SignAndUploadResponse.ts +1 -1
- package/src/models/StructuredMetadataField.ts +1 -1
- package/src/models/TemplateResourceTuple.ts +1 -1
- package/src/models/TemplateSearchResponse.ts +1 -1
- package/src/models/ThumbnailsTokenResponse.ts +1 -1
- package/src/models/TrackAnalyticsEventRequest.ts +1 -1
- package/src/models/Transformation.ts +1 -1
- package/src/models/UpdateAppRequest.ts +1 -1
- package/src/models/UpdateAssetBackreferencesRequest.ts +1 -1
- package/src/models/UpdateAssetMetadataRequest.ts +1 -1
- package/src/models/UpdateAssetMetadataRequestMetadataValue.ts +1 -1
- package/src/models/UpdateAssetMetadataResponse.ts +1 -1
- package/src/models/UpdateAssetTagsRequest.ts +1 -1
- package/src/models/UpdateAssetTagsResponse.ts +1 -1
- package/src/models/UpdateBackreferencesResponse.ts +1 -1
- package/src/models/UpdateCollectionRequest.ts +1 -1
- package/src/models/UpdateCollectionResponse.ts +1 -1
- package/src/models/UpdatePortalRequest.ts +129 -0
- package/src/models/UpdatePublicLinkRequest.ts +89 -0
- package/src/models/UpdateSavedSearchResponse.ts +65 -0
- package/src/models/UploadAssetRequest.ts +1 -1
- package/src/models/UploadAssetRequest1.ts +1 -1
- package/src/models/UploadAssetResponse.ts +1 -1
- package/src/models/User.ts +137 -0
- package/src/models/ValidateTokenResponse.ts +1 -1
- package/src/models/index.ts +25 -0
- package/src/runtime.ts +1 -1
|
@@ -5,31 +5,49 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**addCollectionAssets**](AssetManagementApi.md#addcollectionassetsoperation) | **POST** /v2605/asset-management/collections/{collection_id}/assets | Add assets to a collection |
|
|
8
|
+
| [**addPortalCollections**](AssetManagementApi.md#addportalcollectionsoperation) | **PUT** /v2605/asset-management/portals/{id}/collections/add | Add collections to a portal |
|
|
8
9
|
| [**autocompleteAssets**](AssetManagementApi.md#autocompleteassets) | **GET** /v2605/asset-management/assets/autocomplete | Autocomplete across assets, folders, collections, tags, and metadata |
|
|
9
10
|
| [**createAssetMetadataField**](AssetManagementApi.md#createassetmetadatafieldoperation) | **POST** /v2605/asset-management/assets/metadata/fields | Create a structured metadata field definition |
|
|
10
11
|
| [**createCollection**](AssetManagementApi.md#createcollectionoperation) | **POST** /v2605/asset-management/collections | Create a collection |
|
|
11
12
|
| [**createFolder**](AssetManagementApi.md#createfolderoperation) | **POST** /v2605/asset-management/folders | Create a folder |
|
|
13
|
+
| [**createPortal**](AssetManagementApi.md#createportaloperation) | **POST** /v2605/asset-management/portals | Create a portal |
|
|
14
|
+
| [**createPublicLink**](AssetManagementApi.md#createpubliclinkoperation) | **POST** /v2605/asset-management/{subject_type}/{subject_id}/public-links | Create a public link for an entity |
|
|
15
|
+
| [**createSavedSearch**](AssetManagementApi.md#createsavedsearchoperation) | **POST** /v2605/asset-management/saved-searches | Create a saved search |
|
|
12
16
|
| [**deleteFolder**](AssetManagementApi.md#deletefolder) | **DELETE** /v2605/asset-management/folders/{id} | Delete a folder |
|
|
17
|
+
| [**deletePortal**](AssetManagementApi.md#deleteportal) | **DELETE** /v2605/asset-management/portals/{id} | Delete a portal |
|
|
18
|
+
| [**deletePublicLink**](AssetManagementApi.md#deletepubliclink) | **DELETE** /v2605/asset-management/{subject_type}/{subject_id}/public-links/{id} | Revoke a public link |
|
|
19
|
+
| [**deleteSavedSearch**](AssetManagementApi.md#deletesavedsearch) | **DELETE** /v2605/asset-management/saved-searches/{id} | Delete a saved search |
|
|
13
20
|
| [**destroyCollection**](AssetManagementApi.md#destroycollection) | **DELETE** /v2605/asset-management/collections/{collection_id} | Delete a collection |
|
|
14
21
|
| [**downloadAsset**](AssetManagementApi.md#downloadassetoperation) | **POST** /v2605/asset-management/assets/download | Generate a download URL for an asset |
|
|
15
22
|
| [**downloadCollection**](AssetManagementApi.md#downloadcollection) | **POST** /v2605/asset-management/collections/{collection_id}/download | Download a collection as an archive |
|
|
23
|
+
| [**getAssetsLastDelivery**](AssetManagementApi.md#getassetslastdeliveryoperation) | **POST** /v2605/asset-management/assets/last-delivery | Get last delivery dates for assets |
|
|
16
24
|
| [**listAssetBackreferences**](AssetManagementApi.md#listassetbackreferences) | **GET** /v2605/asset-management/backreferences/assets/{assetId} | List backreferences for an asset |
|
|
17
25
|
| [**listAssetContextFields**](AssetManagementApi.md#listassetcontextfields) | **GET** /v2605/asset-management/assets/metadata/context-fields | List contextual metadata fields |
|
|
18
26
|
| [**listAssetHistory**](AssetManagementApi.md#listassethistory) | **GET** /v2605/asset-management/assets/{external_id}/asset-history | List asset audit history |
|
|
19
27
|
| [**listAssetMetadataFields**](AssetManagementApi.md#listassetmetadatafields) | **GET** /v2605/asset-management/assets/metadata/fields | List structured metadata field definitions |
|
|
20
28
|
| [**listAssetsByFolder**](AssetManagementApi.md#listassetsbyfolder) | **GET** /v2605/asset-management/assets/by-folder | List assets in a folder |
|
|
21
29
|
| [**listCollections**](AssetManagementApi.md#listcollections) | **GET** /v2605/asset-management/collections | List collections |
|
|
30
|
+
| [**listPortals**](AssetManagementApi.md#listportals) | **GET** /v2605/asset-management/portals | List portals |
|
|
31
|
+
| [**listPublicLinks**](AssetManagementApi.md#listpubliclinks) | **GET** /v2605/asset-management/{subject_type}/{subject_id}/public-links | List public links of an entity |
|
|
32
|
+
| [**listRelatedAssets**](AssetManagementApi.md#listrelatedassets) | **GET** /v2605/asset-management/assets/related-assets | List related assets for an asset |
|
|
33
|
+
| [**listSavedSearches**](AssetManagementApi.md#listsavedsearches) | **GET** /v2605/asset-management/saved-searches | List saved searches |
|
|
22
34
|
| [**listSubfolders**](AssetManagementApi.md#listsubfolders) | **GET** /v2605/asset-management/folders/subfolders | List child folders |
|
|
23
35
|
| [**listTransformations**](AssetManagementApi.md#listtransformations) | **GET** /v2605/asset-management/transformations | List named transformations |
|
|
24
36
|
| [**removeCollectionAssets**](AssetManagementApi.md#removecollectionassetsoperation) | **DELETE** /v2605/asset-management/collections/{collection_id}/assets | Remove assets from a collection |
|
|
37
|
+
| [**removePortalCollections**](AssetManagementApi.md#removeportalcollectionsoperation) | **PUT** /v2605/asset-management/portals/{id}/collections/remove | Remove collections from a portal |
|
|
25
38
|
| [**searchAssets**](AssetManagementApi.md#searchassets) | **POST** /v2605/asset-management/assets/search | Search assets using Cloudinary expression language |
|
|
26
39
|
| [**searchCollections**](AssetManagementApi.md#searchcollectionsoperation) | **POST** /v2605/asset-management/collections/search | Search collections |
|
|
27
40
|
| [**searchTemplates**](AssetManagementApi.md#searchtemplates) | **GET** /v2605/asset-management/templates | Search creative automation templates |
|
|
28
41
|
| [**showCollection**](AssetManagementApi.md#showcollection) | **GET** /v2605/asset-management/collections/{collection_id} | Get a single collection with its assets |
|
|
42
|
+
| [**showPortal**](AssetManagementApi.md#showportal) | **GET** /v2605/asset-management/portals/{id} | Get a portal |
|
|
43
|
+
| [**showSavedSearch**](AssetManagementApi.md#showsavedsearch) | **GET** /v2605/asset-management/saved-searches/{id} | Get a saved search |
|
|
29
44
|
| [**updateAssetBackreferences**](AssetManagementApi.md#updateassetbackreferencesoperation) | **POST** /v2605/asset-management/backreferences/assets | Create, update, or remove asset backreferences |
|
|
30
45
|
| [**updateAssetMetadata**](AssetManagementApi.md#updateassetmetadataoperation) | **PATCH** /v2605/asset-management/assets/metadata | Update asset contextual and structured metadata |
|
|
31
46
|
| [**updateAssetTags**](AssetManagementApi.md#updateassettagsoperation) | **POST** /v2605/asset-management/assets/{resource_type}/tags | Add or remove a tag on assets |
|
|
32
47
|
| [**updateCollection**](AssetManagementApi.md#updatecollectionoperation) | **PUT** /v2605/asset-management/collections/{collection_id} | Update a collection |
|
|
48
|
+
| [**updatePortal**](AssetManagementApi.md#updateportaloperation) | **PUT** /v2605/asset-management/portals/{id} | Update a portal |
|
|
49
|
+
| [**updatePublicLink**](AssetManagementApi.md#updatepubliclinkoperation) | **PUT** /v2605/asset-management/{subject_type}/{subject_id}/public-links/{id} | Update a public link |
|
|
50
|
+
| [**updateSavedSearch**](AssetManagementApi.md#updatesavedsearch) | **PUT** /v2605/asset-management/saved-searches/{id} | Update a saved search |
|
|
33
51
|
|
|
34
52
|
|
|
35
53
|
|
|
@@ -108,6 +126,81 @@ example().catch(console.error);
|
|
|
108
126
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
109
127
|
|
|
110
128
|
|
|
129
|
+
## addPortalCollections
|
|
130
|
+
|
|
131
|
+
> Portal addPortalCollections(id, addPortalCollectionsRequest)
|
|
132
|
+
|
|
133
|
+
Add collections to a portal
|
|
134
|
+
|
|
135
|
+
Adds one or more collections to an existing portal by their external IDs.
|
|
136
|
+
|
|
137
|
+
### Example
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
import {
|
|
141
|
+
Configuration,
|
|
142
|
+
AssetManagementApi,
|
|
143
|
+
} from '@cloudinary/apps-api';
|
|
144
|
+
import type { AddPortalCollectionsOperationRequest } from '@cloudinary/apps-api';
|
|
145
|
+
|
|
146
|
+
async function example() {
|
|
147
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
148
|
+
const config = new Configuration({
|
|
149
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
150
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
151
|
+
});
|
|
152
|
+
const api = new AssetManagementApi(config);
|
|
153
|
+
|
|
154
|
+
const body = {
|
|
155
|
+
// string | Portal ID
|
|
156
|
+
id: id_example,
|
|
157
|
+
// AddPortalCollectionsRequest (optional)
|
|
158
|
+
addPortalCollectionsRequest: ...,
|
|
159
|
+
} satisfies AddPortalCollectionsOperationRequest;
|
|
160
|
+
|
|
161
|
+
try {
|
|
162
|
+
const data = await api.addPortalCollections(body);
|
|
163
|
+
console.log(data);
|
|
164
|
+
} catch (error) {
|
|
165
|
+
console.error(error);
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
// Run the test
|
|
170
|
+
example().catch(console.error);
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Parameters
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
| Name | Type | Description | Notes |
|
|
177
|
+
|------------- | ------------- | ------------- | -------------|
|
|
178
|
+
| **id** | `string` | Portal ID | [Defaults to `undefined`] |
|
|
179
|
+
| **addPortalCollectionsRequest** | [AddPortalCollectionsRequest](AddPortalCollectionsRequest.md) | | [Optional] |
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
[**Portal**](Portal.md)
|
|
184
|
+
|
|
185
|
+
### Authorization
|
|
186
|
+
|
|
187
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
188
|
+
|
|
189
|
+
### HTTP request headers
|
|
190
|
+
|
|
191
|
+
- **Content-Type**: `application/json`
|
|
192
|
+
- **Accept**: `application/json`
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
### HTTP response details
|
|
196
|
+
| Status code | Description | Response headers |
|
|
197
|
+
|-------------|-------------|------------------|
|
|
198
|
+
| **200** | Successful operation | - |
|
|
199
|
+
| **403** | Forbidden | - |
|
|
200
|
+
|
|
201
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
202
|
+
|
|
203
|
+
|
|
111
204
|
## autocompleteAssets
|
|
112
205
|
|
|
113
206
|
> AutocompleteResponse autocompleteAssets(term, resourceType, assets, collections, folders, tags, users, withDeletedUsers, userGroups, metadataFieldOptions)
|
|
@@ -421,13 +514,13 @@ example().catch(console.error);
|
|
|
421
514
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
422
515
|
|
|
423
516
|
|
|
424
|
-
##
|
|
517
|
+
## createPortal
|
|
425
518
|
|
|
426
|
-
>
|
|
519
|
+
> Portal createPortal(createPortalRequest)
|
|
427
520
|
|
|
428
|
-
|
|
521
|
+
Create a portal
|
|
429
522
|
|
|
430
|
-
|
|
523
|
+
Creates a portal (branded share page), optionally pre-populated with collections via collection_ids.
|
|
431
524
|
|
|
432
525
|
### Example
|
|
433
526
|
|
|
@@ -436,7 +529,7 @@ import {
|
|
|
436
529
|
Configuration,
|
|
437
530
|
AssetManagementApi,
|
|
438
531
|
} from '@cloudinary/apps-api';
|
|
439
|
-
import type {
|
|
532
|
+
import type { CreatePortalOperationRequest } from '@cloudinary/apps-api';
|
|
440
533
|
|
|
441
534
|
async function example() {
|
|
442
535
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -447,14 +540,12 @@ async function example() {
|
|
|
447
540
|
const api = new AssetManagementApi(config);
|
|
448
541
|
|
|
449
542
|
const body = {
|
|
450
|
-
//
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
deleteResources: true,
|
|
454
|
-
} satisfies DeleteFolderRequest;
|
|
543
|
+
// CreatePortalRequest (optional)
|
|
544
|
+
createPortalRequest: ...,
|
|
545
|
+
} satisfies CreatePortalOperationRequest;
|
|
455
546
|
|
|
456
547
|
try {
|
|
457
|
-
const data = await api.
|
|
548
|
+
const data = await api.createPortal(body);
|
|
458
549
|
console.log(data);
|
|
459
550
|
} catch (error) {
|
|
460
551
|
console.error(error);
|
|
@@ -470,12 +561,11 @@ example().catch(console.error);
|
|
|
470
561
|
|
|
471
562
|
| Name | Type | Description | Notes |
|
|
472
563
|
|------------- | ------------- | ------------- | -------------|
|
|
473
|
-
| **
|
|
474
|
-
| **deleteResources** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
564
|
+
| **createPortalRequest** | [CreatePortalRequest](CreatePortalRequest.md) | | [Optional] |
|
|
475
565
|
|
|
476
566
|
### Return type
|
|
477
567
|
|
|
478
|
-
[**
|
|
568
|
+
[**Portal**](Portal.md)
|
|
479
569
|
|
|
480
570
|
### Authorization
|
|
481
571
|
|
|
@@ -483,7 +573,7 @@ example().catch(console.error);
|
|
|
483
573
|
|
|
484
574
|
### HTTP request headers
|
|
485
575
|
|
|
486
|
-
- **Content-Type**:
|
|
576
|
+
- **Content-Type**: `application/json`
|
|
487
577
|
- **Accept**: `application/json`
|
|
488
578
|
|
|
489
579
|
|
|
@@ -491,17 +581,18 @@ example().catch(console.error);
|
|
|
491
581
|
| Status code | Description | Response headers |
|
|
492
582
|
|-------------|-------------|------------------|
|
|
493
583
|
| **200** | Successful operation | - |
|
|
584
|
+
| **403** | Forbidden | - |
|
|
494
585
|
|
|
495
586
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
496
587
|
|
|
497
588
|
|
|
498
|
-
##
|
|
589
|
+
## createPublicLink
|
|
499
590
|
|
|
500
|
-
>
|
|
591
|
+
> PublicLinkResponse createPublicLink(subjectType, subjectId, createPublicLinkRequest)
|
|
501
592
|
|
|
502
|
-
|
|
593
|
+
Create a public link for an entity
|
|
503
594
|
|
|
504
|
-
|
|
595
|
+
Creates a public share link for the given entity (e.g. a collection), optionally time-limited via start_at/end_at. Anyone with the returned URL can view the shared content.
|
|
505
596
|
|
|
506
597
|
### Example
|
|
507
598
|
|
|
@@ -510,7 +601,7 @@ import {
|
|
|
510
601
|
Configuration,
|
|
511
602
|
AssetManagementApi,
|
|
512
603
|
} from '@cloudinary/apps-api';
|
|
513
|
-
import type {
|
|
604
|
+
import type { CreatePublicLinkOperationRequest } from '@cloudinary/apps-api';
|
|
514
605
|
|
|
515
606
|
async function example() {
|
|
516
607
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -521,12 +612,16 @@ async function example() {
|
|
|
521
612
|
const api = new AssetManagementApi(config);
|
|
522
613
|
|
|
523
614
|
const body = {
|
|
524
|
-
// string |
|
|
525
|
-
|
|
526
|
-
|
|
615
|
+
// string | Type of the entity to share (e.g. collections)
|
|
616
|
+
subjectType: subjectType_example,
|
|
617
|
+
// string | External ID of the entity to share
|
|
618
|
+
subjectId: subjectId_example,
|
|
619
|
+
// CreatePublicLinkRequest (optional)
|
|
620
|
+
createPublicLinkRequest: ...,
|
|
621
|
+
} satisfies CreatePublicLinkOperationRequest;
|
|
527
622
|
|
|
528
623
|
try {
|
|
529
|
-
const data = await api.
|
|
624
|
+
const data = await api.createPublicLink(body);
|
|
530
625
|
console.log(data);
|
|
531
626
|
} catch (error) {
|
|
532
627
|
console.error(error);
|
|
@@ -542,11 +637,13 @@ example().catch(console.error);
|
|
|
542
637
|
|
|
543
638
|
| Name | Type | Description | Notes |
|
|
544
639
|
|------------- | ------------- | ------------- | -------------|
|
|
545
|
-
| **
|
|
640
|
+
| **subjectType** | `string` | Type of the entity to share (e.g. collections) | [Defaults to `undefined`] |
|
|
641
|
+
| **subjectId** | `string` | External ID of the entity to share | [Defaults to `undefined`] |
|
|
642
|
+
| **createPublicLinkRequest** | [CreatePublicLinkRequest](CreatePublicLinkRequest.md) | | [Optional] |
|
|
546
643
|
|
|
547
644
|
### Return type
|
|
548
645
|
|
|
549
|
-
[**
|
|
646
|
+
[**PublicLinkResponse**](PublicLinkResponse.md)
|
|
550
647
|
|
|
551
648
|
### Authorization
|
|
552
649
|
|
|
@@ -554,7 +651,7 @@ example().catch(console.error);
|
|
|
554
651
|
|
|
555
652
|
### HTTP request headers
|
|
556
653
|
|
|
557
|
-
- **Content-Type**:
|
|
654
|
+
- **Content-Type**: `application/json`
|
|
558
655
|
- **Accept**: `application/json`
|
|
559
656
|
|
|
560
657
|
|
|
@@ -567,13 +664,13 @@ example().catch(console.error);
|
|
|
567
664
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
568
665
|
|
|
569
666
|
|
|
570
|
-
##
|
|
667
|
+
## createSavedSearch
|
|
571
668
|
|
|
572
|
-
>
|
|
669
|
+
> SavedSearch createSavedSearch(createSavedSearchRequest)
|
|
573
670
|
|
|
574
|
-
|
|
671
|
+
Create a saved search
|
|
575
672
|
|
|
576
|
-
|
|
673
|
+
Persists a named search definition (filters and query type), optionally shared with other users or groups.
|
|
577
674
|
|
|
578
675
|
### Example
|
|
579
676
|
|
|
@@ -582,7 +679,7 @@ import {
|
|
|
582
679
|
Configuration,
|
|
583
680
|
AssetManagementApi,
|
|
584
681
|
} from '@cloudinary/apps-api';
|
|
585
|
-
import type {
|
|
682
|
+
import type { CreateSavedSearchOperationRequest } from '@cloudinary/apps-api';
|
|
586
683
|
|
|
587
684
|
async function example() {
|
|
588
685
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -593,12 +690,12 @@ async function example() {
|
|
|
593
690
|
const api = new AssetManagementApi(config);
|
|
594
691
|
|
|
595
692
|
const body = {
|
|
596
|
-
//
|
|
597
|
-
|
|
598
|
-
} satisfies
|
|
693
|
+
// CreateSavedSearchRequest (optional)
|
|
694
|
+
createSavedSearchRequest: ...,
|
|
695
|
+
} satisfies CreateSavedSearchOperationRequest;
|
|
599
696
|
|
|
600
697
|
try {
|
|
601
|
-
const data = await api.
|
|
698
|
+
const data = await api.createSavedSearch(body);
|
|
602
699
|
console.log(data);
|
|
603
700
|
} catch (error) {
|
|
604
701
|
console.error(error);
|
|
@@ -614,11 +711,11 @@ example().catch(console.error);
|
|
|
614
711
|
|
|
615
712
|
| Name | Type | Description | Notes |
|
|
616
713
|
|------------- | ------------- | ------------- | -------------|
|
|
617
|
-
| **
|
|
714
|
+
| **createSavedSearchRequest** | [CreateSavedSearchRequest](CreateSavedSearchRequest.md) | | [Optional] |
|
|
618
715
|
|
|
619
716
|
### Return type
|
|
620
717
|
|
|
621
|
-
[**
|
|
718
|
+
[**SavedSearch**](SavedSearch.md)
|
|
622
719
|
|
|
623
720
|
### Authorization
|
|
624
721
|
|
|
@@ -633,18 +730,19 @@ example().catch(console.error);
|
|
|
633
730
|
### HTTP response details
|
|
634
731
|
| Status code | Description | Response headers |
|
|
635
732
|
|-------------|-------------|------------------|
|
|
636
|
-
| **200** | Successful
|
|
733
|
+
| **200** | Successful operation | - |
|
|
734
|
+
| **403** | Forbidden | - |
|
|
637
735
|
|
|
638
736
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
639
737
|
|
|
640
738
|
|
|
641
|
-
##
|
|
739
|
+
## deleteFolder
|
|
642
740
|
|
|
643
|
-
>
|
|
741
|
+
> DeleteFolderResponse deleteFolder(id, deleteResources)
|
|
644
742
|
|
|
645
|
-
|
|
743
|
+
Delete a folder
|
|
646
744
|
|
|
647
|
-
|
|
745
|
+
Deletes a folder by its external ID. The upstream Console API rejects deletion when the folder still contains assets.
|
|
648
746
|
|
|
649
747
|
### Example
|
|
650
748
|
|
|
@@ -653,7 +751,7 @@ import {
|
|
|
653
751
|
Configuration,
|
|
654
752
|
AssetManagementApi,
|
|
655
753
|
} from '@cloudinary/apps-api';
|
|
656
|
-
import type {
|
|
754
|
+
import type { DeleteFolderRequest } from '@cloudinary/apps-api';
|
|
657
755
|
|
|
658
756
|
async function example() {
|
|
659
757
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -664,16 +762,14 @@ async function example() {
|
|
|
664
762
|
const api = new AssetManagementApi(config);
|
|
665
763
|
|
|
666
764
|
const body = {
|
|
667
|
-
// string
|
|
668
|
-
|
|
669
|
-
//
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
redirect: true,
|
|
673
|
-
} satisfies DownloadCollectionRequest;
|
|
765
|
+
// string
|
|
766
|
+
id: id_example,
|
|
767
|
+
// boolean (optional)
|
|
768
|
+
deleteResources: true,
|
|
769
|
+
} satisfies DeleteFolderRequest;
|
|
674
770
|
|
|
675
771
|
try {
|
|
676
|
-
const data = await api.
|
|
772
|
+
const data = await api.deleteFolder(body);
|
|
677
773
|
console.log(data);
|
|
678
774
|
} catch (error) {
|
|
679
775
|
console.error(error);
|
|
@@ -689,13 +785,12 @@ example().catch(console.error);
|
|
|
689
785
|
|
|
690
786
|
| Name | Type | Description | Notes |
|
|
691
787
|
|------------- | ------------- | ------------- | -------------|
|
|
692
|
-
| **
|
|
693
|
-
| **
|
|
694
|
-
| **redirect** | `boolean` | Whether to redirect to the archive URL | [Optional] [Defaults to `undefined`] |
|
|
788
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
789
|
+
| **deleteResources** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
695
790
|
|
|
696
791
|
### Return type
|
|
697
792
|
|
|
698
|
-
[**
|
|
793
|
+
[**DeleteFolderResponse**](DeleteFolderResponse.md)
|
|
699
794
|
|
|
700
795
|
### Authorization
|
|
701
796
|
|
|
@@ -711,18 +806,17 @@ example().catch(console.error);
|
|
|
711
806
|
| Status code | Description | Response headers |
|
|
712
807
|
|-------------|-------------|------------------|
|
|
713
808
|
| **200** | Successful operation | - |
|
|
714
|
-
| **403** | Forbidden | - |
|
|
715
809
|
|
|
716
810
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
717
811
|
|
|
718
812
|
|
|
719
|
-
##
|
|
813
|
+
## deletePortal
|
|
720
814
|
|
|
721
|
-
>
|
|
815
|
+
> Portal deletePortal(id)
|
|
722
816
|
|
|
723
|
-
|
|
817
|
+
Delete a portal
|
|
724
818
|
|
|
725
|
-
|
|
819
|
+
Deletes a portal. The collections included in the portal are not affected.
|
|
726
820
|
|
|
727
821
|
### Example
|
|
728
822
|
|
|
@@ -731,7 +825,7 @@ import {
|
|
|
731
825
|
Configuration,
|
|
732
826
|
AssetManagementApi,
|
|
733
827
|
} from '@cloudinary/apps-api';
|
|
734
|
-
import type {
|
|
828
|
+
import type { DeletePortalRequest } from '@cloudinary/apps-api';
|
|
735
829
|
|
|
736
830
|
async function example() {
|
|
737
831
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -742,18 +836,12 @@ async function example() {
|
|
|
742
836
|
const api = new AssetManagementApi(config);
|
|
743
837
|
|
|
744
838
|
const body = {
|
|
745
|
-
// string |
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
system: system_example,
|
|
749
|
-
// string | Filter by tenant/workspace ID (requires system) (optional)
|
|
750
|
-
tenant: tenant_example,
|
|
751
|
-
// boolean | Include backreferences whose current action is remove (optional)
|
|
752
|
-
includeRemoved: true,
|
|
753
|
-
} satisfies ListAssetBackreferencesRequest;
|
|
839
|
+
// string | Portal ID
|
|
840
|
+
id: id_example,
|
|
841
|
+
} satisfies DeletePortalRequest;
|
|
754
842
|
|
|
755
843
|
try {
|
|
756
|
-
const data = await api.
|
|
844
|
+
const data = await api.deletePortal(body);
|
|
757
845
|
console.log(data);
|
|
758
846
|
} catch (error) {
|
|
759
847
|
console.error(error);
|
|
@@ -769,14 +857,11 @@ example().catch(console.error);
|
|
|
769
857
|
|
|
770
858
|
| Name | Type | Description | Notes |
|
|
771
859
|
|------------- | ------------- | ------------- | -------------|
|
|
772
|
-
| **
|
|
773
|
-
| **system** | `string` | Filter by system name (e.g., \'monday\') | [Optional] [Defaults to `undefined`] |
|
|
774
|
-
| **tenant** | `string` | Filter by tenant/workspace ID (requires system) | [Optional] [Defaults to `undefined`] |
|
|
775
|
-
| **includeRemoved** | `boolean` | Include backreferences whose current action is remove | [Optional] [Defaults to `undefined`] |
|
|
860
|
+
| **id** | `string` | Portal ID | [Defaults to `undefined`] |
|
|
776
861
|
|
|
777
862
|
### Return type
|
|
778
863
|
|
|
779
|
-
[**
|
|
864
|
+
[**Portal**](Portal.md)
|
|
780
865
|
|
|
781
866
|
### Authorization
|
|
782
867
|
|
|
@@ -792,18 +877,18 @@ example().catch(console.error);
|
|
|
792
877
|
| Status code | Description | Response headers |
|
|
793
878
|
|-------------|-------------|------------------|
|
|
794
879
|
| **200** | Successful operation | - |
|
|
795
|
-
| **
|
|
880
|
+
| **403** | Forbidden | - |
|
|
796
881
|
|
|
797
882
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
798
883
|
|
|
799
884
|
|
|
800
|
-
##
|
|
885
|
+
## deletePublicLink
|
|
801
886
|
|
|
802
|
-
>
|
|
887
|
+
> object deletePublicLink(subjectType, subjectId, id)
|
|
803
888
|
|
|
804
|
-
|
|
889
|
+
Revoke a public link
|
|
805
890
|
|
|
806
|
-
|
|
891
|
+
Deletes a public link. The shared URL stops working immediately; the underlying entity is not affected.
|
|
807
892
|
|
|
808
893
|
### Example
|
|
809
894
|
|
|
@@ -812,7 +897,7 @@ import {
|
|
|
812
897
|
Configuration,
|
|
813
898
|
AssetManagementApi,
|
|
814
899
|
} from '@cloudinary/apps-api';
|
|
815
|
-
import type {
|
|
900
|
+
import type { DeletePublicLinkRequest } from '@cloudinary/apps-api';
|
|
816
901
|
|
|
817
902
|
async function example() {
|
|
818
903
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -823,16 +908,16 @@ async function example() {
|
|
|
823
908
|
const api = new AssetManagementApi(config);
|
|
824
909
|
|
|
825
910
|
const body = {
|
|
826
|
-
//
|
|
827
|
-
|
|
828
|
-
// string
|
|
829
|
-
|
|
830
|
-
// string
|
|
831
|
-
|
|
832
|
-
} satisfies
|
|
911
|
+
// string | Type of the shared entity (e.g. collections)
|
|
912
|
+
subjectType: subjectType_example,
|
|
913
|
+
// string | External ID of the shared entity
|
|
914
|
+
subjectId: subjectId_example,
|
|
915
|
+
// string | Public link ID
|
|
916
|
+
id: id_example,
|
|
917
|
+
} satisfies DeletePublicLinkRequest;
|
|
833
918
|
|
|
834
919
|
try {
|
|
835
|
-
const data = await api.
|
|
920
|
+
const data = await api.deletePublicLink(body);
|
|
836
921
|
console.log(data);
|
|
837
922
|
} catch (error) {
|
|
838
923
|
console.error(error);
|
|
@@ -848,13 +933,13 @@ example().catch(console.error);
|
|
|
848
933
|
|
|
849
934
|
| Name | Type | Description | Notes |
|
|
850
935
|
|------------- | ------------- | ------------- | -------------|
|
|
851
|
-
| **
|
|
852
|
-
| **
|
|
853
|
-
| **
|
|
936
|
+
| **subjectType** | `string` | Type of the shared entity (e.g. collections) | [Defaults to `undefined`] |
|
|
937
|
+
| **subjectId** | `string` | External ID of the shared entity | [Defaults to `undefined`] |
|
|
938
|
+
| **id** | `string` | Public link ID | [Defaults to `undefined`] |
|
|
854
939
|
|
|
855
940
|
### Return type
|
|
856
941
|
|
|
857
|
-
|
|
942
|
+
**object**
|
|
858
943
|
|
|
859
944
|
### Authorization
|
|
860
945
|
|
|
@@ -870,17 +955,18 @@ example().catch(console.error);
|
|
|
870
955
|
| Status code | Description | Response headers |
|
|
871
956
|
|-------------|-------------|------------------|
|
|
872
957
|
| **200** | Successful operation | - |
|
|
958
|
+
| **403** | Forbidden | - |
|
|
873
959
|
|
|
874
960
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
875
961
|
|
|
876
962
|
|
|
877
|
-
##
|
|
963
|
+
## deleteSavedSearch
|
|
878
964
|
|
|
879
|
-
>
|
|
965
|
+
> SavedSearch deleteSavedSearch(id)
|
|
880
966
|
|
|
881
|
-
|
|
967
|
+
Delete a saved search
|
|
882
968
|
|
|
883
|
-
|
|
969
|
+
Deletes a saved search by ID. The assets matched by the search are not affected.
|
|
884
970
|
|
|
885
971
|
### Example
|
|
886
972
|
|
|
@@ -889,7 +975,7 @@ import {
|
|
|
889
975
|
Configuration,
|
|
890
976
|
AssetManagementApi,
|
|
891
977
|
} from '@cloudinary/apps-api';
|
|
892
|
-
import type {
|
|
978
|
+
import type { DeleteSavedSearchRequest } from '@cloudinary/apps-api';
|
|
893
979
|
|
|
894
980
|
async function example() {
|
|
895
981
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -900,16 +986,12 @@ async function example() {
|
|
|
900
986
|
const api = new AssetManagementApi(config);
|
|
901
987
|
|
|
902
988
|
const body = {
|
|
903
|
-
// string |
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
maxResults: 8.14,
|
|
907
|
-
// number | Pagination cursor (optional)
|
|
908
|
-
nextCursor: 8.14,
|
|
909
|
-
} satisfies ListAssetHistoryRequest;
|
|
989
|
+
// string | Saved search ID
|
|
990
|
+
id: id_example,
|
|
991
|
+
} satisfies DeleteSavedSearchRequest;
|
|
910
992
|
|
|
911
993
|
try {
|
|
912
|
-
const data = await api.
|
|
994
|
+
const data = await api.deleteSavedSearch(body);
|
|
913
995
|
console.log(data);
|
|
914
996
|
} catch (error) {
|
|
915
997
|
console.error(error);
|
|
@@ -925,13 +1007,11 @@ example().catch(console.error);
|
|
|
925
1007
|
|
|
926
1008
|
| Name | Type | Description | Notes |
|
|
927
1009
|
|------------- | ------------- | ------------- | -------------|
|
|
928
|
-
| **
|
|
929
|
-
| **maxResults** | `number` | Maximum number of history entries to return | [Optional] [Defaults to `undefined`] |
|
|
930
|
-
| **nextCursor** | `number` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
1010
|
+
| **id** | `string` | Saved search ID | [Defaults to `undefined`] |
|
|
931
1011
|
|
|
932
1012
|
### Return type
|
|
933
1013
|
|
|
934
|
-
[**
|
|
1014
|
+
[**SavedSearch**](SavedSearch.md)
|
|
935
1015
|
|
|
936
1016
|
### Authorization
|
|
937
1017
|
|
|
@@ -947,17 +1027,18 @@ example().catch(console.error);
|
|
|
947
1027
|
| Status code | Description | Response headers |
|
|
948
1028
|
|-------------|-------------|------------------|
|
|
949
1029
|
| **200** | Successful operation | - |
|
|
1030
|
+
| **403** | Forbidden | - |
|
|
950
1031
|
|
|
951
1032
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
952
1033
|
|
|
953
1034
|
|
|
954
|
-
##
|
|
1035
|
+
## destroyCollection
|
|
955
1036
|
|
|
956
|
-
>
|
|
1037
|
+
> Collection destroyCollection(collectionId)
|
|
957
1038
|
|
|
958
|
-
|
|
1039
|
+
Delete a collection
|
|
959
1040
|
|
|
960
|
-
|
|
1041
|
+
Soft-deletes a collection. The collection\'s assets are not removed from the cloud. Caller must have write access.
|
|
961
1042
|
|
|
962
1043
|
### Example
|
|
963
1044
|
|
|
@@ -966,7 +1047,7 @@ import {
|
|
|
966
1047
|
Configuration,
|
|
967
1048
|
AssetManagementApi,
|
|
968
1049
|
} from '@cloudinary/apps-api';
|
|
969
|
-
import type {
|
|
1050
|
+
import type { DestroyCollectionRequest } from '@cloudinary/apps-api';
|
|
970
1051
|
|
|
971
1052
|
async function example() {
|
|
972
1053
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -976,8 +1057,13 @@ async function example() {
|
|
|
976
1057
|
});
|
|
977
1058
|
const api = new AssetManagementApi(config);
|
|
978
1059
|
|
|
1060
|
+
const body = {
|
|
1061
|
+
// string | Collection external ID
|
|
1062
|
+
collectionId: collectionId_example,
|
|
1063
|
+
} satisfies DestroyCollectionRequest;
|
|
1064
|
+
|
|
979
1065
|
try {
|
|
980
|
-
const data = await api.
|
|
1066
|
+
const data = await api.destroyCollection(body);
|
|
981
1067
|
console.log(data);
|
|
982
1068
|
} catch (error) {
|
|
983
1069
|
console.error(error);
|
|
@@ -990,11 +1076,14 @@ example().catch(console.error);
|
|
|
990
1076
|
|
|
991
1077
|
### Parameters
|
|
992
1078
|
|
|
993
|
-
|
|
1079
|
+
|
|
1080
|
+
| Name | Type | Description | Notes |
|
|
1081
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1082
|
+
| **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
|
|
994
1083
|
|
|
995
1084
|
### Return type
|
|
996
1085
|
|
|
997
|
-
[**
|
|
1086
|
+
[**Collection**](Collection.md)
|
|
998
1087
|
|
|
999
1088
|
### Authorization
|
|
1000
1089
|
|
|
@@ -1010,17 +1099,18 @@ This endpoint does not need any parameter.
|
|
|
1010
1099
|
| Status code | Description | Response headers |
|
|
1011
1100
|
|-------------|-------------|------------------|
|
|
1012
1101
|
| **200** | Successful operation | - |
|
|
1102
|
+
| **403** | Forbidden | - |
|
|
1013
1103
|
|
|
1014
1104
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1015
1105
|
|
|
1016
1106
|
|
|
1017
|
-
##
|
|
1107
|
+
## downloadAsset
|
|
1018
1108
|
|
|
1019
|
-
>
|
|
1109
|
+
> DownloadAssetResponse downloadAsset(downloadAssetRequest)
|
|
1020
1110
|
|
|
1021
|
-
|
|
1111
|
+
Generate a download URL for an asset
|
|
1022
1112
|
|
|
1023
|
-
Returns
|
|
1113
|
+
Returns a time-limited redirect URL for downloading an asset. Accepts external_id directly, or resolves public_id to external_id via search. Optionally applies a transformation before download.
|
|
1024
1114
|
|
|
1025
1115
|
### Example
|
|
1026
1116
|
|
|
@@ -1029,7 +1119,7 @@ import {
|
|
|
1029
1119
|
Configuration,
|
|
1030
1120
|
AssetManagementApi,
|
|
1031
1121
|
} from '@cloudinary/apps-api';
|
|
1032
|
-
import type {
|
|
1122
|
+
import type { DownloadAssetOperationRequest } from '@cloudinary/apps-api';
|
|
1033
1123
|
|
|
1034
1124
|
async function example() {
|
|
1035
1125
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1040,20 +1130,12 @@ async function example() {
|
|
|
1040
1130
|
const api = new AssetManagementApi(config);
|
|
1041
1131
|
|
|
1042
1132
|
const body = {
|
|
1043
|
-
//
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
resourceType: resourceType_example,
|
|
1047
|
-
// string (optional)
|
|
1048
|
-
sortBy: sortBy_example,
|
|
1049
|
-
// number (optional)
|
|
1050
|
-
maxResults: 56,
|
|
1051
|
-
// string (optional)
|
|
1052
|
-
nextCursor: nextCursor_example,
|
|
1053
|
-
} satisfies ListAssetsByFolderRequest;
|
|
1133
|
+
// DownloadAssetRequest (optional)
|
|
1134
|
+
downloadAssetRequest: ...,
|
|
1135
|
+
} satisfies DownloadAssetOperationRequest;
|
|
1054
1136
|
|
|
1055
1137
|
try {
|
|
1056
|
-
const data = await api.
|
|
1138
|
+
const data = await api.downloadAsset(body);
|
|
1057
1139
|
console.log(data);
|
|
1058
1140
|
} catch (error) {
|
|
1059
1141
|
console.error(error);
|
|
@@ -1069,11 +1151,538 @@ example().catch(console.error);
|
|
|
1069
1151
|
|
|
1070
1152
|
| Name | Type | Description | Notes |
|
|
1071
1153
|
|------------- | ------------- | ------------- | -------------|
|
|
1072
|
-
| **
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1154
|
+
| **downloadAssetRequest** | [DownloadAssetRequest](DownloadAssetRequest.md) | | [Optional] |
|
|
1155
|
+
|
|
1156
|
+
### Return type
|
|
1157
|
+
|
|
1158
|
+
[**DownloadAssetResponse**](DownloadAssetResponse.md)
|
|
1159
|
+
|
|
1160
|
+
### Authorization
|
|
1161
|
+
|
|
1162
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1163
|
+
|
|
1164
|
+
### HTTP request headers
|
|
1165
|
+
|
|
1166
|
+
- **Content-Type**: `application/json`
|
|
1167
|
+
- **Accept**: `application/json`
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
### HTTP response details
|
|
1171
|
+
| Status code | Description | Response headers |
|
|
1172
|
+
|-------------|-------------|------------------|
|
|
1173
|
+
| **200** | Successful download response with URL | - |
|
|
1174
|
+
|
|
1175
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
## downloadCollection
|
|
1179
|
+
|
|
1180
|
+
> DownloadCollectionResponse downloadCollection(collectionId, targetPublicId, redirect)
|
|
1181
|
+
|
|
1182
|
+
Download a collection as an archive
|
|
1183
|
+
|
|
1184
|
+
Generates a ZIP archive containing all assets in the collection. Returns an archive URL or redirects to it depending on the redirect parameter.
|
|
1185
|
+
|
|
1186
|
+
### Example
|
|
1187
|
+
|
|
1188
|
+
```ts
|
|
1189
|
+
import {
|
|
1190
|
+
Configuration,
|
|
1191
|
+
AssetManagementApi,
|
|
1192
|
+
} from '@cloudinary/apps-api';
|
|
1193
|
+
import type { DownloadCollectionRequest } from '@cloudinary/apps-api';
|
|
1194
|
+
|
|
1195
|
+
async function example() {
|
|
1196
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1197
|
+
const config = new Configuration({
|
|
1198
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1199
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1200
|
+
});
|
|
1201
|
+
const api = new AssetManagementApi(config);
|
|
1202
|
+
|
|
1203
|
+
const body = {
|
|
1204
|
+
// string | Collection external ID
|
|
1205
|
+
collectionId: collectionId_example,
|
|
1206
|
+
// string | Target public ID for the archive (optional)
|
|
1207
|
+
targetPublicId: targetPublicId_example,
|
|
1208
|
+
// boolean | Whether to redirect to the archive URL (optional)
|
|
1209
|
+
redirect: true,
|
|
1210
|
+
} satisfies DownloadCollectionRequest;
|
|
1211
|
+
|
|
1212
|
+
try {
|
|
1213
|
+
const data = await api.downloadCollection(body);
|
|
1214
|
+
console.log(data);
|
|
1215
|
+
} catch (error) {
|
|
1216
|
+
console.error(error);
|
|
1217
|
+
}
|
|
1218
|
+
}
|
|
1219
|
+
|
|
1220
|
+
// Run the test
|
|
1221
|
+
example().catch(console.error);
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### Parameters
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
| Name | Type | Description | Notes |
|
|
1228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1229
|
+
| **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
|
|
1230
|
+
| **targetPublicId** | `string` | Target public ID for the archive | [Optional] [Defaults to `undefined`] |
|
|
1231
|
+
| **redirect** | `boolean` | Whether to redirect to the archive URL | [Optional] [Defaults to `undefined`] |
|
|
1232
|
+
|
|
1233
|
+
### Return type
|
|
1234
|
+
|
|
1235
|
+
[**DownloadCollectionResponse**](DownloadCollectionResponse.md)
|
|
1236
|
+
|
|
1237
|
+
### Authorization
|
|
1238
|
+
|
|
1239
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1240
|
+
|
|
1241
|
+
### HTTP request headers
|
|
1242
|
+
|
|
1243
|
+
- **Content-Type**: Not defined
|
|
1244
|
+
- **Accept**: `application/json`
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
### HTTP response details
|
|
1248
|
+
| Status code | Description | Response headers |
|
|
1249
|
+
|-------------|-------------|------------------|
|
|
1250
|
+
| **200** | Successful operation | - |
|
|
1251
|
+
| **403** | Forbidden | - |
|
|
1252
|
+
|
|
1253
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
## getAssetsLastDelivery
|
|
1257
|
+
|
|
1258
|
+
> LastDeliveryResponse getAssetsLastDelivery(getAssetsLastDeliveryRequest)
|
|
1259
|
+
|
|
1260
|
+
Get last delivery dates for assets
|
|
1261
|
+
|
|
1262
|
+
Returns the most recent delivery (CDN access) date per asset for the given external IDs. Useful for delivery-recency checks such as cleanup or expiry flows.
|
|
1263
|
+
|
|
1264
|
+
### Example
|
|
1265
|
+
|
|
1266
|
+
```ts
|
|
1267
|
+
import {
|
|
1268
|
+
Configuration,
|
|
1269
|
+
AssetManagementApi,
|
|
1270
|
+
} from '@cloudinary/apps-api';
|
|
1271
|
+
import type { GetAssetsLastDeliveryOperationRequest } from '@cloudinary/apps-api';
|
|
1272
|
+
|
|
1273
|
+
async function example() {
|
|
1274
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1275
|
+
const config = new Configuration({
|
|
1276
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1277
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1278
|
+
});
|
|
1279
|
+
const api = new AssetManagementApi(config);
|
|
1280
|
+
|
|
1281
|
+
const body = {
|
|
1282
|
+
// GetAssetsLastDeliveryRequest (optional)
|
|
1283
|
+
getAssetsLastDeliveryRequest: ...,
|
|
1284
|
+
} satisfies GetAssetsLastDeliveryOperationRequest;
|
|
1285
|
+
|
|
1286
|
+
try {
|
|
1287
|
+
const data = await api.getAssetsLastDelivery(body);
|
|
1288
|
+
console.log(data);
|
|
1289
|
+
} catch (error) {
|
|
1290
|
+
console.error(error);
|
|
1291
|
+
}
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1294
|
+
// Run the test
|
|
1295
|
+
example().catch(console.error);
|
|
1296
|
+
```
|
|
1297
|
+
|
|
1298
|
+
### Parameters
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
| Name | Type | Description | Notes |
|
|
1302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1303
|
+
| **getAssetsLastDeliveryRequest** | [GetAssetsLastDeliveryRequest](GetAssetsLastDeliveryRequest.md) | | [Optional] |
|
|
1304
|
+
|
|
1305
|
+
### Return type
|
|
1306
|
+
|
|
1307
|
+
[**LastDeliveryResponse**](LastDeliveryResponse.md)
|
|
1308
|
+
|
|
1309
|
+
### Authorization
|
|
1310
|
+
|
|
1311
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1312
|
+
|
|
1313
|
+
### HTTP request headers
|
|
1314
|
+
|
|
1315
|
+
- **Content-Type**: `application/json`
|
|
1316
|
+
- **Accept**: `application/json`
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
### HTTP response details
|
|
1320
|
+
| Status code | Description | Response headers |
|
|
1321
|
+
|-------------|-------------|------------------|
|
|
1322
|
+
| **200** | Successful operation | - |
|
|
1323
|
+
| **403** | Forbidden | - |
|
|
1324
|
+
|
|
1325
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
## listAssetBackreferences
|
|
1329
|
+
|
|
1330
|
+
> ListBackreferencesResponse listAssetBackreferences(assetId, system, tenant, includeRemoved)
|
|
1331
|
+
|
|
1332
|
+
List backreferences for an asset
|
|
1333
|
+
|
|
1334
|
+
Returns active backreference entries recorded on an asset. Optionally filter by system and/or tenant. Pass includeRemoved=true to include removed links. Context search matches ever-associated ref URIs; list reflects current link state.
|
|
1335
|
+
|
|
1336
|
+
### Example
|
|
1337
|
+
|
|
1338
|
+
```ts
|
|
1339
|
+
import {
|
|
1340
|
+
Configuration,
|
|
1341
|
+
AssetManagementApi,
|
|
1342
|
+
} from '@cloudinary/apps-api';
|
|
1343
|
+
import type { ListAssetBackreferencesRequest } from '@cloudinary/apps-api';
|
|
1344
|
+
|
|
1345
|
+
async function example() {
|
|
1346
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1347
|
+
const config = new Configuration({
|
|
1348
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1349
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1350
|
+
});
|
|
1351
|
+
const api = new AssetManagementApi(config);
|
|
1352
|
+
|
|
1353
|
+
const body = {
|
|
1354
|
+
// string | Cloudinary asset id
|
|
1355
|
+
assetId: assetId_example,
|
|
1356
|
+
// string | Filter by system name (e.g., \'monday\') (optional)
|
|
1357
|
+
system: system_example,
|
|
1358
|
+
// string | Filter by tenant/workspace ID (requires system) (optional)
|
|
1359
|
+
tenant: tenant_example,
|
|
1360
|
+
// boolean | Include backreferences whose current action is remove (optional)
|
|
1361
|
+
includeRemoved: true,
|
|
1362
|
+
} satisfies ListAssetBackreferencesRequest;
|
|
1363
|
+
|
|
1364
|
+
try {
|
|
1365
|
+
const data = await api.listAssetBackreferences(body);
|
|
1366
|
+
console.log(data);
|
|
1367
|
+
} catch (error) {
|
|
1368
|
+
console.error(error);
|
|
1369
|
+
}
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
// Run the test
|
|
1373
|
+
example().catch(console.error);
|
|
1374
|
+
```
|
|
1375
|
+
|
|
1376
|
+
### Parameters
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
| Name | Type | Description | Notes |
|
|
1380
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1381
|
+
| **assetId** | `string` | Cloudinary asset id | [Defaults to `undefined`] |
|
|
1382
|
+
| **system** | `string` | Filter by system name (e.g., \'monday\') | [Optional] [Defaults to `undefined`] |
|
|
1383
|
+
| **tenant** | `string` | Filter by tenant/workspace ID (requires system) | [Optional] [Defaults to `undefined`] |
|
|
1384
|
+
| **includeRemoved** | `boolean` | Include backreferences whose current action is remove | [Optional] [Defaults to `undefined`] |
|
|
1385
|
+
|
|
1386
|
+
### Return type
|
|
1387
|
+
|
|
1388
|
+
[**ListBackreferencesResponse**](ListBackreferencesResponse.md)
|
|
1389
|
+
|
|
1390
|
+
### Authorization
|
|
1391
|
+
|
|
1392
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1393
|
+
|
|
1394
|
+
### HTTP request headers
|
|
1395
|
+
|
|
1396
|
+
- **Content-Type**: Not defined
|
|
1397
|
+
- **Accept**: `application/json`
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
### HTTP response details
|
|
1401
|
+
| Status code | Description | Response headers |
|
|
1402
|
+
|-------------|-------------|------------------|
|
|
1403
|
+
| **200** | Successful operation | - |
|
|
1404
|
+
| **404** | Asset not found | - |
|
|
1405
|
+
|
|
1406
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
## listAssetContextFields
|
|
1410
|
+
|
|
1411
|
+
> ListContextualMetadataFieldsResponse listAssetContextFields(maxResults, nextCursor, prefix)
|
|
1412
|
+
|
|
1413
|
+
List contextual metadata fields
|
|
1414
|
+
|
|
1415
|
+
Returns contextual metadata keys in use across assets in the cloud. Unlike structured metadata fields, contextual fields are simple key-value pairs without type definitions.
|
|
1416
|
+
|
|
1417
|
+
### Example
|
|
1418
|
+
|
|
1419
|
+
```ts
|
|
1420
|
+
import {
|
|
1421
|
+
Configuration,
|
|
1422
|
+
AssetManagementApi,
|
|
1423
|
+
} from '@cloudinary/apps-api';
|
|
1424
|
+
import type { ListAssetContextFieldsRequest } from '@cloudinary/apps-api';
|
|
1425
|
+
|
|
1426
|
+
async function example() {
|
|
1427
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1428
|
+
const config = new Configuration({
|
|
1429
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1430
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1431
|
+
});
|
|
1432
|
+
const api = new AssetManagementApi(config);
|
|
1433
|
+
|
|
1434
|
+
const body = {
|
|
1435
|
+
// number (optional)
|
|
1436
|
+
maxResults: 56,
|
|
1437
|
+
// string (optional)
|
|
1438
|
+
nextCursor: nextCursor_example,
|
|
1439
|
+
// string (optional)
|
|
1440
|
+
prefix: prefix_example,
|
|
1441
|
+
} satisfies ListAssetContextFieldsRequest;
|
|
1442
|
+
|
|
1443
|
+
try {
|
|
1444
|
+
const data = await api.listAssetContextFields(body);
|
|
1445
|
+
console.log(data);
|
|
1446
|
+
} catch (error) {
|
|
1447
|
+
console.error(error);
|
|
1448
|
+
}
|
|
1449
|
+
}
|
|
1450
|
+
|
|
1451
|
+
// Run the test
|
|
1452
|
+
example().catch(console.error);
|
|
1453
|
+
```
|
|
1454
|
+
|
|
1455
|
+
### Parameters
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
| Name | Type | Description | Notes |
|
|
1459
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1460
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `50`] |
|
|
1461
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1462
|
+
| **prefix** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1463
|
+
|
|
1464
|
+
### Return type
|
|
1465
|
+
|
|
1466
|
+
[**ListContextualMetadataFieldsResponse**](ListContextualMetadataFieldsResponse.md)
|
|
1467
|
+
|
|
1468
|
+
### Authorization
|
|
1469
|
+
|
|
1470
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1471
|
+
|
|
1472
|
+
### HTTP request headers
|
|
1473
|
+
|
|
1474
|
+
- **Content-Type**: Not defined
|
|
1475
|
+
- **Accept**: `application/json`
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
### HTTP response details
|
|
1479
|
+
| Status code | Description | Response headers |
|
|
1480
|
+
|-------------|-------------|------------------|
|
|
1481
|
+
| **200** | Successful operation | - |
|
|
1482
|
+
|
|
1483
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
## listAssetHistory
|
|
1487
|
+
|
|
1488
|
+
> AssetHistoryResponse listAssetHistory(externalId, maxResults, nextCursor)
|
|
1489
|
+
|
|
1490
|
+
List asset audit history
|
|
1491
|
+
|
|
1492
|
+
Returns paginated audit history for an asset identified by external_id, including metadata updates, downloads, version changes, and deletions.
|
|
1493
|
+
|
|
1494
|
+
### Example
|
|
1495
|
+
|
|
1496
|
+
```ts
|
|
1497
|
+
import {
|
|
1498
|
+
Configuration,
|
|
1499
|
+
AssetManagementApi,
|
|
1500
|
+
} from '@cloudinary/apps-api';
|
|
1501
|
+
import type { ListAssetHistoryRequest } from '@cloudinary/apps-api';
|
|
1502
|
+
|
|
1503
|
+
async function example() {
|
|
1504
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1505
|
+
const config = new Configuration({
|
|
1506
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1507
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1508
|
+
});
|
|
1509
|
+
const api = new AssetManagementApi(config);
|
|
1510
|
+
|
|
1511
|
+
const body = {
|
|
1512
|
+
// string | Asset external ID
|
|
1513
|
+
externalId: externalId_example,
|
|
1514
|
+
// number | Maximum number of history entries to return (optional)
|
|
1515
|
+
maxResults: 8.14,
|
|
1516
|
+
// number | Pagination cursor (optional)
|
|
1517
|
+
nextCursor: 8.14,
|
|
1518
|
+
} satisfies ListAssetHistoryRequest;
|
|
1519
|
+
|
|
1520
|
+
try {
|
|
1521
|
+
const data = await api.listAssetHistory(body);
|
|
1522
|
+
console.log(data);
|
|
1523
|
+
} catch (error) {
|
|
1524
|
+
console.error(error);
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1527
|
+
|
|
1528
|
+
// Run the test
|
|
1529
|
+
example().catch(console.error);
|
|
1530
|
+
```
|
|
1531
|
+
|
|
1532
|
+
### Parameters
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
| Name | Type | Description | Notes |
|
|
1536
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1537
|
+
| **externalId** | `string` | Asset external ID | [Defaults to `undefined`] |
|
|
1538
|
+
| **maxResults** | `number` | Maximum number of history entries to return | [Optional] [Defaults to `undefined`] |
|
|
1539
|
+
| **nextCursor** | `number` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
1540
|
+
|
|
1541
|
+
### Return type
|
|
1542
|
+
|
|
1543
|
+
[**AssetHistoryResponse**](AssetHistoryResponse.md)
|
|
1544
|
+
|
|
1545
|
+
### Authorization
|
|
1546
|
+
|
|
1547
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1548
|
+
|
|
1549
|
+
### HTTP request headers
|
|
1550
|
+
|
|
1551
|
+
- **Content-Type**: Not defined
|
|
1552
|
+
- **Accept**: `application/json`
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
### HTTP response details
|
|
1556
|
+
| Status code | Description | Response headers |
|
|
1557
|
+
|-------------|-------------|------------------|
|
|
1558
|
+
| **200** | Successful operation | - |
|
|
1559
|
+
|
|
1560
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
## listAssetMetadataFields
|
|
1564
|
+
|
|
1565
|
+
> ListMetadataFieldsResponse listAssetMetadataFields()
|
|
1566
|
+
|
|
1567
|
+
List structured metadata field definitions
|
|
1568
|
+
|
|
1569
|
+
Returns all structured metadata field definitions configured for the cloud, including field type, label, validation rules, and datasource.
|
|
1570
|
+
|
|
1571
|
+
### Example
|
|
1572
|
+
|
|
1573
|
+
```ts
|
|
1574
|
+
import {
|
|
1575
|
+
Configuration,
|
|
1576
|
+
AssetManagementApi,
|
|
1577
|
+
} from '@cloudinary/apps-api';
|
|
1578
|
+
import type { ListAssetMetadataFieldsRequest } from '@cloudinary/apps-api';
|
|
1579
|
+
|
|
1580
|
+
async function example() {
|
|
1581
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1582
|
+
const config = new Configuration({
|
|
1583
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1584
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1585
|
+
});
|
|
1586
|
+
const api = new AssetManagementApi(config);
|
|
1587
|
+
|
|
1588
|
+
try {
|
|
1589
|
+
const data = await api.listAssetMetadataFields();
|
|
1590
|
+
console.log(data);
|
|
1591
|
+
} catch (error) {
|
|
1592
|
+
console.error(error);
|
|
1593
|
+
}
|
|
1594
|
+
}
|
|
1595
|
+
|
|
1596
|
+
// Run the test
|
|
1597
|
+
example().catch(console.error);
|
|
1598
|
+
```
|
|
1599
|
+
|
|
1600
|
+
### Parameters
|
|
1601
|
+
|
|
1602
|
+
This endpoint does not need any parameter.
|
|
1603
|
+
|
|
1604
|
+
### Return type
|
|
1605
|
+
|
|
1606
|
+
[**ListMetadataFieldsResponse**](ListMetadataFieldsResponse.md)
|
|
1607
|
+
|
|
1608
|
+
### Authorization
|
|
1609
|
+
|
|
1610
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1611
|
+
|
|
1612
|
+
### HTTP request headers
|
|
1613
|
+
|
|
1614
|
+
- **Content-Type**: Not defined
|
|
1615
|
+
- **Accept**: `application/json`
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
### HTTP response details
|
|
1619
|
+
| Status code | Description | Response headers |
|
|
1620
|
+
|-------------|-------------|------------------|
|
|
1621
|
+
| **200** | Successful operation | - |
|
|
1622
|
+
|
|
1623
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
## listAssetsByFolder
|
|
1627
|
+
|
|
1628
|
+
> ListAssetsByFolderResponse listAssetsByFolder(folderId, resourceType, sortBy, maxResults, nextCursor)
|
|
1629
|
+
|
|
1630
|
+
List assets in a folder
|
|
1631
|
+
|
|
1632
|
+
Returns assets within a folder identified by folder_id, with optional resource_type filter, sorting, and cursor-based pagination.
|
|
1633
|
+
|
|
1634
|
+
### Example
|
|
1635
|
+
|
|
1636
|
+
```ts
|
|
1637
|
+
import {
|
|
1638
|
+
Configuration,
|
|
1639
|
+
AssetManagementApi,
|
|
1640
|
+
} from '@cloudinary/apps-api';
|
|
1641
|
+
import type { ListAssetsByFolderRequest } from '@cloudinary/apps-api';
|
|
1642
|
+
|
|
1643
|
+
async function example() {
|
|
1644
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1645
|
+
const config = new Configuration({
|
|
1646
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1647
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1648
|
+
});
|
|
1649
|
+
const api = new AssetManagementApi(config);
|
|
1650
|
+
|
|
1651
|
+
const body = {
|
|
1652
|
+
// string (optional)
|
|
1653
|
+
folderId: folderId_example,
|
|
1654
|
+
// 'image' | 'javascript' | 'css' | 'video' | 'raw' | 'any' (optional)
|
|
1655
|
+
resourceType: resourceType_example,
|
|
1656
|
+
// string (optional)
|
|
1657
|
+
sortBy: sortBy_example,
|
|
1658
|
+
// number (optional)
|
|
1659
|
+
maxResults: 56,
|
|
1660
|
+
// string (optional)
|
|
1661
|
+
nextCursor: nextCursor_example,
|
|
1662
|
+
} satisfies ListAssetsByFolderRequest;
|
|
1663
|
+
|
|
1664
|
+
try {
|
|
1665
|
+
const data = await api.listAssetsByFolder(body);
|
|
1666
|
+
console.log(data);
|
|
1667
|
+
} catch (error) {
|
|
1668
|
+
console.error(error);
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
// Run the test
|
|
1673
|
+
example().catch(console.error);
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
### Parameters
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
| Name | Type | Description | Notes |
|
|
1680
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1681
|
+
| **folderId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1682
|
+
| **resourceType** | `image`, `javascript`, `css`, `video`, `raw`, `any` | | [Optional] [Defaults to `undefined`] [Enum: image, javascript, css, video, raw, any] |
|
|
1683
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1684
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1685
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1077
1686
|
|
|
1078
1687
|
### Return type
|
|
1079
1688
|
|
|
@@ -1085,7 +1694,602 @@ example().catch(console.error);
|
|
|
1085
1694
|
|
|
1086
1695
|
### HTTP request headers
|
|
1087
1696
|
|
|
1088
|
-
- **Content-Type**: Not defined
|
|
1697
|
+
- **Content-Type**: Not defined
|
|
1698
|
+
- **Accept**: `application/json`
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
### HTTP response details
|
|
1702
|
+
| Status code | Description | Response headers |
|
|
1703
|
+
|-------------|-------------|------------------|
|
|
1704
|
+
| **200** | Successful operation | - |
|
|
1705
|
+
|
|
1706
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
## listCollections
|
|
1710
|
+
|
|
1711
|
+
> ListCollectionsResponse listCollections(sortBy, maxResults, nextCursor, term, ownerType)
|
|
1712
|
+
|
|
1713
|
+
List collections
|
|
1714
|
+
|
|
1715
|
+
Returns all collections accessible to the caller, with optional term filter, owner_type filter, sorting, and cursor-based pagination.
|
|
1716
|
+
|
|
1717
|
+
### Example
|
|
1718
|
+
|
|
1719
|
+
```ts
|
|
1720
|
+
import {
|
|
1721
|
+
Configuration,
|
|
1722
|
+
AssetManagementApi,
|
|
1723
|
+
} from '@cloudinary/apps-api';
|
|
1724
|
+
import type { ListCollectionsRequest } from '@cloudinary/apps-api';
|
|
1725
|
+
|
|
1726
|
+
async function example() {
|
|
1727
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1728
|
+
const config = new Configuration({
|
|
1729
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1730
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1731
|
+
});
|
|
1732
|
+
const api = new AssetManagementApi(config);
|
|
1733
|
+
|
|
1734
|
+
const body = {
|
|
1735
|
+
// string | Sort field (optional)
|
|
1736
|
+
sortBy: sortBy_example,
|
|
1737
|
+
// number | Maximum number of results (optional)
|
|
1738
|
+
maxResults: 8.14,
|
|
1739
|
+
// string | Pagination cursor (optional)
|
|
1740
|
+
nextCursor: nextCursor_example,
|
|
1741
|
+
// string | Search term (optional)
|
|
1742
|
+
term: term_example,
|
|
1743
|
+
// string | Filter by owner type (optional)
|
|
1744
|
+
ownerType: ownerType_example,
|
|
1745
|
+
} satisfies ListCollectionsRequest;
|
|
1746
|
+
|
|
1747
|
+
try {
|
|
1748
|
+
const data = await api.listCollections(body);
|
|
1749
|
+
console.log(data);
|
|
1750
|
+
} catch (error) {
|
|
1751
|
+
console.error(error);
|
|
1752
|
+
}
|
|
1753
|
+
}
|
|
1754
|
+
|
|
1755
|
+
// Run the test
|
|
1756
|
+
example().catch(console.error);
|
|
1757
|
+
```
|
|
1758
|
+
|
|
1759
|
+
### Parameters
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
| Name | Type | Description | Notes |
|
|
1763
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1764
|
+
| **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
|
|
1765
|
+
| **maxResults** | `number` | Maximum number of results | [Optional] [Defaults to `undefined`] |
|
|
1766
|
+
| **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
1767
|
+
| **term** | `string` | Search term | [Optional] [Defaults to `undefined`] |
|
|
1768
|
+
| **ownerType** | `string` | Filter by owner type | [Optional] [Defaults to `undefined`] |
|
|
1769
|
+
|
|
1770
|
+
### Return type
|
|
1771
|
+
|
|
1772
|
+
[**ListCollectionsResponse**](ListCollectionsResponse.md)
|
|
1773
|
+
|
|
1774
|
+
### Authorization
|
|
1775
|
+
|
|
1776
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1777
|
+
|
|
1778
|
+
### HTTP request headers
|
|
1779
|
+
|
|
1780
|
+
- **Content-Type**: Not defined
|
|
1781
|
+
- **Accept**: `application/json`
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
### HTTP response details
|
|
1785
|
+
| Status code | Description | Response headers |
|
|
1786
|
+
|-------------|-------------|------------------|
|
|
1787
|
+
| **200** | Successful operation | - |
|
|
1788
|
+
| **403** | Forbidden | - |
|
|
1789
|
+
|
|
1790
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
## listPortals
|
|
1794
|
+
|
|
1795
|
+
> ListPortalsResponse listPortals()
|
|
1796
|
+
|
|
1797
|
+
List portals
|
|
1798
|
+
|
|
1799
|
+
Returns all portals (branded share pages over collections) defined in the cloud.
|
|
1800
|
+
|
|
1801
|
+
### Example
|
|
1802
|
+
|
|
1803
|
+
```ts
|
|
1804
|
+
import {
|
|
1805
|
+
Configuration,
|
|
1806
|
+
AssetManagementApi,
|
|
1807
|
+
} from '@cloudinary/apps-api';
|
|
1808
|
+
import type { ListPortalsRequest } from '@cloudinary/apps-api';
|
|
1809
|
+
|
|
1810
|
+
async function example() {
|
|
1811
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1812
|
+
const config = new Configuration({
|
|
1813
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1814
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1815
|
+
});
|
|
1816
|
+
const api = new AssetManagementApi(config);
|
|
1817
|
+
|
|
1818
|
+
try {
|
|
1819
|
+
const data = await api.listPortals();
|
|
1820
|
+
console.log(data);
|
|
1821
|
+
} catch (error) {
|
|
1822
|
+
console.error(error);
|
|
1823
|
+
}
|
|
1824
|
+
}
|
|
1825
|
+
|
|
1826
|
+
// Run the test
|
|
1827
|
+
example().catch(console.error);
|
|
1828
|
+
```
|
|
1829
|
+
|
|
1830
|
+
### Parameters
|
|
1831
|
+
|
|
1832
|
+
This endpoint does not need any parameter.
|
|
1833
|
+
|
|
1834
|
+
### Return type
|
|
1835
|
+
|
|
1836
|
+
[**ListPortalsResponse**](ListPortalsResponse.md)
|
|
1837
|
+
|
|
1838
|
+
### Authorization
|
|
1839
|
+
|
|
1840
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1841
|
+
|
|
1842
|
+
### HTTP request headers
|
|
1843
|
+
|
|
1844
|
+
- **Content-Type**: Not defined
|
|
1845
|
+
- **Accept**: `application/json`
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
### HTTP response details
|
|
1849
|
+
| Status code | Description | Response headers |
|
|
1850
|
+
|-------------|-------------|------------------|
|
|
1851
|
+
| **200** | Successful operation | - |
|
|
1852
|
+
| **403** | Forbidden | - |
|
|
1853
|
+
|
|
1854
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
## listPublicLinks
|
|
1858
|
+
|
|
1859
|
+
> ListPublicLinksResponse listPublicLinks(subjectType, subjectId)
|
|
1860
|
+
|
|
1861
|
+
List public links of an entity
|
|
1862
|
+
|
|
1863
|
+
Returns all public share links created for the given entity. subject_type is the entity kind (e.g. collections) and subject_id its external ID.
|
|
1864
|
+
|
|
1865
|
+
### Example
|
|
1866
|
+
|
|
1867
|
+
```ts
|
|
1868
|
+
import {
|
|
1869
|
+
Configuration,
|
|
1870
|
+
AssetManagementApi,
|
|
1871
|
+
} from '@cloudinary/apps-api';
|
|
1872
|
+
import type { ListPublicLinksRequest } from '@cloudinary/apps-api';
|
|
1873
|
+
|
|
1874
|
+
async function example() {
|
|
1875
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1876
|
+
const config = new Configuration({
|
|
1877
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1878
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1879
|
+
});
|
|
1880
|
+
const api = new AssetManagementApi(config);
|
|
1881
|
+
|
|
1882
|
+
const body = {
|
|
1883
|
+
// string | Type of the shared entity (e.g. collections)
|
|
1884
|
+
subjectType: subjectType_example,
|
|
1885
|
+
// string | External ID of the shared entity
|
|
1886
|
+
subjectId: subjectId_example,
|
|
1887
|
+
} satisfies ListPublicLinksRequest;
|
|
1888
|
+
|
|
1889
|
+
try {
|
|
1890
|
+
const data = await api.listPublicLinks(body);
|
|
1891
|
+
console.log(data);
|
|
1892
|
+
} catch (error) {
|
|
1893
|
+
console.error(error);
|
|
1894
|
+
}
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
// Run the test
|
|
1898
|
+
example().catch(console.error);
|
|
1899
|
+
```
|
|
1900
|
+
|
|
1901
|
+
### Parameters
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
| Name | Type | Description | Notes |
|
|
1905
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1906
|
+
| **subjectType** | `string` | Type of the shared entity (e.g. collections) | [Defaults to `undefined`] |
|
|
1907
|
+
| **subjectId** | `string` | External ID of the shared entity | [Defaults to `undefined`] |
|
|
1908
|
+
|
|
1909
|
+
### Return type
|
|
1910
|
+
|
|
1911
|
+
[**ListPublicLinksResponse**](ListPublicLinksResponse.md)
|
|
1912
|
+
|
|
1913
|
+
### Authorization
|
|
1914
|
+
|
|
1915
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1916
|
+
|
|
1917
|
+
### HTTP request headers
|
|
1918
|
+
|
|
1919
|
+
- **Content-Type**: Not defined
|
|
1920
|
+
- **Accept**: `application/json`
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
### HTTP response details
|
|
1924
|
+
| Status code | Description | Response headers |
|
|
1925
|
+
|-------------|-------------|------------------|
|
|
1926
|
+
| **200** | Successful operation | - |
|
|
1927
|
+
| **403** | Forbidden | - |
|
|
1928
|
+
|
|
1929
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
## listRelatedAssets
|
|
1933
|
+
|
|
1934
|
+
> RelatedAssetsResponse listRelatedAssets(resourceType, type, publicId)
|
|
1935
|
+
|
|
1936
|
+
List related assets for an asset
|
|
1937
|
+
|
|
1938
|
+
Returns the list of assets related to a given asset (as configured via Cloudinary\'s Related Assets feature). Identifies the asset by the resource_type/type/public_id triple. Requires OAuth authentication.
|
|
1939
|
+
|
|
1940
|
+
### Example
|
|
1941
|
+
|
|
1942
|
+
```ts
|
|
1943
|
+
import {
|
|
1944
|
+
Configuration,
|
|
1945
|
+
AssetManagementApi,
|
|
1946
|
+
} from '@cloudinary/apps-api';
|
|
1947
|
+
import type { ListRelatedAssetsRequest } from '@cloudinary/apps-api';
|
|
1948
|
+
|
|
1949
|
+
async function example() {
|
|
1950
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1951
|
+
const config = new Configuration({
|
|
1952
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1953
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1954
|
+
});
|
|
1955
|
+
const api = new AssetManagementApi(config);
|
|
1956
|
+
|
|
1957
|
+
const body = {
|
|
1958
|
+
// string | Cloudinary resource type (image, video, raw, audio, …).
|
|
1959
|
+
resourceType: resourceType_example,
|
|
1960
|
+
// string | Cloudinary delivery type (upload, private, authenticated, fetch, …).
|
|
1961
|
+
type: type_example,
|
|
1962
|
+
// string | Asset public_id.
|
|
1963
|
+
publicId: publicId_example,
|
|
1964
|
+
} satisfies ListRelatedAssetsRequest;
|
|
1965
|
+
|
|
1966
|
+
try {
|
|
1967
|
+
const data = await api.listRelatedAssets(body);
|
|
1968
|
+
console.log(data);
|
|
1969
|
+
} catch (error) {
|
|
1970
|
+
console.error(error);
|
|
1971
|
+
}
|
|
1972
|
+
}
|
|
1973
|
+
|
|
1974
|
+
// Run the test
|
|
1975
|
+
example().catch(console.error);
|
|
1976
|
+
```
|
|
1977
|
+
|
|
1978
|
+
### Parameters
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
| Name | Type | Description | Notes |
|
|
1982
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1983
|
+
| **resourceType** | `string` | Cloudinary resource type (image, video, raw, audio, …). | [Defaults to `undefined`] |
|
|
1984
|
+
| **type** | `string` | Cloudinary delivery type (upload, private, authenticated, fetch, …). | [Defaults to `undefined`] |
|
|
1985
|
+
| **publicId** | `string` | Asset public_id. | [Defaults to `undefined`] |
|
|
1986
|
+
|
|
1987
|
+
### Return type
|
|
1988
|
+
|
|
1989
|
+
[**RelatedAssetsResponse**](RelatedAssetsResponse.md)
|
|
1990
|
+
|
|
1991
|
+
### Authorization
|
|
1992
|
+
|
|
1993
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1994
|
+
|
|
1995
|
+
### HTTP request headers
|
|
1996
|
+
|
|
1997
|
+
- **Content-Type**: Not defined
|
|
1998
|
+
- **Accept**: `application/json`
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
### HTTP response details
|
|
2002
|
+
| Status code | Description | Response headers |
|
|
2003
|
+
|-------------|-------------|------------------|
|
|
2004
|
+
| **200** | Successful operation | - |
|
|
2005
|
+
|
|
2006
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
## listSavedSearches
|
|
2010
|
+
|
|
2011
|
+
> ListSavedSearchesResponse listSavedSearches()
|
|
2012
|
+
|
|
2013
|
+
List saved searches
|
|
2014
|
+
|
|
2015
|
+
Returns all saved searches accessible to the caller, including their filters and sharing settings.
|
|
2016
|
+
|
|
2017
|
+
### Example
|
|
2018
|
+
|
|
2019
|
+
```ts
|
|
2020
|
+
import {
|
|
2021
|
+
Configuration,
|
|
2022
|
+
AssetManagementApi,
|
|
2023
|
+
} from '@cloudinary/apps-api';
|
|
2024
|
+
import type { ListSavedSearchesRequest } from '@cloudinary/apps-api';
|
|
2025
|
+
|
|
2026
|
+
async function example() {
|
|
2027
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2028
|
+
const config = new Configuration({
|
|
2029
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2030
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2031
|
+
});
|
|
2032
|
+
const api = new AssetManagementApi(config);
|
|
2033
|
+
|
|
2034
|
+
try {
|
|
2035
|
+
const data = await api.listSavedSearches();
|
|
2036
|
+
console.log(data);
|
|
2037
|
+
} catch (error) {
|
|
2038
|
+
console.error(error);
|
|
2039
|
+
}
|
|
2040
|
+
}
|
|
2041
|
+
|
|
2042
|
+
// Run the test
|
|
2043
|
+
example().catch(console.error);
|
|
2044
|
+
```
|
|
2045
|
+
|
|
2046
|
+
### Parameters
|
|
2047
|
+
|
|
2048
|
+
This endpoint does not need any parameter.
|
|
2049
|
+
|
|
2050
|
+
### Return type
|
|
2051
|
+
|
|
2052
|
+
[**ListSavedSearchesResponse**](ListSavedSearchesResponse.md)
|
|
2053
|
+
|
|
2054
|
+
### Authorization
|
|
2055
|
+
|
|
2056
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2057
|
+
|
|
2058
|
+
### HTTP request headers
|
|
2059
|
+
|
|
2060
|
+
- **Content-Type**: Not defined
|
|
2061
|
+
- **Accept**: `application/json`
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
### HTTP response details
|
|
2065
|
+
| Status code | Description | Response headers |
|
|
2066
|
+
|-------------|-------------|------------------|
|
|
2067
|
+
| **200** | Successful operation | - |
|
|
2068
|
+
| **403** | Forbidden | - |
|
|
2069
|
+
|
|
2070
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
## listSubfolders
|
|
2074
|
+
|
|
2075
|
+
> ListSubfoldersResponse listSubfolders(parentPath, externalId, maxResults, nextCursor)
|
|
2076
|
+
|
|
2077
|
+
List child folders
|
|
2078
|
+
|
|
2079
|
+
Returns immediate subfolders of a given parent path or folder external ID, with pagination support.
|
|
2080
|
+
|
|
2081
|
+
### Example
|
|
2082
|
+
|
|
2083
|
+
```ts
|
|
2084
|
+
import {
|
|
2085
|
+
Configuration,
|
|
2086
|
+
AssetManagementApi,
|
|
2087
|
+
} from '@cloudinary/apps-api';
|
|
2088
|
+
import type { ListSubfoldersRequest } from '@cloudinary/apps-api';
|
|
2089
|
+
|
|
2090
|
+
async function example() {
|
|
2091
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2092
|
+
const config = new Configuration({
|
|
2093
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2094
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2095
|
+
});
|
|
2096
|
+
const api = new AssetManagementApi(config);
|
|
2097
|
+
|
|
2098
|
+
const body = {
|
|
2099
|
+
// string (optional)
|
|
2100
|
+
parentPath: parentPath_example,
|
|
2101
|
+
// string (optional)
|
|
2102
|
+
externalId: externalId_example,
|
|
2103
|
+
// number (optional)
|
|
2104
|
+
maxResults: 56,
|
|
2105
|
+
// string (optional)
|
|
2106
|
+
nextCursor: nextCursor_example,
|
|
2107
|
+
} satisfies ListSubfoldersRequest;
|
|
2108
|
+
|
|
2109
|
+
try {
|
|
2110
|
+
const data = await api.listSubfolders(body);
|
|
2111
|
+
console.log(data);
|
|
2112
|
+
} catch (error) {
|
|
2113
|
+
console.error(error);
|
|
2114
|
+
}
|
|
2115
|
+
}
|
|
2116
|
+
|
|
2117
|
+
// Run the test
|
|
2118
|
+
example().catch(console.error);
|
|
2119
|
+
```
|
|
2120
|
+
|
|
2121
|
+
### Parameters
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
| Name | Type | Description | Notes |
|
|
2125
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2126
|
+
| **parentPath** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2127
|
+
| **externalId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2128
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2129
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `''`] |
|
|
2130
|
+
|
|
2131
|
+
### Return type
|
|
2132
|
+
|
|
2133
|
+
[**ListSubfoldersResponse**](ListSubfoldersResponse.md)
|
|
2134
|
+
|
|
2135
|
+
### Authorization
|
|
2136
|
+
|
|
2137
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2138
|
+
|
|
2139
|
+
### HTTP request headers
|
|
2140
|
+
|
|
2141
|
+
- **Content-Type**: Not defined
|
|
2142
|
+
- **Accept**: `application/json`
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
### HTTP response details
|
|
2146
|
+
| Status code | Description | Response headers |
|
|
2147
|
+
|-------------|-------------|------------------|
|
|
2148
|
+
| **200** | Successful operation | - |
|
|
2149
|
+
|
|
2150
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
## listTransformations
|
|
2154
|
+
|
|
2155
|
+
> ListTransformationsResponse listTransformations(maxResults, nextCursor, name)
|
|
2156
|
+
|
|
2157
|
+
List named transformations
|
|
2158
|
+
|
|
2159
|
+
Returns named transformations defined in the cloud. Supports pagination via next_cursor and optional client-side name filtering.
|
|
2160
|
+
|
|
2161
|
+
### Example
|
|
2162
|
+
|
|
2163
|
+
```ts
|
|
2164
|
+
import {
|
|
2165
|
+
Configuration,
|
|
2166
|
+
AssetManagementApi,
|
|
2167
|
+
} from '@cloudinary/apps-api';
|
|
2168
|
+
import type { ListTransformationsRequest } from '@cloudinary/apps-api';
|
|
2169
|
+
|
|
2170
|
+
async function example() {
|
|
2171
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2172
|
+
const config = new Configuration({
|
|
2173
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2174
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2175
|
+
});
|
|
2176
|
+
const api = new AssetManagementApi(config);
|
|
2177
|
+
|
|
2178
|
+
const body = {
|
|
2179
|
+
// number (optional)
|
|
2180
|
+
maxResults: 56,
|
|
2181
|
+
// string (optional)
|
|
2182
|
+
nextCursor: nextCursor_example,
|
|
2183
|
+
// string (optional)
|
|
2184
|
+
name: name_example,
|
|
2185
|
+
} satisfies ListTransformationsRequest;
|
|
2186
|
+
|
|
2187
|
+
try {
|
|
2188
|
+
const data = await api.listTransformations(body);
|
|
2189
|
+
console.log(data);
|
|
2190
|
+
} catch (error) {
|
|
2191
|
+
console.error(error);
|
|
2192
|
+
}
|
|
2193
|
+
}
|
|
2194
|
+
|
|
2195
|
+
// Run the test
|
|
2196
|
+
example().catch(console.error);
|
|
2197
|
+
```
|
|
2198
|
+
|
|
2199
|
+
### Parameters
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
| Name | Type | Description | Notes |
|
|
2203
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2204
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2205
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2206
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2207
|
+
|
|
2208
|
+
### Return type
|
|
2209
|
+
|
|
2210
|
+
[**ListTransformationsResponse**](ListTransformationsResponse.md)
|
|
2211
|
+
|
|
2212
|
+
### Authorization
|
|
2213
|
+
|
|
2214
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2215
|
+
|
|
2216
|
+
### HTTP request headers
|
|
2217
|
+
|
|
2218
|
+
- **Content-Type**: Not defined
|
|
2219
|
+
- **Accept**: `application/json`
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
### HTTP response details
|
|
2223
|
+
| Status code | Description | Response headers |
|
|
2224
|
+
|-------------|-------------|------------------|
|
|
2225
|
+
| **200** | Successful operation | - |
|
|
2226
|
+
|
|
2227
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
## removeCollectionAssets
|
|
2231
|
+
|
|
2232
|
+
> RemoveCollectionAssetsResponse removeCollectionAssets(collectionId, removeCollectionAssetsRequest)
|
|
2233
|
+
|
|
2234
|
+
Remove assets from a collection
|
|
2235
|
+
|
|
2236
|
+
Removes one or more assets from a collection by resource_ids or external_ids. The assets themselves are not deleted.
|
|
2237
|
+
|
|
2238
|
+
### Example
|
|
2239
|
+
|
|
2240
|
+
```ts
|
|
2241
|
+
import {
|
|
2242
|
+
Configuration,
|
|
2243
|
+
AssetManagementApi,
|
|
2244
|
+
} from '@cloudinary/apps-api';
|
|
2245
|
+
import type { RemoveCollectionAssetsOperationRequest } from '@cloudinary/apps-api';
|
|
2246
|
+
|
|
2247
|
+
async function example() {
|
|
2248
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2249
|
+
const config = new Configuration({
|
|
2250
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2251
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2252
|
+
});
|
|
2253
|
+
const api = new AssetManagementApi(config);
|
|
2254
|
+
|
|
2255
|
+
const body = {
|
|
2256
|
+
// string | Collection external ID
|
|
2257
|
+
collectionId: collectionId_example,
|
|
2258
|
+
// RemoveCollectionAssetsRequest (optional)
|
|
2259
|
+
removeCollectionAssetsRequest: ...,
|
|
2260
|
+
} satisfies RemoveCollectionAssetsOperationRequest;
|
|
2261
|
+
|
|
2262
|
+
try {
|
|
2263
|
+
const data = await api.removeCollectionAssets(body);
|
|
2264
|
+
console.log(data);
|
|
2265
|
+
} catch (error) {
|
|
2266
|
+
console.error(error);
|
|
2267
|
+
}
|
|
2268
|
+
}
|
|
2269
|
+
|
|
2270
|
+
// Run the test
|
|
2271
|
+
example().catch(console.error);
|
|
2272
|
+
```
|
|
2273
|
+
|
|
2274
|
+
### Parameters
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
| Name | Type | Description | Notes |
|
|
2278
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2279
|
+
| **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
|
|
2280
|
+
| **removeCollectionAssetsRequest** | [RemoveCollectionAssetsRequest](RemoveCollectionAssetsRequest.md) | | [Optional] |
|
|
2281
|
+
|
|
2282
|
+
### Return type
|
|
2283
|
+
|
|
2284
|
+
[**RemoveCollectionAssetsResponse**](RemoveCollectionAssetsResponse.md)
|
|
2285
|
+
|
|
2286
|
+
### Authorization
|
|
2287
|
+
|
|
2288
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2289
|
+
|
|
2290
|
+
### HTTP request headers
|
|
2291
|
+
|
|
2292
|
+
- **Content-Type**: `application/json`
|
|
1089
2293
|
- **Accept**: `application/json`
|
|
1090
2294
|
|
|
1091
2295
|
|
|
@@ -1093,17 +2297,18 @@ example().catch(console.error);
|
|
|
1093
2297
|
| Status code | Description | Response headers |
|
|
1094
2298
|
|-------------|-------------|------------------|
|
|
1095
2299
|
| **200** | Successful operation | - |
|
|
2300
|
+
| **403** | Forbidden | - |
|
|
1096
2301
|
|
|
1097
2302
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1098
2303
|
|
|
1099
2304
|
|
|
1100
|
-
##
|
|
2305
|
+
## removePortalCollections
|
|
1101
2306
|
|
|
1102
|
-
>
|
|
2307
|
+
> Portal removePortalCollections(id, removePortalCollectionsRequest)
|
|
1103
2308
|
|
|
1104
|
-
|
|
2309
|
+
Remove collections from a portal
|
|
1105
2310
|
|
|
1106
|
-
|
|
2311
|
+
Removes one or more collections from a portal. The collections themselves are not deleted.
|
|
1107
2312
|
|
|
1108
2313
|
### Example
|
|
1109
2314
|
|
|
@@ -1112,7 +2317,7 @@ import {
|
|
|
1112
2317
|
Configuration,
|
|
1113
2318
|
AssetManagementApi,
|
|
1114
2319
|
} from '@cloudinary/apps-api';
|
|
1115
|
-
import type {
|
|
2320
|
+
import type { RemovePortalCollectionsOperationRequest } from '@cloudinary/apps-api';
|
|
1116
2321
|
|
|
1117
2322
|
async function example() {
|
|
1118
2323
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1123,20 +2328,14 @@ async function example() {
|
|
|
1123
2328
|
const api = new AssetManagementApi(config);
|
|
1124
2329
|
|
|
1125
2330
|
const body = {
|
|
1126
|
-
// string |
|
|
1127
|
-
|
|
1128
|
-
//
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
nextCursor: nextCursor_example,
|
|
1132
|
-
// string | Search term (optional)
|
|
1133
|
-
term: term_example,
|
|
1134
|
-
// string | Filter by owner type (optional)
|
|
1135
|
-
ownerType: ownerType_example,
|
|
1136
|
-
} satisfies ListCollectionsRequest;
|
|
2331
|
+
// string | Portal ID
|
|
2332
|
+
id: id_example,
|
|
2333
|
+
// RemovePortalCollectionsRequest (optional)
|
|
2334
|
+
removePortalCollectionsRequest: ...,
|
|
2335
|
+
} satisfies RemovePortalCollectionsOperationRequest;
|
|
1137
2336
|
|
|
1138
2337
|
try {
|
|
1139
|
-
const data = await api.
|
|
2338
|
+
const data = await api.removePortalCollections(body);
|
|
1140
2339
|
console.log(data);
|
|
1141
2340
|
} catch (error) {
|
|
1142
2341
|
console.error(error);
|
|
@@ -1152,15 +2351,12 @@ example().catch(console.error);
|
|
|
1152
2351
|
|
|
1153
2352
|
| Name | Type | Description | Notes |
|
|
1154
2353
|
|------------- | ------------- | ------------- | -------------|
|
|
1155
|
-
| **
|
|
1156
|
-
| **
|
|
1157
|
-
| **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
1158
|
-
| **term** | `string` | Search term | [Optional] [Defaults to `undefined`] |
|
|
1159
|
-
| **ownerType** | `string` | Filter by owner type | [Optional] [Defaults to `undefined`] |
|
|
2354
|
+
| **id** | `string` | Portal ID | [Defaults to `undefined`] |
|
|
2355
|
+
| **removePortalCollectionsRequest** | [RemovePortalCollectionsRequest](RemovePortalCollectionsRequest.md) | | [Optional] |
|
|
1160
2356
|
|
|
1161
2357
|
### Return type
|
|
1162
2358
|
|
|
1163
|
-
[**
|
|
2359
|
+
[**Portal**](Portal.md)
|
|
1164
2360
|
|
|
1165
2361
|
### Authorization
|
|
1166
2362
|
|
|
@@ -1168,7 +2364,7 @@ example().catch(console.error);
|
|
|
1168
2364
|
|
|
1169
2365
|
### HTTP request headers
|
|
1170
2366
|
|
|
1171
|
-
- **Content-Type**:
|
|
2367
|
+
- **Content-Type**: `application/json`
|
|
1172
2368
|
- **Accept**: `application/json`
|
|
1173
2369
|
|
|
1174
2370
|
|
|
@@ -1181,13 +2377,13 @@ example().catch(console.error);
|
|
|
1181
2377
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1182
2378
|
|
|
1183
2379
|
|
|
1184
|
-
##
|
|
2380
|
+
## searchAssets
|
|
1185
2381
|
|
|
1186
|
-
>
|
|
2382
|
+
> AssetSearchResponse searchAssets(expression, maxResults, nextCursor, sortBy, backend, aggregate)
|
|
1187
2383
|
|
|
1188
|
-
|
|
2384
|
+
Search assets using Cloudinary expression language
|
|
1189
2385
|
|
|
1190
|
-
|
|
2386
|
+
Full-text and field-scoped search over all assets in the cloud. Supports pagination via next_cursor, sort ordering, backend selection (relational, elastic, CLIP), and field aggregations.
|
|
1191
2387
|
|
|
1192
2388
|
### Example
|
|
1193
2389
|
|
|
@@ -1196,7 +2392,7 @@ import {
|
|
|
1196
2392
|
Configuration,
|
|
1197
2393
|
AssetManagementApi,
|
|
1198
2394
|
} from '@cloudinary/apps-api';
|
|
1199
|
-
import type {
|
|
2395
|
+
import type { SearchAssetsRequest } from '@cloudinary/apps-api';
|
|
1200
2396
|
|
|
1201
2397
|
async function example() {
|
|
1202
2398
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1207,18 +2403,22 @@ async function example() {
|
|
|
1207
2403
|
const api = new AssetManagementApi(config);
|
|
1208
2404
|
|
|
1209
2405
|
const body = {
|
|
1210
|
-
// string
|
|
1211
|
-
|
|
1212
|
-
// string (optional)
|
|
1213
|
-
externalId: externalId_example,
|
|
2406
|
+
// string
|
|
2407
|
+
expression: expression_example,
|
|
1214
2408
|
// number (optional)
|
|
1215
2409
|
maxResults: 56,
|
|
1216
2410
|
// string (optional)
|
|
1217
2411
|
nextCursor: nextCursor_example,
|
|
1218
|
-
|
|
2412
|
+
// string (optional)
|
|
2413
|
+
sortBy: sortBy_example,
|
|
2414
|
+
// 'relational' | 'elastic' | 'clip' | 'clip_text' | 'clip_url' (optional)
|
|
2415
|
+
backend: backend_example,
|
|
2416
|
+
// string (optional)
|
|
2417
|
+
aggregate: aggregate_example,
|
|
2418
|
+
} satisfies SearchAssetsRequest;
|
|
1219
2419
|
|
|
1220
2420
|
try {
|
|
1221
|
-
const data = await api.
|
|
2421
|
+
const data = await api.searchAssets(body);
|
|
1222
2422
|
console.log(data);
|
|
1223
2423
|
} catch (error) {
|
|
1224
2424
|
console.error(error);
|
|
@@ -1234,14 +2434,16 @@ example().catch(console.error);
|
|
|
1234
2434
|
|
|
1235
2435
|
| Name | Type | Description | Notes |
|
|
1236
2436
|
|------------- | ------------- | ------------- | -------------|
|
|
1237
|
-
| **
|
|
1238
|
-
| **externalId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2437
|
+
| **expression** | `string` | | [Defaults to `undefined`] |
|
|
1239
2438
|
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1240
|
-
| **nextCursor** | `string` | | [Optional] [Defaults to
|
|
2439
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2440
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2441
|
+
| **backend** | `relational`, `elastic`, `clip`, `clip_text`, `clip_url` | | [Optional] [Defaults to `undefined`] [Enum: relational, elastic, clip, clip_text, clip_url] |
|
|
2442
|
+
| **aggregate** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1241
2443
|
|
|
1242
2444
|
### Return type
|
|
1243
2445
|
|
|
1244
|
-
[**
|
|
2446
|
+
[**AssetSearchResponse**](AssetSearchResponse.md)
|
|
1245
2447
|
|
|
1246
2448
|
### Authorization
|
|
1247
2449
|
|
|
@@ -1261,13 +2463,165 @@ example().catch(console.error);
|
|
|
1261
2463
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1262
2464
|
|
|
1263
2465
|
|
|
1264
|
-
##
|
|
2466
|
+
## searchCollections
|
|
2467
|
+
|
|
2468
|
+
> SearchCollectionsResponse searchCollections(searchCollectionsRequest)
|
|
2469
|
+
|
|
2470
|
+
Search collections
|
|
2471
|
+
|
|
2472
|
+
Search collections by term with configurable sort order, pagination, and owner_type filtering. Query is sent in the request body.
|
|
2473
|
+
|
|
2474
|
+
### Example
|
|
2475
|
+
|
|
2476
|
+
```ts
|
|
2477
|
+
import {
|
|
2478
|
+
Configuration,
|
|
2479
|
+
AssetManagementApi,
|
|
2480
|
+
} from '@cloudinary/apps-api';
|
|
2481
|
+
import type { SearchCollectionsOperationRequest } from '@cloudinary/apps-api';
|
|
2482
|
+
|
|
2483
|
+
async function example() {
|
|
2484
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2485
|
+
const config = new Configuration({
|
|
2486
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2487
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2488
|
+
});
|
|
2489
|
+
const api = new AssetManagementApi(config);
|
|
2490
|
+
|
|
2491
|
+
const body = {
|
|
2492
|
+
// SearchCollectionsRequest (optional)
|
|
2493
|
+
searchCollectionsRequest: ...,
|
|
2494
|
+
} satisfies SearchCollectionsOperationRequest;
|
|
2495
|
+
|
|
2496
|
+
try {
|
|
2497
|
+
const data = await api.searchCollections(body);
|
|
2498
|
+
console.log(data);
|
|
2499
|
+
} catch (error) {
|
|
2500
|
+
console.error(error);
|
|
2501
|
+
}
|
|
2502
|
+
}
|
|
2503
|
+
|
|
2504
|
+
// Run the test
|
|
2505
|
+
example().catch(console.error);
|
|
2506
|
+
```
|
|
2507
|
+
|
|
2508
|
+
### Parameters
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
| Name | Type | Description | Notes |
|
|
2512
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2513
|
+
| **searchCollectionsRequest** | [SearchCollectionsRequest](SearchCollectionsRequest.md) | | [Optional] |
|
|
2514
|
+
|
|
2515
|
+
### Return type
|
|
2516
|
+
|
|
2517
|
+
[**SearchCollectionsResponse**](SearchCollectionsResponse.md)
|
|
2518
|
+
|
|
2519
|
+
### Authorization
|
|
2520
|
+
|
|
2521
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2522
|
+
|
|
2523
|
+
### HTTP request headers
|
|
2524
|
+
|
|
2525
|
+
- **Content-Type**: `application/json`
|
|
2526
|
+
- **Accept**: `application/json`
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
### HTTP response details
|
|
2530
|
+
| Status code | Description | Response headers |
|
|
2531
|
+
|-------------|-------------|------------------|
|
|
2532
|
+
| **200** | Successful operation | - |
|
|
2533
|
+
| **403** | Forbidden | - |
|
|
2534
|
+
|
|
2535
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
## searchTemplates
|
|
2539
|
+
|
|
2540
|
+
> TemplateSearchResponse searchTemplates(publicId, folder, maxResults, nextCursor)
|
|
2541
|
+
|
|
2542
|
+
Search creative automation templates
|
|
2543
|
+
|
|
2544
|
+
List templates in your Cloudinary account. A template combines transformations, variables, and supporting assets (images, fonts, and related resources) into a single reusable creative unit. Templates are typically exported from design tools such as Figma or Photoshop, uploaded to Cloudinary, and consumed by downstream platforms like Braze and Klaviyo for creative automation workflows. Optionally filter by id, folder, or page through results.
|
|
2545
|
+
|
|
2546
|
+
### Example
|
|
2547
|
+
|
|
2548
|
+
```ts
|
|
2549
|
+
import {
|
|
2550
|
+
Configuration,
|
|
2551
|
+
AssetManagementApi,
|
|
2552
|
+
} from '@cloudinary/apps-api';
|
|
2553
|
+
import type { SearchTemplatesRequest } from '@cloudinary/apps-api';
|
|
2554
|
+
|
|
2555
|
+
async function example() {
|
|
2556
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
2557
|
+
const config = new Configuration({
|
|
2558
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2559
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2560
|
+
});
|
|
2561
|
+
const api = new AssetManagementApi(config);
|
|
2562
|
+
|
|
2563
|
+
const body = {
|
|
2564
|
+
// string | Limit results to a specific template id (optional)
|
|
2565
|
+
publicId: publicId_example,
|
|
2566
|
+
// string | Limit results to assets under this folder path (optional)
|
|
2567
|
+
folder: folder_example,
|
|
2568
|
+
// number | Maximum number of results per page (optional)
|
|
2569
|
+
maxResults: 56,
|
|
2570
|
+
// string | Cursor for the next page of results (optional)
|
|
2571
|
+
nextCursor: nextCursor_example,
|
|
2572
|
+
} satisfies SearchTemplatesRequest;
|
|
2573
|
+
|
|
2574
|
+
try {
|
|
2575
|
+
const data = await api.searchTemplates(body);
|
|
2576
|
+
console.log(data);
|
|
2577
|
+
} catch (error) {
|
|
2578
|
+
console.error(error);
|
|
2579
|
+
}
|
|
2580
|
+
}
|
|
2581
|
+
|
|
2582
|
+
// Run the test
|
|
2583
|
+
example().catch(console.error);
|
|
2584
|
+
```
|
|
2585
|
+
|
|
2586
|
+
### Parameters
|
|
2587
|
+
|
|
2588
|
+
|
|
2589
|
+
| Name | Type | Description | Notes |
|
|
2590
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2591
|
+
| **publicId** | `string` | Limit results to a specific template id | [Optional] [Defaults to `undefined`] |
|
|
2592
|
+
| **folder** | `string` | Limit results to assets under this folder path | [Optional] [Defaults to `undefined`] |
|
|
2593
|
+
| **maxResults** | `number` | Maximum number of results per page | [Optional] [Defaults to `undefined`] |
|
|
2594
|
+
| **nextCursor** | `string` | Cursor for the next page of results | [Optional] [Defaults to `undefined`] |
|
|
2595
|
+
|
|
2596
|
+
### Return type
|
|
2597
|
+
|
|
2598
|
+
[**TemplateSearchResponse**](TemplateSearchResponse.md)
|
|
2599
|
+
|
|
2600
|
+
### Authorization
|
|
2601
|
+
|
|
2602
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2603
|
+
|
|
2604
|
+
### HTTP request headers
|
|
2605
|
+
|
|
2606
|
+
- **Content-Type**: Not defined
|
|
2607
|
+
- **Accept**: `application/json`
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
### HTTP response details
|
|
2611
|
+
| Status code | Description | Response headers |
|
|
2612
|
+
|-------------|-------------|------------------|
|
|
2613
|
+
| **200** | Successful operation | - |
|
|
2614
|
+
|
|
2615
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2616
|
+
|
|
2617
|
+
|
|
2618
|
+
## showCollection
|
|
1265
2619
|
|
|
1266
|
-
>
|
|
2620
|
+
> Collection showCollection(collectionId, sortBy, maxResults, nextCursor, withMetadata)
|
|
1267
2621
|
|
|
1268
|
-
|
|
2622
|
+
Get a single collection with its assets
|
|
1269
2623
|
|
|
1270
|
-
Returns
|
|
2624
|
+
Returns collection details and its contained assets. Supports asset pagination (max_results/next_cursor), sorting, and optional metadata inclusion.
|
|
1271
2625
|
|
|
1272
2626
|
### Example
|
|
1273
2627
|
|
|
@@ -1276,7 +2630,7 @@ import {
|
|
|
1276
2630
|
Configuration,
|
|
1277
2631
|
AssetManagementApi,
|
|
1278
2632
|
} from '@cloudinary/apps-api';
|
|
1279
|
-
import type {
|
|
2633
|
+
import type { ShowCollectionRequest } from '@cloudinary/apps-api';
|
|
1280
2634
|
|
|
1281
2635
|
async function example() {
|
|
1282
2636
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1287,16 +2641,20 @@ async function example() {
|
|
|
1287
2641
|
const api = new AssetManagementApi(config);
|
|
1288
2642
|
|
|
1289
2643
|
const body = {
|
|
1290
|
-
//
|
|
1291
|
-
|
|
1292
|
-
// string (optional)
|
|
2644
|
+
// string | Collection external ID
|
|
2645
|
+
collectionId: collectionId_example,
|
|
2646
|
+
// string | Sort field (optional)
|
|
2647
|
+
sortBy: sortBy_example,
|
|
2648
|
+
// number | Maximum number of assets to return (optional)
|
|
2649
|
+
maxResults: 8.14,
|
|
2650
|
+
// string | Pagination cursor (optional)
|
|
1293
2651
|
nextCursor: nextCursor_example,
|
|
1294
|
-
//
|
|
1295
|
-
|
|
1296
|
-
} satisfies
|
|
2652
|
+
// boolean | Include metadata (optional)
|
|
2653
|
+
withMetadata: true,
|
|
2654
|
+
} satisfies ShowCollectionRequest;
|
|
1297
2655
|
|
|
1298
2656
|
try {
|
|
1299
|
-
const data = await api.
|
|
2657
|
+
const data = await api.showCollection(body);
|
|
1300
2658
|
console.log(data);
|
|
1301
2659
|
} catch (error) {
|
|
1302
2660
|
console.error(error);
|
|
@@ -1312,13 +2670,15 @@ example().catch(console.error);
|
|
|
1312
2670
|
|
|
1313
2671
|
| Name | Type | Description | Notes |
|
|
1314
2672
|
|------------- | ------------- | ------------- | -------------|
|
|
1315
|
-
| **
|
|
1316
|
-
| **
|
|
1317
|
-
| **
|
|
2673
|
+
| **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
|
|
2674
|
+
| **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
|
|
2675
|
+
| **maxResults** | `number` | Maximum number of assets to return | [Optional] [Defaults to `undefined`] |
|
|
2676
|
+
| **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
2677
|
+
| **withMetadata** | `boolean` | Include metadata | [Optional] [Defaults to `undefined`] |
|
|
1318
2678
|
|
|
1319
2679
|
### Return type
|
|
1320
2680
|
|
|
1321
|
-
[**
|
|
2681
|
+
[**Collection**](Collection.md)
|
|
1322
2682
|
|
|
1323
2683
|
### Authorization
|
|
1324
2684
|
|
|
@@ -1334,17 +2694,18 @@ example().catch(console.error);
|
|
|
1334
2694
|
| Status code | Description | Response headers |
|
|
1335
2695
|
|-------------|-------------|------------------|
|
|
1336
2696
|
| **200** | Successful operation | - |
|
|
2697
|
+
| **403** | Forbidden | - |
|
|
1337
2698
|
|
|
1338
2699
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1339
2700
|
|
|
1340
2701
|
|
|
1341
|
-
##
|
|
2702
|
+
## showPortal
|
|
1342
2703
|
|
|
1343
|
-
>
|
|
2704
|
+
> Portal showPortal(id)
|
|
1344
2705
|
|
|
1345
|
-
|
|
2706
|
+
Get a portal
|
|
1346
2707
|
|
|
1347
|
-
|
|
2708
|
+
Returns a single portal by ID, including its included collection IDs and appearance settings.
|
|
1348
2709
|
|
|
1349
2710
|
### Example
|
|
1350
2711
|
|
|
@@ -1353,7 +2714,7 @@ import {
|
|
|
1353
2714
|
Configuration,
|
|
1354
2715
|
AssetManagementApi,
|
|
1355
2716
|
} from '@cloudinary/apps-api';
|
|
1356
|
-
import type {
|
|
2717
|
+
import type { ShowPortalRequest } from '@cloudinary/apps-api';
|
|
1357
2718
|
|
|
1358
2719
|
async function example() {
|
|
1359
2720
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1364,14 +2725,12 @@ async function example() {
|
|
|
1364
2725
|
const api = new AssetManagementApi(config);
|
|
1365
2726
|
|
|
1366
2727
|
const body = {
|
|
1367
|
-
// string |
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
removeCollectionAssetsRequest: ...,
|
|
1371
|
-
} satisfies RemoveCollectionAssetsOperationRequest;
|
|
2728
|
+
// string | Portal ID
|
|
2729
|
+
id: id_example,
|
|
2730
|
+
} satisfies ShowPortalRequest;
|
|
1372
2731
|
|
|
1373
2732
|
try {
|
|
1374
|
-
const data = await api.
|
|
2733
|
+
const data = await api.showPortal(body);
|
|
1375
2734
|
console.log(data);
|
|
1376
2735
|
} catch (error) {
|
|
1377
2736
|
console.error(error);
|
|
@@ -1387,12 +2746,11 @@ example().catch(console.error);
|
|
|
1387
2746
|
|
|
1388
2747
|
| Name | Type | Description | Notes |
|
|
1389
2748
|
|------------- | ------------- | ------------- | -------------|
|
|
1390
|
-
| **
|
|
1391
|
-
| **removeCollectionAssetsRequest** | [RemoveCollectionAssetsRequest](RemoveCollectionAssetsRequest.md) | | [Optional] |
|
|
2749
|
+
| **id** | `string` | Portal ID | [Defaults to `undefined`] |
|
|
1392
2750
|
|
|
1393
2751
|
### Return type
|
|
1394
2752
|
|
|
1395
|
-
[**
|
|
2753
|
+
[**Portal**](Portal.md)
|
|
1396
2754
|
|
|
1397
2755
|
### Authorization
|
|
1398
2756
|
|
|
@@ -1400,7 +2758,7 @@ example().catch(console.error);
|
|
|
1400
2758
|
|
|
1401
2759
|
### HTTP request headers
|
|
1402
2760
|
|
|
1403
|
-
- **Content-Type**:
|
|
2761
|
+
- **Content-Type**: Not defined
|
|
1404
2762
|
- **Accept**: `application/json`
|
|
1405
2763
|
|
|
1406
2764
|
|
|
@@ -1413,13 +2771,13 @@ example().catch(console.error);
|
|
|
1413
2771
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1414
2772
|
|
|
1415
2773
|
|
|
1416
|
-
##
|
|
2774
|
+
## showSavedSearch
|
|
1417
2775
|
|
|
1418
|
-
>
|
|
2776
|
+
> SavedSearch showSavedSearch(id)
|
|
1419
2777
|
|
|
1420
|
-
|
|
2778
|
+
Get a saved search
|
|
1421
2779
|
|
|
1422
|
-
|
|
2780
|
+
Returns a single saved search by ID, including its filters and sharing settings.
|
|
1423
2781
|
|
|
1424
2782
|
### Example
|
|
1425
2783
|
|
|
@@ -1428,7 +2786,7 @@ import {
|
|
|
1428
2786
|
Configuration,
|
|
1429
2787
|
AssetManagementApi,
|
|
1430
2788
|
} from '@cloudinary/apps-api';
|
|
1431
|
-
import type {
|
|
2789
|
+
import type { ShowSavedSearchRequest } from '@cloudinary/apps-api';
|
|
1432
2790
|
|
|
1433
2791
|
async function example() {
|
|
1434
2792
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1439,22 +2797,12 @@ async function example() {
|
|
|
1439
2797
|
const api = new AssetManagementApi(config);
|
|
1440
2798
|
|
|
1441
2799
|
const body = {
|
|
1442
|
-
// string
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
maxResults: 56,
|
|
1446
|
-
// string (optional)
|
|
1447
|
-
nextCursor: nextCursor_example,
|
|
1448
|
-
// string (optional)
|
|
1449
|
-
sortBy: sortBy_example,
|
|
1450
|
-
// 'relational' | 'elastic' | 'clip' | 'clip_text' | 'clip_url' (optional)
|
|
1451
|
-
backend: backend_example,
|
|
1452
|
-
// string (optional)
|
|
1453
|
-
aggregate: aggregate_example,
|
|
1454
|
-
} satisfies SearchAssetsRequest;
|
|
2800
|
+
// string | Saved search ID
|
|
2801
|
+
id: id_example,
|
|
2802
|
+
} satisfies ShowSavedSearchRequest;
|
|
1455
2803
|
|
|
1456
2804
|
try {
|
|
1457
|
-
const data = await api.
|
|
2805
|
+
const data = await api.showSavedSearch(body);
|
|
1458
2806
|
console.log(data);
|
|
1459
2807
|
} catch (error) {
|
|
1460
2808
|
console.error(error);
|
|
@@ -1470,16 +2818,11 @@ example().catch(console.error);
|
|
|
1470
2818
|
|
|
1471
2819
|
| Name | Type | Description | Notes |
|
|
1472
2820
|
|------------- | ------------- | ------------- | -------------|
|
|
1473
|
-
| **
|
|
1474
|
-
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1475
|
-
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1476
|
-
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1477
|
-
| **backend** | `relational`, `elastic`, `clip`, `clip_text`, `clip_url` | | [Optional] [Defaults to `undefined`] [Enum: relational, elastic, clip, clip_text, clip_url] |
|
|
1478
|
-
| **aggregate** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2821
|
+
| **id** | `string` | Saved search ID | [Defaults to `undefined`] |
|
|
1479
2822
|
|
|
1480
2823
|
### Return type
|
|
1481
2824
|
|
|
1482
|
-
[**
|
|
2825
|
+
[**SavedSearch**](SavedSearch.md)
|
|
1483
2826
|
|
|
1484
2827
|
### Authorization
|
|
1485
2828
|
|
|
@@ -1495,17 +2838,18 @@ example().catch(console.error);
|
|
|
1495
2838
|
| Status code | Description | Response headers |
|
|
1496
2839
|
|-------------|-------------|------------------|
|
|
1497
2840
|
| **200** | Successful operation | - |
|
|
2841
|
+
| **403** | Forbidden | - |
|
|
1498
2842
|
|
|
1499
2843
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1500
2844
|
|
|
1501
2845
|
|
|
1502
|
-
##
|
|
2846
|
+
## updateAssetBackreferences
|
|
1503
2847
|
|
|
1504
|
-
>
|
|
2848
|
+
> UpdateBackreferencesResponse updateAssetBackreferences(updateAssetBackreferencesRequest)
|
|
1505
2849
|
|
|
1506
|
-
|
|
2850
|
+
Create, update, or remove asset backreferences
|
|
1507
2851
|
|
|
1508
|
-
|
|
2852
|
+
Links or unlinks one or more assets to/from a location in an external system (e.g. a CMS page or design file). Each backreference is stored as versioned history in the asset\'s cld_backreference context.
|
|
1509
2853
|
|
|
1510
2854
|
### Example
|
|
1511
2855
|
|
|
@@ -1514,7 +2858,7 @@ import {
|
|
|
1514
2858
|
Configuration,
|
|
1515
2859
|
AssetManagementApi,
|
|
1516
2860
|
} from '@cloudinary/apps-api';
|
|
1517
|
-
import type {
|
|
2861
|
+
import type { UpdateAssetBackreferencesOperationRequest } from '@cloudinary/apps-api';
|
|
1518
2862
|
|
|
1519
2863
|
async function example() {
|
|
1520
2864
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1525,12 +2869,12 @@ async function example() {
|
|
|
1525
2869
|
const api = new AssetManagementApi(config);
|
|
1526
2870
|
|
|
1527
2871
|
const body = {
|
|
1528
|
-
//
|
|
1529
|
-
|
|
1530
|
-
} satisfies
|
|
2872
|
+
// UpdateAssetBackreferencesRequest (optional)
|
|
2873
|
+
updateAssetBackreferencesRequest: ...,
|
|
2874
|
+
} satisfies UpdateAssetBackreferencesOperationRequest;
|
|
1531
2875
|
|
|
1532
2876
|
try {
|
|
1533
|
-
const data = await api.
|
|
2877
|
+
const data = await api.updateAssetBackreferences(body);
|
|
1534
2878
|
console.log(data);
|
|
1535
2879
|
} catch (error) {
|
|
1536
2880
|
console.error(error);
|
|
@@ -1546,11 +2890,11 @@ example().catch(console.error);
|
|
|
1546
2890
|
|
|
1547
2891
|
| Name | Type | Description | Notes |
|
|
1548
2892
|
|------------- | ------------- | ------------- | -------------|
|
|
1549
|
-
| **
|
|
2893
|
+
| **updateAssetBackreferencesRequest** | [UpdateAssetBackreferencesRequest](UpdateAssetBackreferencesRequest.md) | | [Optional] |
|
|
1550
2894
|
|
|
1551
2895
|
### Return type
|
|
1552
2896
|
|
|
1553
|
-
[**
|
|
2897
|
+
[**UpdateBackreferencesResponse**](UpdateBackreferencesResponse.md)
|
|
1554
2898
|
|
|
1555
2899
|
### Authorization
|
|
1556
2900
|
|
|
@@ -1566,18 +2910,19 @@ example().catch(console.error);
|
|
|
1566
2910
|
| Status code | Description | Response headers |
|
|
1567
2911
|
|-------------|-------------|------------------|
|
|
1568
2912
|
| **200** | Successful operation | - |
|
|
1569
|
-
| **
|
|
2913
|
+
| **400** | Bad request - invalid location or parameters | - |
|
|
2914
|
+
| **404** | Asset not found | - |
|
|
1570
2915
|
|
|
1571
2916
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1572
2917
|
|
|
1573
2918
|
|
|
1574
|
-
##
|
|
2919
|
+
## updateAssetMetadata
|
|
1575
2920
|
|
|
1576
|
-
>
|
|
2921
|
+
> UpdateAssetMetadataResponse updateAssetMetadata(updateAssetMetadataRequest)
|
|
1577
2922
|
|
|
1578
|
-
|
|
2923
|
+
Update asset contextual and structured metadata
|
|
1579
2924
|
|
|
1580
|
-
|
|
2925
|
+
Patches contextual key-value metadata and/or structured metadata fields on an asset identified by its external ID. Context fields are merged with existing values; structured metadata fields are set directly.
|
|
1581
2926
|
|
|
1582
2927
|
### Example
|
|
1583
2928
|
|
|
@@ -1586,7 +2931,7 @@ import {
|
|
|
1586
2931
|
Configuration,
|
|
1587
2932
|
AssetManagementApi,
|
|
1588
2933
|
} from '@cloudinary/apps-api';
|
|
1589
|
-
import type {
|
|
2934
|
+
import type { UpdateAssetMetadataOperationRequest } from '@cloudinary/apps-api';
|
|
1590
2935
|
|
|
1591
2936
|
async function example() {
|
|
1592
2937
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1597,18 +2942,12 @@ async function example() {
|
|
|
1597
2942
|
const api = new AssetManagementApi(config);
|
|
1598
2943
|
|
|
1599
2944
|
const body = {
|
|
1600
|
-
//
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
folder: folder_example,
|
|
1604
|
-
// number | Maximum number of results per page (optional)
|
|
1605
|
-
maxResults: 56,
|
|
1606
|
-
// string | Cursor for the next page of results (optional)
|
|
1607
|
-
nextCursor: nextCursor_example,
|
|
1608
|
-
} satisfies SearchTemplatesRequest;
|
|
2945
|
+
// UpdateAssetMetadataRequest (optional)
|
|
2946
|
+
updateAssetMetadataRequest: ...,
|
|
2947
|
+
} satisfies UpdateAssetMetadataOperationRequest;
|
|
1609
2948
|
|
|
1610
2949
|
try {
|
|
1611
|
-
const data = await api.
|
|
2950
|
+
const data = await api.updateAssetMetadata(body);
|
|
1612
2951
|
console.log(data);
|
|
1613
2952
|
} catch (error) {
|
|
1614
2953
|
console.error(error);
|
|
@@ -1624,14 +2963,11 @@ example().catch(console.error);
|
|
|
1624
2963
|
|
|
1625
2964
|
| Name | Type | Description | Notes |
|
|
1626
2965
|
|------------- | ------------- | ------------- | -------------|
|
|
1627
|
-
| **
|
|
1628
|
-
| **folder** | `string` | Limit results to assets under this folder path | [Optional] [Defaults to `undefined`] |
|
|
1629
|
-
| **maxResults** | `number` | Maximum number of results per page | [Optional] [Defaults to `undefined`] |
|
|
1630
|
-
| **nextCursor** | `string` | Cursor for the next page of results | [Optional] [Defaults to `undefined`] |
|
|
2966
|
+
| **updateAssetMetadataRequest** | [UpdateAssetMetadataRequest](UpdateAssetMetadataRequest.md) | | [Optional] |
|
|
1631
2967
|
|
|
1632
2968
|
### Return type
|
|
1633
2969
|
|
|
1634
|
-
[**
|
|
2970
|
+
[**UpdateAssetMetadataResponse**](UpdateAssetMetadataResponse.md)
|
|
1635
2971
|
|
|
1636
2972
|
### Authorization
|
|
1637
2973
|
|
|
@@ -1639,7 +2975,7 @@ example().catch(console.error);
|
|
|
1639
2975
|
|
|
1640
2976
|
### HTTP request headers
|
|
1641
2977
|
|
|
1642
|
-
- **Content-Type**:
|
|
2978
|
+
- **Content-Type**: `application/json`
|
|
1643
2979
|
- **Accept**: `application/json`
|
|
1644
2980
|
|
|
1645
2981
|
|
|
@@ -1651,13 +2987,13 @@ example().catch(console.error);
|
|
|
1651
2987
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1652
2988
|
|
|
1653
2989
|
|
|
1654
|
-
##
|
|
2990
|
+
## updateAssetTags
|
|
1655
2991
|
|
|
1656
|
-
>
|
|
2992
|
+
> UpdateAssetTagsResponse updateAssetTags(resourceType, updateAssetTagsRequest)
|
|
1657
2993
|
|
|
1658
|
-
|
|
2994
|
+
Add or remove a tag on assets
|
|
1659
2995
|
|
|
1660
|
-
|
|
2996
|
+
Adds or removes a single tag from one or more assets identified by public_id. The command field controls whether the tag is added or removed. Requires OAuth authentication.
|
|
1661
2997
|
|
|
1662
2998
|
### Example
|
|
1663
2999
|
|
|
@@ -1666,7 +3002,7 @@ import {
|
|
|
1666
3002
|
Configuration,
|
|
1667
3003
|
AssetManagementApi,
|
|
1668
3004
|
} from '@cloudinary/apps-api';
|
|
1669
|
-
import type {
|
|
3005
|
+
import type { UpdateAssetTagsOperationRequest } from '@cloudinary/apps-api';
|
|
1670
3006
|
|
|
1671
3007
|
async function example() {
|
|
1672
3008
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1677,20 +3013,14 @@ async function example() {
|
|
|
1677
3013
|
const api = new AssetManagementApi(config);
|
|
1678
3014
|
|
|
1679
3015
|
const body = {
|
|
1680
|
-
// string |
|
|
1681
|
-
|
|
1682
|
-
//
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
maxResults: 8.14,
|
|
1686
|
-
// string | Pagination cursor (optional)
|
|
1687
|
-
nextCursor: nextCursor_example,
|
|
1688
|
-
// boolean | Include metadata (optional)
|
|
1689
|
-
withMetadata: true,
|
|
1690
|
-
} satisfies ShowCollectionRequest;
|
|
3016
|
+
// string | The resource type (e.g., image, video, raw)
|
|
3017
|
+
resourceType: resourceType_example,
|
|
3018
|
+
// UpdateAssetTagsRequest (optional)
|
|
3019
|
+
updateAssetTagsRequest: ...,
|
|
3020
|
+
} satisfies UpdateAssetTagsOperationRequest;
|
|
1691
3021
|
|
|
1692
3022
|
try {
|
|
1693
|
-
const data = await api.
|
|
3023
|
+
const data = await api.updateAssetTags(body);
|
|
1694
3024
|
console.log(data);
|
|
1695
3025
|
} catch (error) {
|
|
1696
3026
|
console.error(error);
|
|
@@ -1706,15 +3036,12 @@ example().catch(console.error);
|
|
|
1706
3036
|
|
|
1707
3037
|
| Name | Type | Description | Notes |
|
|
1708
3038
|
|------------- | ------------- | ------------- | -------------|
|
|
1709
|
-
| **
|
|
1710
|
-
| **
|
|
1711
|
-
| **maxResults** | `number` | Maximum number of assets to return | [Optional] [Defaults to `undefined`] |
|
|
1712
|
-
| **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
|
|
1713
|
-
| **withMetadata** | `boolean` | Include metadata | [Optional] [Defaults to `undefined`] |
|
|
3039
|
+
| **resourceType** | `string` | The resource type (e.g., image, video, raw) | [Defaults to `undefined`] |
|
|
3040
|
+
| **updateAssetTagsRequest** | [UpdateAssetTagsRequest](UpdateAssetTagsRequest.md) | | [Optional] |
|
|
1714
3041
|
|
|
1715
3042
|
### Return type
|
|
1716
3043
|
|
|
1717
|
-
[**
|
|
3044
|
+
[**UpdateAssetTagsResponse**](UpdateAssetTagsResponse.md)
|
|
1718
3045
|
|
|
1719
3046
|
### Authorization
|
|
1720
3047
|
|
|
@@ -1722,26 +3049,25 @@ example().catch(console.error);
|
|
|
1722
3049
|
|
|
1723
3050
|
### HTTP request headers
|
|
1724
3051
|
|
|
1725
|
-
- **Content-Type**:
|
|
3052
|
+
- **Content-Type**: `application/json`
|
|
1726
3053
|
- **Accept**: `application/json`
|
|
1727
3054
|
|
|
1728
3055
|
|
|
1729
3056
|
### HTTP response details
|
|
1730
3057
|
| Status code | Description | Response headers |
|
|
1731
3058
|
|-------------|-------------|------------------|
|
|
1732
|
-
| **200** |
|
|
1733
|
-
| **403** | Forbidden | - |
|
|
3059
|
+
| **200** | Tag added successfully | - |
|
|
1734
3060
|
|
|
1735
3061
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1736
3062
|
|
|
1737
3063
|
|
|
1738
|
-
##
|
|
3064
|
+
## updateCollection
|
|
1739
3065
|
|
|
1740
|
-
>
|
|
3066
|
+
> UpdateCollectionResponse updateCollection(collectionId, updateCollectionRequest)
|
|
1741
3067
|
|
|
1742
|
-
|
|
3068
|
+
Update a collection
|
|
1743
3069
|
|
|
1744
|
-
|
|
3070
|
+
Updates collection properties such as name, description, or dynamic_filters. Caller must have write access.
|
|
1745
3071
|
|
|
1746
3072
|
### Example
|
|
1747
3073
|
|
|
@@ -1750,7 +3076,7 @@ import {
|
|
|
1750
3076
|
Configuration,
|
|
1751
3077
|
AssetManagementApi,
|
|
1752
3078
|
} from '@cloudinary/apps-api';
|
|
1753
|
-
import type {
|
|
3079
|
+
import type { UpdateCollectionOperationRequest } from '@cloudinary/apps-api';
|
|
1754
3080
|
|
|
1755
3081
|
async function example() {
|
|
1756
3082
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1761,12 +3087,14 @@ async function example() {
|
|
|
1761
3087
|
const api = new AssetManagementApi(config);
|
|
1762
3088
|
|
|
1763
3089
|
const body = {
|
|
1764
|
-
//
|
|
1765
|
-
|
|
1766
|
-
|
|
3090
|
+
// string | Collection external ID
|
|
3091
|
+
collectionId: collectionId_example,
|
|
3092
|
+
// UpdateCollectionRequest (optional)
|
|
3093
|
+
updateCollectionRequest: ...,
|
|
3094
|
+
} satisfies UpdateCollectionOperationRequest;
|
|
1767
3095
|
|
|
1768
3096
|
try {
|
|
1769
|
-
const data = await api.
|
|
3097
|
+
const data = await api.updateCollection(body);
|
|
1770
3098
|
console.log(data);
|
|
1771
3099
|
} catch (error) {
|
|
1772
3100
|
console.error(error);
|
|
@@ -1782,11 +3110,12 @@ example().catch(console.error);
|
|
|
1782
3110
|
|
|
1783
3111
|
| Name | Type | Description | Notes |
|
|
1784
3112
|
|------------- | ------------- | ------------- | -------------|
|
|
1785
|
-
| **
|
|
3113
|
+
| **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
|
|
3114
|
+
| **updateCollectionRequest** | [UpdateCollectionRequest](UpdateCollectionRequest.md) | | [Optional] |
|
|
1786
3115
|
|
|
1787
3116
|
### Return type
|
|
1788
3117
|
|
|
1789
|
-
[**
|
|
3118
|
+
[**UpdateCollectionResponse**](UpdateCollectionResponse.md)
|
|
1790
3119
|
|
|
1791
3120
|
### Authorization
|
|
1792
3121
|
|
|
@@ -1802,19 +3131,18 @@ example().catch(console.error);
|
|
|
1802
3131
|
| Status code | Description | Response headers |
|
|
1803
3132
|
|-------------|-------------|------------------|
|
|
1804
3133
|
| **200** | Successful operation | - |
|
|
1805
|
-
| **
|
|
1806
|
-
| **404** | Asset not found | - |
|
|
3134
|
+
| **403** | Forbidden | - |
|
|
1807
3135
|
|
|
1808
3136
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1809
3137
|
|
|
1810
3138
|
|
|
1811
|
-
##
|
|
3139
|
+
## updatePortal
|
|
1812
3140
|
|
|
1813
|
-
>
|
|
3141
|
+
> Portal updatePortal(id, updatePortalRequest)
|
|
1814
3142
|
|
|
1815
|
-
Update
|
|
3143
|
+
Update a portal
|
|
1816
3144
|
|
|
1817
|
-
|
|
3145
|
+
Updates portal properties such as title, privacy, status, theme, or the full set of included collections.
|
|
1818
3146
|
|
|
1819
3147
|
### Example
|
|
1820
3148
|
|
|
@@ -1823,7 +3151,7 @@ import {
|
|
|
1823
3151
|
Configuration,
|
|
1824
3152
|
AssetManagementApi,
|
|
1825
3153
|
} from '@cloudinary/apps-api';
|
|
1826
|
-
import type {
|
|
3154
|
+
import type { UpdatePortalOperationRequest } from '@cloudinary/apps-api';
|
|
1827
3155
|
|
|
1828
3156
|
async function example() {
|
|
1829
3157
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1834,12 +3162,14 @@ async function example() {
|
|
|
1834
3162
|
const api = new AssetManagementApi(config);
|
|
1835
3163
|
|
|
1836
3164
|
const body = {
|
|
1837
|
-
//
|
|
1838
|
-
|
|
1839
|
-
|
|
3165
|
+
// string | Portal ID
|
|
3166
|
+
id: id_example,
|
|
3167
|
+
// UpdatePortalRequest (optional)
|
|
3168
|
+
updatePortalRequest: ...,
|
|
3169
|
+
} satisfies UpdatePortalOperationRequest;
|
|
1840
3170
|
|
|
1841
3171
|
try {
|
|
1842
|
-
const data = await api.
|
|
3172
|
+
const data = await api.updatePortal(body);
|
|
1843
3173
|
console.log(data);
|
|
1844
3174
|
} catch (error) {
|
|
1845
3175
|
console.error(error);
|
|
@@ -1855,11 +3185,12 @@ example().catch(console.error);
|
|
|
1855
3185
|
|
|
1856
3186
|
| Name | Type | Description | Notes |
|
|
1857
3187
|
|------------- | ------------- | ------------- | -------------|
|
|
1858
|
-
| **
|
|
3188
|
+
| **id** | `string` | Portal ID | [Defaults to `undefined`] |
|
|
3189
|
+
| **updatePortalRequest** | [UpdatePortalRequest](UpdatePortalRequest.md) | | [Optional] |
|
|
1859
3190
|
|
|
1860
3191
|
### Return type
|
|
1861
3192
|
|
|
1862
|
-
[**
|
|
3193
|
+
[**Portal**](Portal.md)
|
|
1863
3194
|
|
|
1864
3195
|
### Authorization
|
|
1865
3196
|
|
|
@@ -1875,17 +3206,18 @@ example().catch(console.error);
|
|
|
1875
3206
|
| Status code | Description | Response headers |
|
|
1876
3207
|
|-------------|-------------|------------------|
|
|
1877
3208
|
| **200** | Successful operation | - |
|
|
3209
|
+
| **403** | Forbidden | - |
|
|
1878
3210
|
|
|
1879
3211
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1880
3212
|
|
|
1881
3213
|
|
|
1882
|
-
##
|
|
3214
|
+
## updatePublicLink
|
|
1883
3215
|
|
|
1884
|
-
>
|
|
3216
|
+
> PublicLinkResponse updatePublicLink(subjectType, subjectId, id, updatePublicLinkRequest)
|
|
1885
3217
|
|
|
1886
|
-
|
|
3218
|
+
Update a public link
|
|
1887
3219
|
|
|
1888
|
-
|
|
3220
|
+
Updates a public link\'s name, validity window (start_at/end_at), or original-download policy.
|
|
1889
3221
|
|
|
1890
3222
|
### Example
|
|
1891
3223
|
|
|
@@ -1894,7 +3226,7 @@ import {
|
|
|
1894
3226
|
Configuration,
|
|
1895
3227
|
AssetManagementApi,
|
|
1896
3228
|
} from '@cloudinary/apps-api';
|
|
1897
|
-
import type {
|
|
3229
|
+
import type { UpdatePublicLinkOperationRequest } from '@cloudinary/apps-api';
|
|
1898
3230
|
|
|
1899
3231
|
async function example() {
|
|
1900
3232
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1905,14 +3237,18 @@ async function example() {
|
|
|
1905
3237
|
const api = new AssetManagementApi(config);
|
|
1906
3238
|
|
|
1907
3239
|
const body = {
|
|
1908
|
-
// string |
|
|
1909
|
-
|
|
1910
|
-
//
|
|
1911
|
-
|
|
1912
|
-
|
|
3240
|
+
// string | Type of the shared entity (e.g. collections)
|
|
3241
|
+
subjectType: subjectType_example,
|
|
3242
|
+
// string | External ID of the shared entity
|
|
3243
|
+
subjectId: subjectId_example,
|
|
3244
|
+
// string | Public link ID
|
|
3245
|
+
id: id_example,
|
|
3246
|
+
// UpdatePublicLinkRequest (optional)
|
|
3247
|
+
updatePublicLinkRequest: ...,
|
|
3248
|
+
} satisfies UpdatePublicLinkOperationRequest;
|
|
1913
3249
|
|
|
1914
3250
|
try {
|
|
1915
|
-
const data = await api.
|
|
3251
|
+
const data = await api.updatePublicLink(body);
|
|
1916
3252
|
console.log(data);
|
|
1917
3253
|
} catch (error) {
|
|
1918
3254
|
console.error(error);
|
|
@@ -1928,12 +3264,14 @@ example().catch(console.error);
|
|
|
1928
3264
|
|
|
1929
3265
|
| Name | Type | Description | Notes |
|
|
1930
3266
|
|------------- | ------------- | ------------- | -------------|
|
|
1931
|
-
| **
|
|
1932
|
-
| **
|
|
3267
|
+
| **subjectType** | `string` | Type of the shared entity (e.g. collections) | [Defaults to `undefined`] |
|
|
3268
|
+
| **subjectId** | `string` | External ID of the shared entity | [Defaults to `undefined`] |
|
|
3269
|
+
| **id** | `string` | Public link ID | [Defaults to `undefined`] |
|
|
3270
|
+
| **updatePublicLinkRequest** | [UpdatePublicLinkRequest](UpdatePublicLinkRequest.md) | | [Optional] |
|
|
1933
3271
|
|
|
1934
3272
|
### Return type
|
|
1935
3273
|
|
|
1936
|
-
[**
|
|
3274
|
+
[**PublicLinkResponse**](PublicLinkResponse.md)
|
|
1937
3275
|
|
|
1938
3276
|
### Authorization
|
|
1939
3277
|
|
|
@@ -1948,18 +3286,19 @@ example().catch(console.error);
|
|
|
1948
3286
|
### HTTP response details
|
|
1949
3287
|
| Status code | Description | Response headers |
|
|
1950
3288
|
|-------------|-------------|------------------|
|
|
1951
|
-
| **200** |
|
|
3289
|
+
| **200** | Successful operation | - |
|
|
3290
|
+
| **403** | Forbidden | - |
|
|
1952
3291
|
|
|
1953
3292
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1954
3293
|
|
|
1955
3294
|
|
|
1956
|
-
##
|
|
3295
|
+
## updateSavedSearch
|
|
1957
3296
|
|
|
1958
|
-
>
|
|
3297
|
+
> UpdateSavedSearchResponse updateSavedSearch(id, createSavedSearchRequest)
|
|
1959
3298
|
|
|
1960
|
-
Update a
|
|
3299
|
+
Update a saved search
|
|
1961
3300
|
|
|
1962
|
-
Updates
|
|
3301
|
+
Updates a saved search\'s name, filters, query type, or sharing. Caller must have permission on the saved search.
|
|
1963
3302
|
|
|
1964
3303
|
### Example
|
|
1965
3304
|
|
|
@@ -1968,7 +3307,7 @@ import {
|
|
|
1968
3307
|
Configuration,
|
|
1969
3308
|
AssetManagementApi,
|
|
1970
3309
|
} from '@cloudinary/apps-api';
|
|
1971
|
-
import type {
|
|
3310
|
+
import type { UpdateSavedSearchRequest } from '@cloudinary/apps-api';
|
|
1972
3311
|
|
|
1973
3312
|
async function example() {
|
|
1974
3313
|
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
@@ -1979,14 +3318,14 @@ async function example() {
|
|
|
1979
3318
|
const api = new AssetManagementApi(config);
|
|
1980
3319
|
|
|
1981
3320
|
const body = {
|
|
1982
|
-
// string |
|
|
1983
|
-
|
|
1984
|
-
//
|
|
1985
|
-
|
|
1986
|
-
} satisfies
|
|
3321
|
+
// string | Saved search ID
|
|
3322
|
+
id: id_example,
|
|
3323
|
+
// CreateSavedSearchRequest (optional)
|
|
3324
|
+
createSavedSearchRequest: ...,
|
|
3325
|
+
} satisfies UpdateSavedSearchRequest;
|
|
1987
3326
|
|
|
1988
3327
|
try {
|
|
1989
|
-
const data = await api.
|
|
3328
|
+
const data = await api.updateSavedSearch(body);
|
|
1990
3329
|
console.log(data);
|
|
1991
3330
|
} catch (error) {
|
|
1992
3331
|
console.error(error);
|
|
@@ -2002,12 +3341,12 @@ example().catch(console.error);
|
|
|
2002
3341
|
|
|
2003
3342
|
| Name | Type | Description | Notes |
|
|
2004
3343
|
|------------- | ------------- | ------------- | -------------|
|
|
2005
|
-
| **
|
|
2006
|
-
| **
|
|
3344
|
+
| **id** | `string` | Saved search ID | [Defaults to `undefined`] |
|
|
3345
|
+
| **createSavedSearchRequest** | [CreateSavedSearchRequest](CreateSavedSearchRequest.md) | | [Optional] |
|
|
2007
3346
|
|
|
2008
3347
|
### Return type
|
|
2009
3348
|
|
|
2010
|
-
[**
|
|
3349
|
+
[**UpdateSavedSearchResponse**](UpdateSavedSearchResponse.md)
|
|
2011
3350
|
|
|
2012
3351
|
### Authorization
|
|
2013
3352
|
|