@cloudinary/apps-api 2.2605.49
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 +277 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +325 -0
- package/dist/apis/AssetManagementApi.d.ts +436 -0
- package/dist/apis/AssetManagementApi.js +1199 -0
- package/dist/apis/ConsoleApi.d.ts +412 -0
- package/dist/apis/ConsoleApi.js +1028 -0
- package/dist/apis/MediaApi.d.ts +229 -0
- package/dist/apis/MediaApi.js +606 -0
- package/dist/apis/PlatformApi.d.ts +206 -0
- package/dist/apis/PlatformApi.js +571 -0
- package/dist/apis/UploadApi.d.ts +64 -0
- package/dist/apis/UploadApi.js +198 -0
- package/dist/apis/UtilsApi.d.ts +194 -0
- package/dist/apis/UtilsApi.js +461 -0
- package/dist/apis/index.d.ts +6 -0
- package/dist/apis/index.js +24 -0
- package/dist/esm/apis/AssetManagementApi.d.ts +436 -0
- package/dist/esm/apis/AssetManagementApi.js +1195 -0
- package/dist/esm/apis/ConsoleApi.d.ts +412 -0
- package/dist/esm/apis/ConsoleApi.js +1024 -0
- package/dist/esm/apis/MediaApi.d.ts +229 -0
- package/dist/esm/apis/MediaApi.js +602 -0
- package/dist/esm/apis/PlatformApi.d.ts +206 -0
- package/dist/esm/apis/PlatformApi.js +567 -0
- package/dist/esm/apis/UploadApi.d.ts +64 -0
- package/dist/esm/apis/UploadApi.js +194 -0
- package/dist/esm/apis/UtilsApi.d.ts +194 -0
- package/dist/esm/apis/UtilsApi.js +457 -0
- package/dist/esm/apis/index.d.ts +6 -0
- package/dist/esm/apis/index.js +8 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/AddCollectionAssetsRequest.d.ts +38 -0
- package/dist/esm/models/AddCollectionAssetsRequest.js +43 -0
- package/dist/esm/models/AddCollectionAssetsResponse.d.ts +33 -0
- package/dist/esm/models/AddCollectionAssetsResponse.js +44 -0
- package/dist/esm/models/AiVisionGeneralResponse.d.ts +32 -0
- package/dist/esm/models/AiVisionGeneralResponse.js +41 -0
- package/dist/esm/models/AnalyticsResponse.d.ts +32 -0
- package/dist/esm/models/AnalyticsResponse.js +43 -0
- package/dist/esm/models/AnalyzeAiVisionGeneralRequest.d.ts +51 -0
- package/dist/esm/models/AnalyzeAiVisionGeneralRequest.js +52 -0
- package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.d.ts +38 -0
- package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.js +43 -0
- package/dist/esm/models/AppStorageErrorResponse.d.ts +32 -0
- package/dist/esm/models/AppStorageErrorResponse.js +43 -0
- package/dist/esm/models/AppStorageGetResponse.d.ts +38 -0
- package/dist/esm/models/AppStorageGetResponse.js +45 -0
- package/dist/esm/models/AppStorageSetErrorResponse.d.ts +32 -0
- package/dist/esm/models/AppStorageSetErrorResponse.js +43 -0
- package/dist/esm/models/AppStorageSetResponse.d.ts +38 -0
- package/dist/esm/models/AppStorageSetResponse.js +45 -0
- package/dist/esm/models/Asset.d.ts +134 -0
- package/dist/esm/models/Asset.js +83 -0
- package/dist/esm/models/AssetHistoryResponse.d.ts +39 -0
- package/dist/esm/models/AssetHistoryResponse.js +44 -0
- package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.d.ts +67 -0
- package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.js +63 -0
- package/dist/esm/models/AssetSearchResponse.d.ts +76 -0
- package/dist/esm/models/AssetSearchResponse.js +71 -0
- package/dist/esm/models/AuthCredentialsResponse.d.ts +40 -0
- package/dist/esm/models/AuthCredentialsResponse.js +49 -0
- package/dist/esm/models/AuthCustomer.d.ts +80 -0
- package/dist/esm/models/AuthCustomer.js +73 -0
- package/dist/esm/models/AuthUser.d.ts +50 -0
- package/dist/esm/models/AuthUser.js +51 -0
- package/dist/esm/models/AutocompleteAsset.d.ts +259 -0
- package/dist/esm/models/AutocompleteAsset.js +188 -0
- package/dist/esm/models/AutocompleteAssetCustomer.d.ts +33 -0
- package/dist/esm/models/AutocompleteAssetCustomer.js +44 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomer.d.ts +509 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomer.js +360 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +38 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +47 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.d.ts +76 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.js +73 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +32 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +43 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +38 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +47 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.d.ts +56 -0
- package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.js +59 -0
- package/dist/esm/models/AutocompleteAssetFullProps.d.ts +245 -0
- package/dist/esm/models/AutocompleteAssetFullProps.js +178 -0
- package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.d.ts +44 -0
- package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.js +51 -0
- package/dist/esm/models/AutocompleteFolder.d.ts +50 -0
- package/dist/esm/models/AutocompleteFolder.js +55 -0
- package/dist/esm/models/AutocompleteResponse.d.ts +70 -0
- package/dist/esm/models/AutocompleteResponse.js +69 -0
- package/dist/esm/models/BackreferenceHistoryEntry.d.ts +53 -0
- package/dist/esm/models/BackreferenceHistoryEntry.js +59 -0
- package/dist/esm/models/BackreferenceResult.d.ts +39 -0
- package/dist/esm/models/BackreferenceResult.js +48 -0
- package/dist/esm/models/BackreferenceResultBackref.d.ts +52 -0
- package/dist/esm/models/BackreferenceResultBackref.js +57 -0
- package/dist/esm/models/CldtTemplate.d.ts +107 -0
- package/dist/esm/models/CldtTemplate.js +94 -0
- package/dist/esm/models/CldtTemplateCanvas.d.ts +38 -0
- package/dist/esm/models/CldtTemplateCanvas.js +47 -0
- package/dist/esm/models/CldtTemplateProvenance.d.ts +64 -0
- package/dist/esm/models/CldtTemplateProvenance.js +61 -0
- package/dist/esm/models/CldtTemplateVariable.d.ts +56 -0
- package/dist/esm/models/CldtTemplateVariable.js +55 -0
- package/dist/esm/models/Collection.d.ts +135 -0
- package/dist/esm/models/Collection.js +76 -0
- package/dist/esm/models/CollectionPermissions.d.ts +38 -0
- package/dist/esm/models/CollectionPermissions.js +43 -0
- package/dist/esm/models/ContextualMetadataField.d.ts +32 -0
- package/dist/esm/models/ContextualMetadataField.js +43 -0
- package/dist/esm/models/CreateAssetMetadataFieldRequest.d.ts +56 -0
- package/dist/esm/models/CreateAssetMetadataFieldRequest.js +53 -0
- package/dist/esm/models/CreateCollectionRequest.d.ts +61 -0
- package/dist/esm/models/CreateCollectionRequest.js +55 -0
- package/dist/esm/models/CreateCollectionResponse.d.ts +33 -0
- package/dist/esm/models/CreateCollectionResponse.js +44 -0
- package/dist/esm/models/CreateFolderRequest.d.ts +38 -0
- package/dist/esm/models/CreateFolderRequest.js +45 -0
- package/dist/esm/models/CreateFolderResponse.d.ts +33 -0
- package/dist/esm/models/CreateFolderResponse.js +44 -0
- package/dist/esm/models/CreateFolderResponseFolder.d.ts +75 -0
- package/dist/esm/models/CreateFolderResponseFolder.js +72 -0
- package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.d.ts +38 -0
- package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.js +47 -0
- package/dist/esm/models/CreateMetadataFieldResponse.d.ts +44 -0
- package/dist/esm/models/CreateMetadataFieldResponse.js +51 -0
- package/dist/esm/models/CreateNamespaceTokenRequest.d.ts +38 -0
- package/dist/esm/models/CreateNamespaceTokenRequest.js +47 -0
- package/dist/esm/models/Customer.d.ts +207 -0
- package/dist/esm/models/Customer.js +158 -0
- package/dist/esm/models/CustomerListMeta.d.ts +74 -0
- package/dist/esm/models/CustomerListMeta.js +71 -0
- package/dist/esm/models/CustomerUploadLimits.d.ts +56 -0
- package/dist/esm/models/CustomerUploadLimits.js +59 -0
- package/dist/esm/models/DamAppErrorResponse.d.ts +32 -0
- package/dist/esm/models/DamAppErrorResponse.js +43 -0
- package/dist/esm/models/DamAppResponse.d.ts +153 -0
- package/dist/esm/models/DamAppResponse.js +102 -0
- package/dist/esm/models/DamAppResponseAppMessageParamsValue.d.ts +38 -0
- package/dist/esm/models/DamAppResponseAppMessageParamsValue.js +45 -0
- package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +38 -0
- package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.js +45 -0
- package/dist/esm/models/DamAppResponseAssetAmountLimit.d.ts +26 -0
- package/dist/esm/models/DamAppResponseAssetAmountLimit.js +31 -0
- package/dist/esm/models/DamAppUserSnapshot.d.ts +50 -0
- package/dist/esm/models/DamAppUserSnapshot.js +47 -0
- package/dist/esm/models/DeleteFolderResponse.d.ts +38 -0
- package/dist/esm/models/DeleteFolderResponse.js +43 -0
- package/dist/esm/models/DeployApp200Response.d.ts +44 -0
- package/dist/esm/models/DeployApp200Response.js +51 -0
- package/dist/esm/models/DeployApp207Response.d.ts +50 -0
- package/dist/esm/models/DeployApp207Response.js +55 -0
- package/dist/esm/models/DeployApp400Response.d.ts +32 -0
- package/dist/esm/models/DeployApp400Response.js +43 -0
- package/dist/esm/models/DeployAppRequest.d.ts +50 -0
- package/dist/esm/models/DeployAppRequest.js +53 -0
- package/dist/esm/models/DownloadAssetRequest.d.ts +50 -0
- package/dist/esm/models/DownloadAssetRequest.js +47 -0
- package/dist/esm/models/DownloadAssetResponse.d.ts +32 -0
- package/dist/esm/models/DownloadAssetResponse.js +41 -0
- package/dist/esm/models/DownloadCollectionResponse.d.ts +38 -0
- package/dist/esm/models/DownloadCollectionResponse.js +43 -0
- package/dist/esm/models/ErrorResponse.d.ts +32 -0
- package/dist/esm/models/ErrorResponse.js +43 -0
- package/dist/esm/models/ErrorWithMessageResponse.d.ts +38 -0
- package/dist/esm/models/ErrorWithMessageResponse.js +47 -0
- package/dist/esm/models/FieldAggregation.d.ts +39 -0
- package/dist/esm/models/FieldAggregation.js +48 -0
- package/dist/esm/models/FieldAggregationBucketsInner.d.ts +38 -0
- package/dist/esm/models/FieldAggregationBucketsInner.js +47 -0
- package/dist/esm/models/FontDefinition.d.ts +44 -0
- package/dist/esm/models/FontDefinition.js +51 -0
- package/dist/esm/models/FontLookupResponse.d.ts +33 -0
- package/dist/esm/models/FontLookupResponse.js +44 -0
- package/dist/esm/models/FontLookupResponseFontsInner.d.ts +96 -0
- package/dist/esm/models/FontLookupResponseFontsInner.js +92 -0
- package/dist/esm/models/FontProvisioningResponse.d.ts +33 -0
- package/dist/esm/models/FontProvisioningResponse.js +44 -0
- package/dist/esm/models/ForbiddenResponse.d.ts +32 -0
- package/dist/esm/models/ForbiddenResponse.js +43 -0
- package/dist/esm/models/GoogleFontListingResponse.d.ts +33 -0
- package/dist/esm/models/GoogleFontListingResponse.js +44 -0
- package/dist/esm/models/ListAssetsByFolderResponse.d.ts +40 -0
- package/dist/esm/models/ListAssetsByFolderResponse.js +47 -0
- package/dist/esm/models/ListAssetsByFolderResponseMeta.d.ts +38 -0
- package/dist/esm/models/ListAssetsByFolderResponseMeta.js +45 -0
- package/dist/esm/models/ListBackreferencesResponse.d.ts +45 -0
- package/dist/esm/models/ListBackreferencesResponse.js +52 -0
- package/dist/esm/models/ListBackreferencesResponseBackrefsInner.d.ts +52 -0
- package/dist/esm/models/ListBackreferencesResponseBackrefsInner.js +57 -0
- package/dist/esm/models/ListCollectionsResponse.d.ts +51 -0
- package/dist/esm/models/ListCollectionsResponse.js +50 -0
- package/dist/esm/models/ListContextualMetadataFieldsResponse.d.ts +39 -0
- package/dist/esm/models/ListContextualMetadataFieldsResponse.js +46 -0
- package/dist/esm/models/ListCustomersResponse.d.ts +40 -0
- package/dist/esm/models/ListCustomersResponse.js +49 -0
- package/dist/esm/models/ListMetadataFieldsResponse.d.ts +33 -0
- package/dist/esm/models/ListMetadataFieldsResponse.js +44 -0
- package/dist/esm/models/ListSubfoldersResponse.d.ts +57 -0
- package/dist/esm/models/ListSubfoldersResponse.js +52 -0
- package/dist/esm/models/ListSubfoldersResponseFoldersInner.d.ts +62 -0
- package/dist/esm/models/ListSubfoldersResponseFoldersInner.js +57 -0
- package/dist/esm/models/ListTransformationsResponse.d.ts +39 -0
- package/dist/esm/models/ListTransformationsResponse.js +46 -0
- package/dist/esm/models/LocationSegment.d.ts +38 -0
- package/dist/esm/models/LocationSegment.js +45 -0
- package/dist/esm/models/LookupFontRequest.d.ts +33 -0
- package/dist/esm/models/LookupFontRequest.js +44 -0
- package/dist/esm/models/LookupFontRequestFontsInner.d.ts +69 -0
- package/dist/esm/models/LookupFontRequestFontsInner.js +74 -0
- package/dist/esm/models/NamespaceTokenCreateErrorResponse.d.ts +32 -0
- package/dist/esm/models/NamespaceTokenCreateErrorResponse.js +43 -0
- package/dist/esm/models/NamespaceTokenCreateResponse.d.ts +32 -0
- package/dist/esm/models/NamespaceTokenCreateResponse.js +43 -0
- package/dist/esm/models/PrepareUploadRequest.d.ts +33 -0
- package/dist/esm/models/PrepareUploadRequest.js +42 -0
- package/dist/esm/models/PrepareUploadRequestUploadParams.d.ts +200 -0
- package/dist/esm/models/PrepareUploadRequestUploadParams.js +97 -0
- package/dist/esm/models/PrepareUploadResponse.d.ts +51 -0
- package/dist/esm/models/PrepareUploadResponse.js +54 -0
- package/dist/esm/models/ProvisionFontRequest.d.ts +39 -0
- package/dist/esm/models/ProvisionFontRequest.js +46 -0
- package/dist/esm/models/RefreshTokenErrorResponse.d.ts +32 -0
- package/dist/esm/models/RefreshTokenErrorResponse.js +43 -0
- package/dist/esm/models/RefreshTokenResponse.d.ts +32 -0
- package/dist/esm/models/RefreshTokenResponse.js +43 -0
- package/dist/esm/models/RemoveCollectionAssetsRequest.d.ts +38 -0
- package/dist/esm/models/RemoveCollectionAssetsRequest.js +43 -0
- package/dist/esm/models/RemoveCollectionAssetsResponse.d.ts +33 -0
- package/dist/esm/models/RemoveCollectionAssetsResponse.js +44 -0
- package/dist/esm/models/ResourceActor.d.ts +38 -0
- package/dist/esm/models/ResourceActor.js +47 -0
- package/dist/esm/models/SearchAsset.d.ts +257 -0
- package/dist/esm/models/SearchAsset.js +182 -0
- package/dist/esm/models/SearchCollectionsRequest.d.ts +60 -0
- package/dist/esm/models/SearchCollectionsRequest.js +49 -0
- package/dist/esm/models/SearchCollectionsResponse.d.ts +51 -0
- package/dist/esm/models/SearchCollectionsResponse.js +50 -0
- package/dist/esm/models/SetAppStorageValueRequest.d.ts +32 -0
- package/dist/esm/models/SetAppStorageValueRequest.js +41 -0
- package/dist/esm/models/SignAndUploadRequest.d.ts +176 -0
- package/dist/esm/models/SignAndUploadRequest.js +91 -0
- package/dist/esm/models/SignAndUploadRequest1.d.ts +176 -0
- package/dist/esm/models/SignAndUploadRequest1.js +91 -0
- package/dist/esm/models/SignAndUploadResponse.d.ts +122 -0
- package/dist/esm/models/SignAndUploadResponse.js +93 -0
- package/dist/esm/models/StructuredMetadataField.d.ts +68 -0
- package/dist/esm/models/StructuredMetadataField.js +53 -0
- package/dist/esm/models/TemplateResourceTuple.d.ts +40 -0
- package/dist/esm/models/TemplateResourceTuple.js +49 -0
- package/dist/esm/models/TemplateSearchResponse.d.ts +57 -0
- package/dist/esm/models/TemplateSearchResponse.js +60 -0
- package/dist/esm/models/ThumbnailsTokenResponse.d.ts +44 -0
- package/dist/esm/models/ThumbnailsTokenResponse.js +51 -0
- package/dist/esm/models/TrackAnalyticsEventRequest.d.ts +32 -0
- package/dist/esm/models/TrackAnalyticsEventRequest.js +43 -0
- package/dist/esm/models/Transformation.d.ts +80 -0
- package/dist/esm/models/Transformation.js +57 -0
- package/dist/esm/models/UpdateAppRequest.d.ts +40 -0
- package/dist/esm/models/UpdateAppRequest.js +43 -0
- package/dist/esm/models/UpdateAssetBackreferencesRequest.d.ts +62 -0
- package/dist/esm/models/UpdateAssetBackreferencesRequest.js +62 -0
- package/dist/esm/models/UpdateAssetMetadataRequest.d.ts +49 -0
- package/dist/esm/models/UpdateAssetMetadataRequest.js +49 -0
- package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.d.ts +26 -0
- package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.js +31 -0
- package/dist/esm/models/UpdateAssetMetadataResponse.d.ts +49 -0
- package/dist/esm/models/UpdateAssetMetadataResponse.js +49 -0
- package/dist/esm/models/UpdateAssetTagsRequest.d.ts +52 -0
- package/dist/esm/models/UpdateAssetTagsRequest.js +58 -0
- package/dist/esm/models/UpdateAssetTagsResponse.d.ts +32 -0
- package/dist/esm/models/UpdateAssetTagsResponse.js +43 -0
- package/dist/esm/models/UpdateBackreferencesResponse.d.ts +33 -0
- package/dist/esm/models/UpdateBackreferencesResponse.js +44 -0
- package/dist/esm/models/UpdateCollectionRequest.d.ts +46 -0
- package/dist/esm/models/UpdateCollectionRequest.js +45 -0
- package/dist/esm/models/UpdateCollectionResponse.d.ts +33 -0
- package/dist/esm/models/UpdateCollectionResponse.js +44 -0
- package/dist/esm/models/UploadAssetRequest.d.ts +128 -0
- package/dist/esm/models/UploadAssetRequest.js +79 -0
- package/dist/esm/models/UploadAssetRequest1.d.ts +128 -0
- package/dist/esm/models/UploadAssetRequest1.js +79 -0
- package/dist/esm/models/UploadAssetResponse.d.ts +122 -0
- package/dist/esm/models/UploadAssetResponse.js +93 -0
- package/dist/esm/models/ValidateTokenResponse.d.ts +32 -0
- package/dist/esm/models/ValidateTokenResponse.js +43 -0
- package/dist/esm/models/index.d.ts +127 -0
- package/dist/esm/models/index.js +129 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +334 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/AddCollectionAssetsRequest.d.ts +38 -0
- package/dist/models/AddCollectionAssetsRequest.js +50 -0
- package/dist/models/AddCollectionAssetsResponse.d.ts +33 -0
- package/dist/models/AddCollectionAssetsResponse.js +51 -0
- package/dist/models/AiVisionGeneralResponse.d.ts +32 -0
- package/dist/models/AiVisionGeneralResponse.js +48 -0
- package/dist/models/AnalyticsResponse.d.ts +32 -0
- package/dist/models/AnalyticsResponse.js +50 -0
- package/dist/models/AnalyzeAiVisionGeneralRequest.d.ts +51 -0
- package/dist/models/AnalyzeAiVisionGeneralRequest.js +59 -0
- package/dist/models/AnalyzeAiVisionGeneralRequestSource.d.ts +38 -0
- package/dist/models/AnalyzeAiVisionGeneralRequestSource.js +50 -0
- package/dist/models/AppStorageErrorResponse.d.ts +32 -0
- package/dist/models/AppStorageErrorResponse.js +50 -0
- package/dist/models/AppStorageGetResponse.d.ts +38 -0
- package/dist/models/AppStorageGetResponse.js +52 -0
- package/dist/models/AppStorageSetErrorResponse.d.ts +32 -0
- package/dist/models/AppStorageSetErrorResponse.js +50 -0
- package/dist/models/AppStorageSetResponse.d.ts +38 -0
- package/dist/models/AppStorageSetResponse.js +52 -0
- package/dist/models/Asset.d.ts +134 -0
- package/dist/models/Asset.js +90 -0
- package/dist/models/AssetHistoryResponse.d.ts +39 -0
- package/dist/models/AssetHistoryResponse.js +51 -0
- package/dist/models/AssetHistoryResponseAssetHistoryInner.d.ts +67 -0
- package/dist/models/AssetHistoryResponseAssetHistoryInner.js +71 -0
- package/dist/models/AssetSearchResponse.d.ts +76 -0
- package/dist/models/AssetSearchResponse.js +78 -0
- package/dist/models/AuthCredentialsResponse.d.ts +40 -0
- package/dist/models/AuthCredentialsResponse.js +56 -0
- package/dist/models/AuthCustomer.d.ts +80 -0
- package/dist/models/AuthCustomer.js +80 -0
- package/dist/models/AuthUser.d.ts +50 -0
- package/dist/models/AuthUser.js +58 -0
- package/dist/models/AutocompleteAsset.d.ts +259 -0
- package/dist/models/AutocompleteAsset.js +195 -0
- package/dist/models/AutocompleteAssetCustomer.d.ts +33 -0
- package/dist/models/AutocompleteAssetCustomer.js +51 -0
- package/dist/models/AutocompleteAssetCustomerCustomer.d.ts +509 -0
- package/dist/models/AutocompleteAssetCustomerCustomer.js +367 -0
- package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +38 -0
- package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +54 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfig.d.ts +76 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfig.js +80 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +32 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +50 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +38 -0
- package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +54 -0
- package/dist/models/AutocompleteAssetCustomerCustomerLimits.d.ts +56 -0
- package/dist/models/AutocompleteAssetCustomerCustomerLimits.js +66 -0
- package/dist/models/AutocompleteAssetFullProps.d.ts +245 -0
- package/dist/models/AutocompleteAssetFullProps.js +185 -0
- package/dist/models/AutocompleteAssetFullPropsCreatedBy.d.ts +44 -0
- package/dist/models/AutocompleteAssetFullPropsCreatedBy.js +58 -0
- package/dist/models/AutocompleteFolder.d.ts +50 -0
- package/dist/models/AutocompleteFolder.js +62 -0
- package/dist/models/AutocompleteResponse.d.ts +70 -0
- package/dist/models/AutocompleteResponse.js +76 -0
- package/dist/models/BackreferenceHistoryEntry.d.ts +53 -0
- package/dist/models/BackreferenceHistoryEntry.js +67 -0
- package/dist/models/BackreferenceResult.d.ts +39 -0
- package/dist/models/BackreferenceResult.js +55 -0
- package/dist/models/BackreferenceResultBackref.d.ts +52 -0
- package/dist/models/BackreferenceResultBackref.js +64 -0
- package/dist/models/CldtTemplate.d.ts +107 -0
- package/dist/models/CldtTemplate.js +101 -0
- package/dist/models/CldtTemplateCanvas.d.ts +38 -0
- package/dist/models/CldtTemplateCanvas.js +54 -0
- package/dist/models/CldtTemplateProvenance.d.ts +64 -0
- package/dist/models/CldtTemplateProvenance.js +68 -0
- package/dist/models/CldtTemplateVariable.d.ts +56 -0
- package/dist/models/CldtTemplateVariable.js +62 -0
- package/dist/models/Collection.d.ts +135 -0
- package/dist/models/Collection.js +83 -0
- package/dist/models/CollectionPermissions.d.ts +38 -0
- package/dist/models/CollectionPermissions.js +50 -0
- package/dist/models/ContextualMetadataField.d.ts +32 -0
- package/dist/models/ContextualMetadataField.js +50 -0
- package/dist/models/CreateAssetMetadataFieldRequest.d.ts +56 -0
- package/dist/models/CreateAssetMetadataFieldRequest.js +60 -0
- package/dist/models/CreateCollectionRequest.d.ts +61 -0
- package/dist/models/CreateCollectionRequest.js +63 -0
- package/dist/models/CreateCollectionResponse.d.ts +33 -0
- package/dist/models/CreateCollectionResponse.js +51 -0
- package/dist/models/CreateFolderRequest.d.ts +38 -0
- package/dist/models/CreateFolderRequest.js +52 -0
- package/dist/models/CreateFolderResponse.d.ts +33 -0
- package/dist/models/CreateFolderResponse.js +51 -0
- package/dist/models/CreateFolderResponseFolder.d.ts +75 -0
- package/dist/models/CreateFolderResponseFolder.js +79 -0
- package/dist/models/CreateFolderResponseFolderViewableParentsInner.d.ts +38 -0
- package/dist/models/CreateFolderResponseFolderViewableParentsInner.js +54 -0
- package/dist/models/CreateMetadataFieldResponse.d.ts +44 -0
- package/dist/models/CreateMetadataFieldResponse.js +58 -0
- package/dist/models/CreateNamespaceTokenRequest.d.ts +38 -0
- package/dist/models/CreateNamespaceTokenRequest.js +54 -0
- package/dist/models/Customer.d.ts +207 -0
- package/dist/models/Customer.js +165 -0
- package/dist/models/CustomerListMeta.d.ts +74 -0
- package/dist/models/CustomerListMeta.js +78 -0
- package/dist/models/CustomerUploadLimits.d.ts +56 -0
- package/dist/models/CustomerUploadLimits.js +66 -0
- package/dist/models/DamAppErrorResponse.d.ts +32 -0
- package/dist/models/DamAppErrorResponse.js +50 -0
- package/dist/models/DamAppResponse.d.ts +153 -0
- package/dist/models/DamAppResponse.js +110 -0
- package/dist/models/DamAppResponseAppMessageParamsValue.d.ts +38 -0
- package/dist/models/DamAppResponseAppMessageParamsValue.js +52 -0
- package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +38 -0
- package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.js +52 -0
- package/dist/models/DamAppResponseAssetAmountLimit.d.ts +26 -0
- package/dist/models/DamAppResponseAssetAmountLimit.js +38 -0
- package/dist/models/DamAppUserSnapshot.d.ts +50 -0
- package/dist/models/DamAppUserSnapshot.js +54 -0
- package/dist/models/DeleteFolderResponse.d.ts +38 -0
- package/dist/models/DeleteFolderResponse.js +50 -0
- package/dist/models/DeployApp200Response.d.ts +44 -0
- package/dist/models/DeployApp200Response.js +58 -0
- package/dist/models/DeployApp207Response.d.ts +50 -0
- package/dist/models/DeployApp207Response.js +62 -0
- package/dist/models/DeployApp400Response.d.ts +32 -0
- package/dist/models/DeployApp400Response.js +50 -0
- package/dist/models/DeployAppRequest.d.ts +50 -0
- package/dist/models/DeployAppRequest.js +60 -0
- package/dist/models/DownloadAssetRequest.d.ts +50 -0
- package/dist/models/DownloadAssetRequest.js +54 -0
- package/dist/models/DownloadAssetResponse.d.ts +32 -0
- package/dist/models/DownloadAssetResponse.js +48 -0
- package/dist/models/DownloadCollectionResponse.d.ts +38 -0
- package/dist/models/DownloadCollectionResponse.js +50 -0
- package/dist/models/ErrorResponse.d.ts +32 -0
- package/dist/models/ErrorResponse.js +50 -0
- package/dist/models/ErrorWithMessageResponse.d.ts +38 -0
- package/dist/models/ErrorWithMessageResponse.js +54 -0
- package/dist/models/FieldAggregation.d.ts +39 -0
- package/dist/models/FieldAggregation.js +55 -0
- package/dist/models/FieldAggregationBucketsInner.d.ts +38 -0
- package/dist/models/FieldAggregationBucketsInner.js +54 -0
- package/dist/models/FontDefinition.d.ts +44 -0
- package/dist/models/FontDefinition.js +58 -0
- package/dist/models/FontLookupResponse.d.ts +33 -0
- package/dist/models/FontLookupResponse.js +51 -0
- package/dist/models/FontLookupResponseFontsInner.d.ts +96 -0
- package/dist/models/FontLookupResponseFontsInner.js +100 -0
- package/dist/models/FontProvisioningResponse.d.ts +33 -0
- package/dist/models/FontProvisioningResponse.js +51 -0
- package/dist/models/ForbiddenResponse.d.ts +32 -0
- package/dist/models/ForbiddenResponse.js +50 -0
- package/dist/models/GoogleFontListingResponse.d.ts +33 -0
- package/dist/models/GoogleFontListingResponse.js +51 -0
- package/dist/models/ListAssetsByFolderResponse.d.ts +40 -0
- package/dist/models/ListAssetsByFolderResponse.js +54 -0
- package/dist/models/ListAssetsByFolderResponseMeta.d.ts +38 -0
- package/dist/models/ListAssetsByFolderResponseMeta.js +52 -0
- package/dist/models/ListBackreferencesResponse.d.ts +45 -0
- package/dist/models/ListBackreferencesResponse.js +59 -0
- package/dist/models/ListBackreferencesResponseBackrefsInner.d.ts +52 -0
- package/dist/models/ListBackreferencesResponseBackrefsInner.js +64 -0
- package/dist/models/ListCollectionsResponse.d.ts +51 -0
- package/dist/models/ListCollectionsResponse.js +57 -0
- package/dist/models/ListContextualMetadataFieldsResponse.d.ts +39 -0
- package/dist/models/ListContextualMetadataFieldsResponse.js +53 -0
- package/dist/models/ListCustomersResponse.d.ts +40 -0
- package/dist/models/ListCustomersResponse.js +56 -0
- package/dist/models/ListMetadataFieldsResponse.d.ts +33 -0
- package/dist/models/ListMetadataFieldsResponse.js +51 -0
- package/dist/models/ListSubfoldersResponse.d.ts +57 -0
- package/dist/models/ListSubfoldersResponse.js +59 -0
- package/dist/models/ListSubfoldersResponseFoldersInner.d.ts +62 -0
- package/dist/models/ListSubfoldersResponseFoldersInner.js +64 -0
- package/dist/models/ListTransformationsResponse.d.ts +39 -0
- package/dist/models/ListTransformationsResponse.js +53 -0
- package/dist/models/LocationSegment.d.ts +38 -0
- package/dist/models/LocationSegment.js +52 -0
- package/dist/models/LookupFontRequest.d.ts +33 -0
- package/dist/models/LookupFontRequest.js +51 -0
- package/dist/models/LookupFontRequestFontsInner.d.ts +69 -0
- package/dist/models/LookupFontRequestFontsInner.js +82 -0
- package/dist/models/NamespaceTokenCreateErrorResponse.d.ts +32 -0
- package/dist/models/NamespaceTokenCreateErrorResponse.js +50 -0
- package/dist/models/NamespaceTokenCreateResponse.d.ts +32 -0
- package/dist/models/NamespaceTokenCreateResponse.js +50 -0
- package/dist/models/PrepareUploadRequest.d.ts +33 -0
- package/dist/models/PrepareUploadRequest.js +49 -0
- package/dist/models/PrepareUploadRequestUploadParams.d.ts +200 -0
- package/dist/models/PrepareUploadRequestUploadParams.js +104 -0
- package/dist/models/PrepareUploadResponse.d.ts +51 -0
- package/dist/models/PrepareUploadResponse.js +61 -0
- package/dist/models/ProvisionFontRequest.d.ts +39 -0
- package/dist/models/ProvisionFontRequest.js +53 -0
- package/dist/models/RefreshTokenErrorResponse.d.ts +32 -0
- package/dist/models/RefreshTokenErrorResponse.js +50 -0
- package/dist/models/RefreshTokenResponse.d.ts +32 -0
- package/dist/models/RefreshTokenResponse.js +50 -0
- package/dist/models/RemoveCollectionAssetsRequest.d.ts +38 -0
- package/dist/models/RemoveCollectionAssetsRequest.js +50 -0
- package/dist/models/RemoveCollectionAssetsResponse.d.ts +33 -0
- package/dist/models/RemoveCollectionAssetsResponse.js +51 -0
- package/dist/models/ResourceActor.d.ts +38 -0
- package/dist/models/ResourceActor.js +54 -0
- package/dist/models/SearchAsset.d.ts +257 -0
- package/dist/models/SearchAsset.js +189 -0
- package/dist/models/SearchCollectionsRequest.d.ts +60 -0
- package/dist/models/SearchCollectionsRequest.js +56 -0
- package/dist/models/SearchCollectionsResponse.d.ts +51 -0
- package/dist/models/SearchCollectionsResponse.js +57 -0
- package/dist/models/SetAppStorageValueRequest.d.ts +32 -0
- package/dist/models/SetAppStorageValueRequest.js +48 -0
- package/dist/models/SignAndUploadRequest.d.ts +176 -0
- package/dist/models/SignAndUploadRequest.js +98 -0
- package/dist/models/SignAndUploadRequest1.d.ts +176 -0
- package/dist/models/SignAndUploadRequest1.js +98 -0
- package/dist/models/SignAndUploadResponse.d.ts +122 -0
- package/dist/models/SignAndUploadResponse.js +100 -0
- package/dist/models/StructuredMetadataField.d.ts +68 -0
- package/dist/models/StructuredMetadataField.js +60 -0
- package/dist/models/TemplateResourceTuple.d.ts +40 -0
- package/dist/models/TemplateResourceTuple.js +56 -0
- package/dist/models/TemplateSearchResponse.d.ts +57 -0
- package/dist/models/TemplateSearchResponse.js +67 -0
- package/dist/models/ThumbnailsTokenResponse.d.ts +44 -0
- package/dist/models/ThumbnailsTokenResponse.js +58 -0
- package/dist/models/TrackAnalyticsEventRequest.d.ts +32 -0
- package/dist/models/TrackAnalyticsEventRequest.js +50 -0
- package/dist/models/Transformation.d.ts +80 -0
- package/dist/models/Transformation.js +64 -0
- package/dist/models/UpdateAppRequest.d.ts +40 -0
- package/dist/models/UpdateAppRequest.js +50 -0
- package/dist/models/UpdateAssetBackreferencesRequest.d.ts +62 -0
- package/dist/models/UpdateAssetBackreferencesRequest.js +70 -0
- package/dist/models/UpdateAssetMetadataRequest.d.ts +49 -0
- package/dist/models/UpdateAssetMetadataRequest.js +56 -0
- package/dist/models/UpdateAssetMetadataRequestMetadataValue.d.ts +26 -0
- package/dist/models/UpdateAssetMetadataRequestMetadataValue.js +38 -0
- package/dist/models/UpdateAssetMetadataResponse.d.ts +49 -0
- package/dist/models/UpdateAssetMetadataResponse.js +56 -0
- package/dist/models/UpdateAssetTagsRequest.d.ts +52 -0
- package/dist/models/UpdateAssetTagsRequest.js +66 -0
- package/dist/models/UpdateAssetTagsResponse.d.ts +32 -0
- package/dist/models/UpdateAssetTagsResponse.js +50 -0
- package/dist/models/UpdateBackreferencesResponse.d.ts +33 -0
- package/dist/models/UpdateBackreferencesResponse.js +51 -0
- package/dist/models/UpdateCollectionRequest.d.ts +46 -0
- package/dist/models/UpdateCollectionRequest.js +52 -0
- package/dist/models/UpdateCollectionResponse.d.ts +33 -0
- package/dist/models/UpdateCollectionResponse.js +51 -0
- package/dist/models/UploadAssetRequest.d.ts +128 -0
- package/dist/models/UploadAssetRequest.js +86 -0
- package/dist/models/UploadAssetRequest1.d.ts +128 -0
- package/dist/models/UploadAssetRequest1.js +86 -0
- package/dist/models/UploadAssetResponse.d.ts +122 -0
- package/dist/models/UploadAssetResponse.js +100 -0
- package/dist/models/ValidateTokenResponse.d.ts +32 -0
- package/dist/models/ValidateTokenResponse.js +50 -0
- package/dist/models/index.d.ts +127 -0
- package/dist/models/index.js +145 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +350 -0
- package/docs/AddCollectionAssetsRequest.md +36 -0
- package/docs/AddCollectionAssetsResponse.md +34 -0
- package/docs/AiVisionGeneralResponse.md +34 -0
- package/docs/AnalyticsResponse.md +34 -0
- package/docs/AnalyzeAiVisionGeneralRequest.md +40 -0
- package/docs/AnalyzeAiVisionGeneralRequestSource.md +37 -0
- package/docs/AppStorageErrorResponse.md +34 -0
- package/docs/AppStorageGetResponse.md +36 -0
- package/docs/AppStorageSetErrorResponse.md +34 -0
- package/docs/AppStorageSetResponse.md +36 -0
- package/docs/Asset.md +68 -0
- package/docs/AssetHistoryResponse.md +36 -0
- package/docs/AssetHistoryResponseAssetHistoryInner.md +40 -0
- package/docs/AssetManagementApi.md +2029 -0
- package/docs/AssetSearchResponse.md +48 -0
- package/docs/AuthCredentialsResponse.md +36 -0
- package/docs/AuthCustomer.md +50 -0
- package/docs/AuthUser.md +40 -0
- package/docs/AutocompleteAsset.md +108 -0
- package/docs/AutocompleteAssetCustomer.md +34 -0
- package/docs/AutocompleteAssetCustomerCustomer.md +192 -0
- package/docs/AutocompleteAssetCustomerCustomerCdnConfigAttrs.md +36 -0
- package/docs/AutocompleteAssetCustomerCustomerConfig.md +48 -0
- package/docs/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.md +34 -0
- package/docs/AutocompleteAssetCustomerCustomerConfigHookTimeouts.md +36 -0
- package/docs/AutocompleteAssetCustomerCustomerLimits.md +42 -0
- package/docs/AutocompleteAssetFullProps.md +104 -0
- package/docs/AutocompleteAssetFullPropsCreatedBy.md +38 -0
- package/docs/AutocompleteFolder.md +40 -0
- package/docs/AutocompleteResponse.md +46 -0
- package/docs/BackreferenceHistoryEntry.md +38 -0
- package/docs/BackreferenceResult.md +36 -0
- package/docs/BackreferenceResultBackref.md +40 -0
- package/docs/CldtTemplate.md +58 -0
- package/docs/CldtTemplateCanvas.md +36 -0
- package/docs/CldtTemplateProvenance.md +44 -0
- package/docs/CldtTemplateVariable.md +42 -0
- package/docs/Collection.md +68 -0
- package/docs/CollectionPermissions.md +36 -0
- package/docs/ConsoleApi.md +1454 -0
- package/docs/ContextualMetadataField.md +34 -0
- package/docs/CreateAssetMetadataFieldRequest.md +42 -0
- package/docs/CreateCollectionRequest.md +40 -0
- package/docs/CreateCollectionResponse.md +34 -0
- package/docs/CreateFolderRequest.md +36 -0
- package/docs/CreateFolderResponse.md +34 -0
- package/docs/CreateFolderResponseFolder.md +48 -0
- package/docs/CreateFolderResponseFolderViewableParentsInner.md +36 -0
- package/docs/CreateMetadataFieldResponse.md +38 -0
- package/docs/CreateNamespaceTokenRequest.md +36 -0
- package/docs/Customer.md +92 -0
- package/docs/CustomerListMeta.md +48 -0
- package/docs/CustomerUploadLimits.md +42 -0
- package/docs/DamAppErrorResponse.md +34 -0
- package/docs/DamAppResponse.md +68 -0
- package/docs/DamAppResponseAppMessageParamsValue.md +36 -0
- package/docs/DamAppResponseAppMessageParamsValueAnyOf.md +36 -0
- package/docs/DamAppResponseAssetAmountLimit.md +33 -0
- package/docs/DamAppUserSnapshot.md +40 -0
- package/docs/DeleteFolderResponse.md +36 -0
- package/docs/DeployApp200Response.md +38 -0
- package/docs/DeployApp207Response.md +40 -0
- package/docs/DeployApp400Response.md +34 -0
- package/docs/DeployAppRequest.md +40 -0
- package/docs/DownloadAssetRequest.md +40 -0
- package/docs/DownloadAssetResponse.md +34 -0
- package/docs/DownloadCollectionResponse.md +36 -0
- package/docs/ErrorResponse.md +34 -0
- package/docs/ErrorWithMessageResponse.md +36 -0
- package/docs/FieldAggregation.md +36 -0
- package/docs/FieldAggregationBucketsInner.md +36 -0
- package/docs/FontDefinition.md +38 -0
- package/docs/FontLookupResponse.md +34 -0
- package/docs/FontLookupResponseFontsInner.md +44 -0
- package/docs/FontProvisioningResponse.md +34 -0
- package/docs/ForbiddenResponse.md +34 -0
- package/docs/GoogleFontListingResponse.md +34 -0
- package/docs/ListAssetsByFolderResponse.md +36 -0
- package/docs/ListAssetsByFolderResponseMeta.md +36 -0
- package/docs/ListBackreferencesResponse.md +38 -0
- package/docs/ListBackreferencesResponseBackrefsInner.md +40 -0
- package/docs/ListCollectionsResponse.md +40 -0
- package/docs/ListContextualMetadataFieldsResponse.md +36 -0
- package/docs/ListCustomersResponse.md +36 -0
- package/docs/ListMetadataFieldsResponse.md +34 -0
- package/docs/ListSubfoldersResponse.md +42 -0
- package/docs/ListSubfoldersResponseFoldersInner.md +44 -0
- package/docs/ListTransformationsResponse.md +36 -0
- package/docs/LocationSegment.md +36 -0
- package/docs/LookupFontRequest.md +34 -0
- package/docs/LookupFontRequestFontsInner.md +38 -0
- package/docs/MediaApi.md +790 -0
- package/docs/NamespaceTokenCreateErrorResponse.md +34 -0
- package/docs/NamespaceTokenCreateResponse.md +34 -0
- package/docs/PlatformApi.md +915 -0
- package/docs/PrepareUploadRequest.md +34 -0
- package/docs/PrepareUploadRequestUploadParams.md +90 -0
- package/docs/PrepareUploadResponse.md +40 -0
- package/docs/ProvisionFontRequest.md +36 -0
- package/docs/RefreshTokenErrorResponse.md +34 -0
- package/docs/RefreshTokenResponse.md +34 -0
- package/docs/RemoveCollectionAssetsRequest.md +36 -0
- package/docs/RemoveCollectionAssetsResponse.md +34 -0
- package/docs/ResourceActor.md +36 -0
- package/docs/SearchAsset.md +108 -0
- package/docs/SearchCollectionsRequest.md +42 -0
- package/docs/SearchCollectionsResponse.md +40 -0
- package/docs/SetAppStorageValueRequest.md +34 -0
- package/docs/SignAndUploadRequest.md +82 -0
- package/docs/SignAndUploadRequest1.md +82 -0
- package/docs/SignAndUploadResponse.md +64 -0
- package/docs/StructuredMetadataField.md +46 -0
- package/docs/TemplateResourceTuple.md +36 -0
- package/docs/TemplateSearchResponse.md +42 -0
- package/docs/ThumbnailsTokenResponse.md +38 -0
- package/docs/TrackAnalyticsEventRequest.md +34 -0
- package/docs/Transformation.md +50 -0
- package/docs/UpdateAppRequest.md +36 -0
- package/docs/UpdateAssetBackreferencesRequest.md +40 -0
- package/docs/UpdateAssetMetadataRequest.md +38 -0
- package/docs/UpdateAssetMetadataRequestMetadataValue.md +32 -0
- package/docs/UpdateAssetMetadataResponse.md +38 -0
- package/docs/UpdateAssetTagsRequest.md +38 -0
- package/docs/UpdateAssetTagsResponse.md +34 -0
- package/docs/UpdateBackreferencesResponse.md +34 -0
- package/docs/UpdateCollectionRequest.md +38 -0
- package/docs/UpdateCollectionResponse.md +34 -0
- package/docs/UploadApi.md +210 -0
- package/docs/UploadAssetRequest.md +66 -0
- package/docs/UploadAssetRequest1.md +66 -0
- package/docs/UploadAssetResponse.md +64 -0
- package/docs/UtilsApi.md +745 -0
- package/docs/ValidateTokenResponse.md +34 -0
- package/package.json +21 -0
- package/src/apis/AssetManagementApi.ts +1671 -0
- package/src/apis/ConsoleApi.ts +1404 -0
- package/src/apis/MediaApi.ts +849 -0
- package/src/apis/PlatformApi.ts +812 -0
- package/src/apis/UploadApi.ts +284 -0
- package/src/apis/UtilsApi.ts +637 -0
- package/src/apis/index.ts +8 -0
- package/src/index.ts +5 -0
- package/src/models/AddCollectionAssetsRequest.ts +73 -0
- package/src/models/AddCollectionAssetsResponse.ts +74 -0
- package/src/models/AiVisionGeneralResponse.ts +65 -0
- package/src/models/AnalyticsResponse.ts +66 -0
- package/src/models/AnalyzeAiVisionGeneralRequest.ts +99 -0
- package/src/models/AnalyzeAiVisionGeneralRequestSource.ts +73 -0
- package/src/models/AppStorageErrorResponse.ts +66 -0
- package/src/models/AppStorageGetResponse.ts +74 -0
- package/src/models/AppStorageSetErrorResponse.ts +66 -0
- package/src/models/AppStorageSetResponse.ts +74 -0
- package/src/models/Asset.ts +205 -0
- package/src/models/AssetHistoryResponse.ts +81 -0
- package/src/models/AssetHistoryResponseAssetHistoryInner.ts +109 -0
- package/src/models/AssetSearchResponse.ts +143 -0
- package/src/models/AuthCredentialsResponse.ts +90 -0
- package/src/models/AuthCustomer.ts +137 -0
- package/src/models/AuthUser.ts +91 -0
- package/src/models/AutocompleteAsset.ts +418 -0
- package/src/models/AutocompleteAssetCustomer.ts +74 -0
- package/src/models/AutocompleteAssetCustomerCustomer.ts +798 -0
- package/src/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.ts +75 -0
- package/src/models/AutocompleteAssetCustomerCustomerConfig.ts +144 -0
- package/src/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.ts +66 -0
- package/src/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.ts +75 -0
- package/src/models/AutocompleteAssetCustomerCustomerLimits.ts +102 -0
- package/src/models/AutocompleteAssetFullProps.ts +386 -0
- package/src/models/AutocompleteAssetFullPropsCreatedBy.ts +84 -0
- package/src/models/AutocompleteFolder.ts +93 -0
- package/src/models/AutocompleteResponse.ts +135 -0
- package/src/models/BackreferenceHistoryEntry.ts +96 -0
- package/src/models/BackreferenceResult.ts +83 -0
- package/src/models/BackreferenceResultBackref.ts +108 -0
- package/src/models/CldtTemplate.ts +196 -0
- package/src/models/CldtTemplateCanvas.ts +75 -0
- package/src/models/CldtTemplateProvenance.ts +110 -0
- package/src/models/CldtTemplateVariable.ts +100 -0
- package/src/models/Collection.ts +209 -0
- package/src/models/CollectionPermissions.ts +73 -0
- package/src/models/ContextualMetadataField.ts +66 -0
- package/src/models/CreateAssetMetadataFieldRequest.ts +99 -0
- package/src/models/CreateCollectionRequest.ts +101 -0
- package/src/models/CreateCollectionResponse.ts +74 -0
- package/src/models/CreateFolderRequest.ts +74 -0
- package/src/models/CreateFolderResponse.ts +74 -0
- package/src/models/CreateFolderResponseFolder.ts +137 -0
- package/src/models/CreateFolderResponseFolderViewableParentsInner.ts +75 -0
- package/src/models/CreateMetadataFieldResponse.ts +84 -0
- package/src/models/CreateNamespaceTokenRequest.ts +75 -0
- package/src/models/Customer.ts +334 -0
- package/src/models/CustomerListMeta.ts +129 -0
- package/src/models/CustomerUploadLimits.ts +102 -0
- package/src/models/DamAppErrorResponse.ts +66 -0
- package/src/models/DamAppResponse.ts +243 -0
- package/src/models/DamAppResponseAppMessageParamsValue.ts +82 -0
- package/src/models/DamAppResponseAppMessageParamsValueAnyOf.ts +74 -0
- package/src/models/DamAppResponseAssetAmountLimit.ts +46 -0
- package/src/models/DamAppUserSnapshot.ts +89 -0
- package/src/models/DeleteFolderResponse.ts +73 -0
- package/src/models/DeployApp200Response.ts +84 -0
- package/src/models/DeployApp207Response.ts +93 -0
- package/src/models/DeployApp400Response.ts +66 -0
- package/src/models/DeployAppRequest.ts +92 -0
- package/src/models/DownloadAssetRequest.ts +89 -0
- package/src/models/DownloadAssetResponse.ts +65 -0
- package/src/models/DownloadCollectionResponse.ts +73 -0
- package/src/models/ErrorResponse.ts +66 -0
- package/src/models/ErrorWithMessageResponse.ts +75 -0
- package/src/models/FieldAggregation.ts +83 -0
- package/src/models/FieldAggregationBucketsInner.ts +75 -0
- package/src/models/FontDefinition.ts +84 -0
- package/src/models/FontLookupResponse.ts +74 -0
- package/src/models/FontLookupResponseFontsInner.ts +149 -0
- package/src/models/FontProvisioningResponse.ts +74 -0
- package/src/models/ForbiddenResponse.ts +66 -0
- package/src/models/GoogleFontListingResponse.ts +74 -0
- package/src/models/ListAssetsByFolderResponse.ts +89 -0
- package/src/models/ListAssetsByFolderResponseMeta.ts +74 -0
- package/src/models/ListBackreferencesResponse.ts +92 -0
- package/src/models/ListBackreferencesResponseBackrefsInner.ts +108 -0
- package/src/models/ListCollectionsResponse.ts +98 -0
- package/src/models/ListContextualMetadataFieldsResponse.ts +82 -0
- package/src/models/ListCustomersResponse.ts +90 -0
- package/src/models/ListMetadataFieldsResponse.ts +74 -0
- package/src/models/ListSubfoldersResponse.ts +106 -0
- package/src/models/ListSubfoldersResponseFoldersInner.ts +108 -0
- package/src/models/ListTransformationsResponse.ts +82 -0
- package/src/models/LocationSegment.ts +74 -0
- package/src/models/LookupFontRequest.ts +74 -0
- package/src/models/LookupFontRequestFontsInner.ts +113 -0
- package/src/models/NamespaceTokenCreateErrorResponse.ts +66 -0
- package/src/models/NamespaceTokenCreateResponse.ts +66 -0
- package/src/models/PrepareUploadRequest.ts +73 -0
- package/src/models/PrepareUploadRequestUploadParams.ts +289 -0
- package/src/models/PrepareUploadResponse.ts +100 -0
- package/src/models/ProvisionFontRequest.ts +82 -0
- package/src/models/RefreshTokenErrorResponse.ts +66 -0
- package/src/models/RefreshTokenResponse.ts +66 -0
- package/src/models/RemoveCollectionAssetsRequest.ts +73 -0
- package/src/models/RemoveCollectionAssetsResponse.ts +74 -0
- package/src/models/ResourceActor.ts +75 -0
- package/src/models/SearchAsset.ts +402 -0
- package/src/models/SearchCollectionsRequest.ts +97 -0
- package/src/models/SearchCollectionsResponse.ts +98 -0
- package/src/models/SetAppStorageValueRequest.ts +65 -0
- package/src/models/SignAndUploadRequest.ts +258 -0
- package/src/models/SignAndUploadRequest1.ts +258 -0
- package/src/models/SignAndUploadResponse.ts +196 -0
- package/src/models/StructuredMetadataField.ts +113 -0
- package/src/models/TemplateResourceTuple.ts +90 -0
- package/src/models/TemplateSearchResponse.ts +110 -0
- package/src/models/ThumbnailsTokenResponse.ts +84 -0
- package/src/models/TrackAnalyticsEventRequest.ts +66 -0
- package/src/models/Transformation.ts +129 -0
- package/src/models/UpdateAppRequest.ts +73 -0
- package/src/models/UpdateAssetBackreferencesRequest.ts +112 -0
- package/src/models/UpdateAssetMetadataRequest.ts +90 -0
- package/src/models/UpdateAssetMetadataRequestMetadataValue.ts +46 -0
- package/src/models/UpdateAssetMetadataResponse.ts +90 -0
- package/src/models/UpdateAssetTagsRequest.ts +95 -0
- package/src/models/UpdateAssetTagsResponse.ts +66 -0
- package/src/models/UpdateBackreferencesResponse.ts +74 -0
- package/src/models/UpdateCollectionRequest.ts +81 -0
- package/src/models/UpdateCollectionResponse.ts +74 -0
- package/src/models/UploadAssetRequest.ts +196 -0
- package/src/models/UploadAssetRequest1.ts +196 -0
- package/src/models/UploadAssetResponse.ts +196 -0
- package/src/models/ValidateTokenResponse.ts +66 -0
- package/src/models/index.ts +129 -0
- package/src/runtime.ts +432 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,1454 @@
|
|
|
1
|
+
# ConsoleApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**deprecatedDeleteCloudinaryConsoleFoldersId**](ConsoleApi.md#deprecateddeletecloudinaryconsolefoldersid) | **DELETE** /cloudinary/console/folders/{id} | Deletes a folder by its external ID. Fails upstream if the folder still contains assets. |
|
|
8
|
+
| [**deprecatedGetCloudinaryConsoleAuthCredentials**](ConsoleApi.md#deprecatedgetcloudinaryconsoleauthcredentials) | **GET** /cloudinary/console/auth/credentials | Get current user and cloud credentials |
|
|
9
|
+
| [**deprecatedGetCloudinaryConsoleAutocomplete**](ConsoleApi.md#deprecatedgetcloudinaryconsoleautocomplete) | **GET** /cloudinary/console/autocomplete | Autocomplete for assets, folders, collections tags and metadata-field-options search |
|
|
10
|
+
| [**deprecatedGetCloudinaryConsoleCustomers**](ConsoleApi.md#deprecatedgetcloudinaryconsolecustomers) | **GET** /cloudinary/console/customers | Lists customers |
|
|
11
|
+
| [**deprecatedGetCloudinaryConsoleFoldersSubfolders**](ConsoleApi.md#deprecatedgetcloudinaryconsolefolderssubfolders) | **GET** /cloudinary/console/folders/subfolders | Lists folders in path |
|
|
12
|
+
| [**deprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudName**](ConsoleApi.md#deprecatedgetcloudinaryconsolehandlerscustomersbycloudcloudname) | **GET** /cloudinary/console/handlers/customers/by_cloud/{cloud_name} | customer by cloud |
|
|
13
|
+
| [**deprecatedGetCloudinaryConsoleHandlersMetadataContextFields**](ConsoleApi.md#deprecatedgetcloudinaryconsolehandlersmetadatacontextfields) | **GET** /cloudinary/console/handlers/metadata/context-fields | List contextual metadata fields |
|
|
14
|
+
| [**deprecatedGetCloudinaryConsoleHandlersMetadataFields**](ConsoleApi.md#deprecatedgetcloudinaryconsolehandlersmetadatafields) | **GET** /cloudinary/console/handlers/metadata/fields | List structured metadata fields |
|
|
15
|
+
| [**deprecatedGetCloudinaryConsoleRestResourcesByFolder**](ConsoleApi.md#deprecatedgetcloudinaryconsolerestresourcesbyfolder) | **GET** /cloudinary/console/rest_resources/by_folder | Lists resources in a folder |
|
|
16
|
+
| [**deprecatedGetCloudinaryConsoleTransformations**](ConsoleApi.md#deprecatedgetcloudinaryconsoletransformations) | **GET** /cloudinary/console/transformations | List of named Transformations |
|
|
17
|
+
| [**deprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariant**](ConsoleApi.md#deprecatedgetcloudinaryresconsolethumbnailscloudnameresourcetypetypeversionvariant) | **GET** /cloudinary/res-console/thumbnails/{cloud_name}/{resource_type}/{type}/{version}/{variant} | res console |
|
|
18
|
+
| [**deprecatedPatchCloudinaryConsoleHandlersAssetMetadata**](ConsoleApi.md#deprecatedpatchcloudinaryconsolehandlersassetmetadata) | **PATCH** /cloudinary/console/handlers/asset/metadata | res console |
|
|
19
|
+
| [**deprecatedPostCloudinaryConsoleAuthPrepareUpload**](ConsoleApi.md#deprecatedpostcloudinaryconsoleauthprepareupload) | **POST** /cloudinary/console/auth/prepare_upload | Get current user and cloud credentials |
|
|
20
|
+
| [**deprecatedPostCloudinaryConsoleAuthThumbnailsToken**](ConsoleApi.md#deprecatedpostcloudinaryconsoleauththumbnailstoken) | **POST** /cloudinary/console/auth/thumbnails_token | Get thumbnail token |
|
|
21
|
+
| [**deprecatedPostCloudinaryConsoleFolders**](ConsoleApi.md#deprecatedpostcloudinaryconsolefolders) | **POST** /cloudinary/console/folders | Creates a new subfolder under the specified parent folder, or under root if no parent is given.2 |
|
|
22
|
+
| [**deprecatedPostCloudinaryConsoleHandlersSignAndUpload**](ConsoleApi.md#deprecatedpostcloudinaryconsolehandlerssignandupload) | **POST** /cloudinary/console/handlers/sign_and_upload | Sign and upload an asset to Cloudinary |
|
|
23
|
+
| [**deprecatedPostCloudinaryConsoleOperationsDownload**](ConsoleApi.md#deprecatedpostcloudinaryconsoleoperationsdownload) | **POST** /cloudinary/console/operations/download | Downloads a resource |
|
|
24
|
+
| [**deprecatedPostCloudinaryConsoleSearch**](ConsoleApi.md#deprecatedpostcloudinaryconsolesearch) | **POST** /cloudinary/console/search | Search resources |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## deprecatedDeleteCloudinaryConsoleFoldersId
|
|
29
|
+
|
|
30
|
+
> DeleteFolderResponse deprecatedDeleteCloudinaryConsoleFoldersId(id, deleteResources)
|
|
31
|
+
|
|
32
|
+
Deletes a folder by its external ID. Fails upstream if the folder still contains assets.
|
|
33
|
+
|
|
34
|
+
### Example
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
import {
|
|
38
|
+
Configuration,
|
|
39
|
+
ConsoleApi,
|
|
40
|
+
} from '@cloudinary/apps-api';
|
|
41
|
+
import type { DeprecatedDeleteCloudinaryConsoleFoldersIdRequest } from '@cloudinary/apps-api';
|
|
42
|
+
|
|
43
|
+
async function example() {
|
|
44
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
45
|
+
const config = new Configuration({
|
|
46
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
47
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
48
|
+
});
|
|
49
|
+
const api = new ConsoleApi(config);
|
|
50
|
+
|
|
51
|
+
const body = {
|
|
52
|
+
// string
|
|
53
|
+
id: id_example,
|
|
54
|
+
// boolean (optional)
|
|
55
|
+
deleteResources: true,
|
|
56
|
+
} satisfies DeprecatedDeleteCloudinaryConsoleFoldersIdRequest;
|
|
57
|
+
|
|
58
|
+
try {
|
|
59
|
+
const data = await api.deprecatedDeleteCloudinaryConsoleFoldersId(body);
|
|
60
|
+
console.log(data);
|
|
61
|
+
} catch (error) {
|
|
62
|
+
console.error(error);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// Run the test
|
|
67
|
+
example().catch(console.error);
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
| Name | Type | Description | Notes |
|
|
74
|
+
|------------- | ------------- | ------------- | -------------|
|
|
75
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
76
|
+
| **deleteResources** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
77
|
+
|
|
78
|
+
### Return type
|
|
79
|
+
|
|
80
|
+
[**DeleteFolderResponse**](DeleteFolderResponse.md)
|
|
81
|
+
|
|
82
|
+
### Authorization
|
|
83
|
+
|
|
84
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
85
|
+
|
|
86
|
+
### HTTP request headers
|
|
87
|
+
|
|
88
|
+
- **Content-Type**: Not defined
|
|
89
|
+
- **Accept**: `application/json`
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### HTTP response details
|
|
93
|
+
| Status code | Description | Response headers |
|
|
94
|
+
|-------------|-------------|------------------|
|
|
95
|
+
| **200** | Successful operation | - |
|
|
96
|
+
|
|
97
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## deprecatedGetCloudinaryConsoleAuthCredentials
|
|
101
|
+
|
|
102
|
+
> AuthCredentialsResponse deprecatedGetCloudinaryConsoleAuthCredentials()
|
|
103
|
+
|
|
104
|
+
Get current user and cloud credentials
|
|
105
|
+
|
|
106
|
+
### Example
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import {
|
|
110
|
+
Configuration,
|
|
111
|
+
ConsoleApi,
|
|
112
|
+
} from '@cloudinary/apps-api';
|
|
113
|
+
import type { DeprecatedGetCloudinaryConsoleAuthCredentialsRequest } from '@cloudinary/apps-api';
|
|
114
|
+
|
|
115
|
+
async function example() {
|
|
116
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
117
|
+
const config = new Configuration({
|
|
118
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
119
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
120
|
+
});
|
|
121
|
+
const api = new ConsoleApi(config);
|
|
122
|
+
|
|
123
|
+
try {
|
|
124
|
+
const data = await api.deprecatedGetCloudinaryConsoleAuthCredentials();
|
|
125
|
+
console.log(data);
|
|
126
|
+
} catch (error) {
|
|
127
|
+
console.error(error);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
// Run the test
|
|
132
|
+
example().catch(console.error);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
This endpoint does not need any parameter.
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**AuthCredentialsResponse**](AuthCredentialsResponse.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: Not defined
|
|
150
|
+
- **Accept**: `application/json`
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
### HTTP response details
|
|
154
|
+
| Status code | Description | Response headers |
|
|
155
|
+
|-------------|-------------|------------------|
|
|
156
|
+
| **200** | Successful authentication response with user identity and permissions | - |
|
|
157
|
+
|
|
158
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
## deprecatedGetCloudinaryConsoleAutocomplete
|
|
162
|
+
|
|
163
|
+
> AutocompleteResponse deprecatedGetCloudinaryConsoleAutocomplete(term, resourceType, assets, collections, folders, tags, users, withDeletedUsers, userGroups, metadataFieldOptions)
|
|
164
|
+
|
|
165
|
+
Autocomplete for assets, folders, collections tags and metadata-field-options search
|
|
166
|
+
|
|
167
|
+
\"assets\", \"collections\", \"folders\", \"tags\" and \"metadata_field_options\" value specifies the maximum number of results to return. If one of the params is not passed, autocomplete results for that type are not returned.
|
|
168
|
+
|
|
169
|
+
### Example
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
import {
|
|
173
|
+
Configuration,
|
|
174
|
+
ConsoleApi,
|
|
175
|
+
} from '@cloudinary/apps-api';
|
|
176
|
+
import type { DeprecatedGetCloudinaryConsoleAutocompleteRequest } from '@cloudinary/apps-api';
|
|
177
|
+
|
|
178
|
+
async function example() {
|
|
179
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
180
|
+
const config = new Configuration({
|
|
181
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
182
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
183
|
+
});
|
|
184
|
+
const api = new ConsoleApi(config);
|
|
185
|
+
|
|
186
|
+
const body = {
|
|
187
|
+
// string
|
|
188
|
+
term: term_example,
|
|
189
|
+
// 'image' | 'javascript' | 'css' | 'video' | 'raw' | 'any' (optional)
|
|
190
|
+
resourceType: resourceType_example,
|
|
191
|
+
// number (optional)
|
|
192
|
+
assets: 56,
|
|
193
|
+
// number (optional)
|
|
194
|
+
collections: 56,
|
|
195
|
+
// number (optional)
|
|
196
|
+
folders: 56,
|
|
197
|
+
// number (optional)
|
|
198
|
+
tags: 56,
|
|
199
|
+
// number (optional)
|
|
200
|
+
users: 56,
|
|
201
|
+
// boolean (optional)
|
|
202
|
+
withDeletedUsers: true,
|
|
203
|
+
// number (optional)
|
|
204
|
+
userGroups: 56,
|
|
205
|
+
// number (optional)
|
|
206
|
+
metadataFieldOptions: 56,
|
|
207
|
+
} satisfies DeprecatedGetCloudinaryConsoleAutocompleteRequest;
|
|
208
|
+
|
|
209
|
+
try {
|
|
210
|
+
const data = await api.deprecatedGetCloudinaryConsoleAutocomplete(body);
|
|
211
|
+
console.log(data);
|
|
212
|
+
} catch (error) {
|
|
213
|
+
console.error(error);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
// Run the test
|
|
218
|
+
example().catch(console.error);
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Parameters
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
| Name | Type | Description | Notes |
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **term** | `string` | | [Defaults to `undefined`] |
|
|
227
|
+
| **resourceType** | `image`, `javascript`, `css`, `video`, `raw`, `any` | | [Optional] [Defaults to `undefined`] [Enum: image, javascript, css, video, raw, any] |
|
|
228
|
+
| **assets** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
229
|
+
| **collections** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
230
|
+
| **folders** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
231
|
+
| **tags** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
232
|
+
| **users** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
233
|
+
| **withDeletedUsers** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
234
|
+
| **userGroups** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
235
|
+
| **metadataFieldOptions** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
236
|
+
|
|
237
|
+
### Return type
|
|
238
|
+
|
|
239
|
+
[**AutocompleteResponse**](AutocompleteResponse.md)
|
|
240
|
+
|
|
241
|
+
### Authorization
|
|
242
|
+
|
|
243
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
244
|
+
|
|
245
|
+
### HTTP request headers
|
|
246
|
+
|
|
247
|
+
- **Content-Type**: Not defined
|
|
248
|
+
- **Accept**: `application/json`
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
### HTTP response details
|
|
252
|
+
| Status code | Description | Response headers |
|
|
253
|
+
|-------------|-------------|------------------|
|
|
254
|
+
| **200** | Successful operation | - |
|
|
255
|
+
|
|
256
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
## deprecatedGetCloudinaryConsoleCustomers
|
|
260
|
+
|
|
261
|
+
> ListCustomersResponse deprecatedGetCloudinaryConsoleCustomers(nameContains, cloudName, product, sortBy, sortOrder)
|
|
262
|
+
|
|
263
|
+
Lists customers
|
|
264
|
+
|
|
265
|
+
### Example
|
|
266
|
+
|
|
267
|
+
```ts
|
|
268
|
+
import {
|
|
269
|
+
Configuration,
|
|
270
|
+
ConsoleApi,
|
|
271
|
+
} from '@cloudinary/apps-api';
|
|
272
|
+
import type { DeprecatedGetCloudinaryConsoleCustomersRequest } from '@cloudinary/apps-api';
|
|
273
|
+
|
|
274
|
+
async function example() {
|
|
275
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
276
|
+
const config = new Configuration({
|
|
277
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
278
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
279
|
+
});
|
|
280
|
+
const api = new ConsoleApi(config);
|
|
281
|
+
|
|
282
|
+
const body = {
|
|
283
|
+
// string (optional)
|
|
284
|
+
nameContains: nameContains_example,
|
|
285
|
+
// string (optional)
|
|
286
|
+
cloudName: cloudName_example,
|
|
287
|
+
// string (optional)
|
|
288
|
+
product: product_example,
|
|
289
|
+
// string (optional)
|
|
290
|
+
sortBy: sortBy_example,
|
|
291
|
+
// string (optional)
|
|
292
|
+
sortOrder: sortOrder_example,
|
|
293
|
+
} satisfies DeprecatedGetCloudinaryConsoleCustomersRequest;
|
|
294
|
+
|
|
295
|
+
try {
|
|
296
|
+
const data = await api.deprecatedGetCloudinaryConsoleCustomers(body);
|
|
297
|
+
console.log(data);
|
|
298
|
+
} catch (error) {
|
|
299
|
+
console.error(error);
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
// Run the test
|
|
304
|
+
example().catch(console.error);
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Parameters
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
| Name | Type | Description | Notes |
|
|
311
|
+
|------------- | ------------- | ------------- | -------------|
|
|
312
|
+
| **nameContains** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
313
|
+
| **cloudName** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
314
|
+
| **product** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
315
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
316
|
+
| **sortOrder** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
317
|
+
|
|
318
|
+
### Return type
|
|
319
|
+
|
|
320
|
+
[**ListCustomersResponse**](ListCustomersResponse.md)
|
|
321
|
+
|
|
322
|
+
### Authorization
|
|
323
|
+
|
|
324
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
325
|
+
|
|
326
|
+
### HTTP request headers
|
|
327
|
+
|
|
328
|
+
- **Content-Type**: Not defined
|
|
329
|
+
- **Accept**: `application/json`
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
### HTTP response details
|
|
333
|
+
| Status code | Description | Response headers |
|
|
334
|
+
|-------------|-------------|------------------|
|
|
335
|
+
| **200** | Successful operation | - |
|
|
336
|
+
|
|
337
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
## deprecatedGetCloudinaryConsoleFoldersSubfolders
|
|
341
|
+
|
|
342
|
+
> ListSubfoldersResponse deprecatedGetCloudinaryConsoleFoldersSubfolders(parentPath, externalId, maxResults, nextCursor)
|
|
343
|
+
|
|
344
|
+
Lists folders in path
|
|
345
|
+
|
|
346
|
+
### Example
|
|
347
|
+
|
|
348
|
+
```ts
|
|
349
|
+
import {
|
|
350
|
+
Configuration,
|
|
351
|
+
ConsoleApi,
|
|
352
|
+
} from '@cloudinary/apps-api';
|
|
353
|
+
import type { DeprecatedGetCloudinaryConsoleFoldersSubfoldersRequest } from '@cloudinary/apps-api';
|
|
354
|
+
|
|
355
|
+
async function example() {
|
|
356
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
357
|
+
const config = new Configuration({
|
|
358
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
359
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
360
|
+
});
|
|
361
|
+
const api = new ConsoleApi(config);
|
|
362
|
+
|
|
363
|
+
const body = {
|
|
364
|
+
// string (optional)
|
|
365
|
+
parentPath: parentPath_example,
|
|
366
|
+
// string (optional)
|
|
367
|
+
externalId: externalId_example,
|
|
368
|
+
// number (optional)
|
|
369
|
+
maxResults: 56,
|
|
370
|
+
// string (optional)
|
|
371
|
+
nextCursor: nextCursor_example,
|
|
372
|
+
} satisfies DeprecatedGetCloudinaryConsoleFoldersSubfoldersRequest;
|
|
373
|
+
|
|
374
|
+
try {
|
|
375
|
+
const data = await api.deprecatedGetCloudinaryConsoleFoldersSubfolders(body);
|
|
376
|
+
console.log(data);
|
|
377
|
+
} catch (error) {
|
|
378
|
+
console.error(error);
|
|
379
|
+
}
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
// Run the test
|
|
383
|
+
example().catch(console.error);
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Parameters
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
| Name | Type | Description | Notes |
|
|
390
|
+
|------------- | ------------- | ------------- | -------------|
|
|
391
|
+
| **parentPath** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
392
|
+
| **externalId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
393
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
394
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `''`] |
|
|
395
|
+
|
|
396
|
+
### Return type
|
|
397
|
+
|
|
398
|
+
[**ListSubfoldersResponse**](ListSubfoldersResponse.md)
|
|
399
|
+
|
|
400
|
+
### Authorization
|
|
401
|
+
|
|
402
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
403
|
+
|
|
404
|
+
### HTTP request headers
|
|
405
|
+
|
|
406
|
+
- **Content-Type**: Not defined
|
|
407
|
+
- **Accept**: `application/json`
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
### HTTP response details
|
|
411
|
+
| Status code | Description | Response headers |
|
|
412
|
+
|-------------|-------------|------------------|
|
|
413
|
+
| **200** | Successful operation | - |
|
|
414
|
+
|
|
415
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
## deprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudName
|
|
419
|
+
|
|
420
|
+
> Customer deprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudName(cloudName)
|
|
421
|
+
|
|
422
|
+
customer by cloud
|
|
423
|
+
|
|
424
|
+
get a customer by cloud name
|
|
425
|
+
|
|
426
|
+
### Example
|
|
427
|
+
|
|
428
|
+
```ts
|
|
429
|
+
import {
|
|
430
|
+
Configuration,
|
|
431
|
+
ConsoleApi,
|
|
432
|
+
} from '@cloudinary/apps-api';
|
|
433
|
+
import type { DeprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudNameRequest } from '@cloudinary/apps-api';
|
|
434
|
+
|
|
435
|
+
async function example() {
|
|
436
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
437
|
+
const config = new Configuration({
|
|
438
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
439
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
440
|
+
});
|
|
441
|
+
const api = new ConsoleApi(config);
|
|
442
|
+
|
|
443
|
+
const body = {
|
|
444
|
+
// string
|
|
445
|
+
cloudName: cloudName_example,
|
|
446
|
+
} satisfies DeprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudNameRequest;
|
|
447
|
+
|
|
448
|
+
try {
|
|
449
|
+
const data = await api.deprecatedGetCloudinaryConsoleHandlersCustomersByCloudCloudName(body);
|
|
450
|
+
console.log(data);
|
|
451
|
+
} catch (error) {
|
|
452
|
+
console.error(error);
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
// Run the test
|
|
457
|
+
example().catch(console.error);
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
### Parameters
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
| Name | Type | Description | Notes |
|
|
464
|
+
|------------- | ------------- | ------------- | -------------|
|
|
465
|
+
| **cloudName** | `string` | | [Defaults to `undefined`] |
|
|
466
|
+
|
|
467
|
+
### Return type
|
|
468
|
+
|
|
469
|
+
[**Customer**](Customer.md)
|
|
470
|
+
|
|
471
|
+
### Authorization
|
|
472
|
+
|
|
473
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
474
|
+
|
|
475
|
+
### HTTP request headers
|
|
476
|
+
|
|
477
|
+
- **Content-Type**: Not defined
|
|
478
|
+
- **Accept**: `application/json`
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
### HTTP response details
|
|
482
|
+
| Status code | Description | Response headers |
|
|
483
|
+
|-------------|-------------|------------------|
|
|
484
|
+
| **200** | Successful operation | - |
|
|
485
|
+
|
|
486
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
## deprecatedGetCloudinaryConsoleHandlersMetadataContextFields
|
|
490
|
+
|
|
491
|
+
> ListContextualMetadataFieldsResponse deprecatedGetCloudinaryConsoleHandlersMetadataContextFields(maxResults, nextCursor, prefix)
|
|
492
|
+
|
|
493
|
+
List contextual metadata fields
|
|
494
|
+
|
|
495
|
+
List contextual metadata keys in use across assets in the cloud
|
|
496
|
+
|
|
497
|
+
### Example
|
|
498
|
+
|
|
499
|
+
```ts
|
|
500
|
+
import {
|
|
501
|
+
Configuration,
|
|
502
|
+
ConsoleApi,
|
|
503
|
+
} from '@cloudinary/apps-api';
|
|
504
|
+
import type { DeprecatedGetCloudinaryConsoleHandlersMetadataContextFieldsRequest } from '@cloudinary/apps-api';
|
|
505
|
+
|
|
506
|
+
async function example() {
|
|
507
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
508
|
+
const config = new Configuration({
|
|
509
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
510
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
511
|
+
});
|
|
512
|
+
const api = new ConsoleApi(config);
|
|
513
|
+
|
|
514
|
+
const body = {
|
|
515
|
+
// number (optional)
|
|
516
|
+
maxResults: 56,
|
|
517
|
+
// string (optional)
|
|
518
|
+
nextCursor: nextCursor_example,
|
|
519
|
+
// string (optional)
|
|
520
|
+
prefix: prefix_example,
|
|
521
|
+
} satisfies DeprecatedGetCloudinaryConsoleHandlersMetadataContextFieldsRequest;
|
|
522
|
+
|
|
523
|
+
try {
|
|
524
|
+
const data = await api.deprecatedGetCloudinaryConsoleHandlersMetadataContextFields(body);
|
|
525
|
+
console.log(data);
|
|
526
|
+
} catch (error) {
|
|
527
|
+
console.error(error);
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
// Run the test
|
|
532
|
+
example().catch(console.error);
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
### Parameters
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
| Name | Type | Description | Notes |
|
|
539
|
+
|------------- | ------------- | ------------- | -------------|
|
|
540
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `50`] |
|
|
541
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
542
|
+
| **prefix** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
543
|
+
|
|
544
|
+
### Return type
|
|
545
|
+
|
|
546
|
+
[**ListContextualMetadataFieldsResponse**](ListContextualMetadataFieldsResponse.md)
|
|
547
|
+
|
|
548
|
+
### Authorization
|
|
549
|
+
|
|
550
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
551
|
+
|
|
552
|
+
### HTTP request headers
|
|
553
|
+
|
|
554
|
+
- **Content-Type**: Not defined
|
|
555
|
+
- **Accept**: `application/json`
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
### HTTP response details
|
|
559
|
+
| Status code | Description | Response headers |
|
|
560
|
+
|-------------|-------------|------------------|
|
|
561
|
+
| **200** | Successful operation | - |
|
|
562
|
+
|
|
563
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
## deprecatedGetCloudinaryConsoleHandlersMetadataFields
|
|
567
|
+
|
|
568
|
+
> ListMetadataFieldsResponse deprecatedGetCloudinaryConsoleHandlersMetadataFields()
|
|
569
|
+
|
|
570
|
+
List structured metadata fields
|
|
571
|
+
|
|
572
|
+
List all available structured metadata field definitions
|
|
573
|
+
|
|
574
|
+
### Example
|
|
575
|
+
|
|
576
|
+
```ts
|
|
577
|
+
import {
|
|
578
|
+
Configuration,
|
|
579
|
+
ConsoleApi,
|
|
580
|
+
} from '@cloudinary/apps-api';
|
|
581
|
+
import type { DeprecatedGetCloudinaryConsoleHandlersMetadataFieldsRequest } from '@cloudinary/apps-api';
|
|
582
|
+
|
|
583
|
+
async function example() {
|
|
584
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
585
|
+
const config = new Configuration({
|
|
586
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
587
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
588
|
+
});
|
|
589
|
+
const api = new ConsoleApi(config);
|
|
590
|
+
|
|
591
|
+
try {
|
|
592
|
+
const data = await api.deprecatedGetCloudinaryConsoleHandlersMetadataFields();
|
|
593
|
+
console.log(data);
|
|
594
|
+
} catch (error) {
|
|
595
|
+
console.error(error);
|
|
596
|
+
}
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
// Run the test
|
|
600
|
+
example().catch(console.error);
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
### Parameters
|
|
604
|
+
|
|
605
|
+
This endpoint does not need any parameter.
|
|
606
|
+
|
|
607
|
+
### Return type
|
|
608
|
+
|
|
609
|
+
[**ListMetadataFieldsResponse**](ListMetadataFieldsResponse.md)
|
|
610
|
+
|
|
611
|
+
### Authorization
|
|
612
|
+
|
|
613
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
614
|
+
|
|
615
|
+
### HTTP request headers
|
|
616
|
+
|
|
617
|
+
- **Content-Type**: Not defined
|
|
618
|
+
- **Accept**: `application/json`
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
### HTTP response details
|
|
622
|
+
| Status code | Description | Response headers |
|
|
623
|
+
|-------------|-------------|------------------|
|
|
624
|
+
| **200** | Successful operation | - |
|
|
625
|
+
|
|
626
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
## deprecatedGetCloudinaryConsoleRestResourcesByFolder
|
|
630
|
+
|
|
631
|
+
> ListAssetsByFolderResponse deprecatedGetCloudinaryConsoleRestResourcesByFolder(folderId, resourceType, sortBy, maxResults, nextCursor)
|
|
632
|
+
|
|
633
|
+
Lists resources in a folder
|
|
634
|
+
|
|
635
|
+
Lists Console resources by folder using the Console rest_resources/by_folder API.
|
|
636
|
+
|
|
637
|
+
### Example
|
|
638
|
+
|
|
639
|
+
```ts
|
|
640
|
+
import {
|
|
641
|
+
Configuration,
|
|
642
|
+
ConsoleApi,
|
|
643
|
+
} from '@cloudinary/apps-api';
|
|
644
|
+
import type { DeprecatedGetCloudinaryConsoleRestResourcesByFolderRequest } from '@cloudinary/apps-api';
|
|
645
|
+
|
|
646
|
+
async function example() {
|
|
647
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
648
|
+
const config = new Configuration({
|
|
649
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
650
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
651
|
+
});
|
|
652
|
+
const api = new ConsoleApi(config);
|
|
653
|
+
|
|
654
|
+
const body = {
|
|
655
|
+
// string (optional)
|
|
656
|
+
folderId: folderId_example,
|
|
657
|
+
// 'image' | 'javascript' | 'css' | 'video' | 'raw' | 'any' (optional)
|
|
658
|
+
resourceType: resourceType_example,
|
|
659
|
+
// string (optional)
|
|
660
|
+
sortBy: sortBy_example,
|
|
661
|
+
// number (optional)
|
|
662
|
+
maxResults: 56,
|
|
663
|
+
// string (optional)
|
|
664
|
+
nextCursor: nextCursor_example,
|
|
665
|
+
} satisfies DeprecatedGetCloudinaryConsoleRestResourcesByFolderRequest;
|
|
666
|
+
|
|
667
|
+
try {
|
|
668
|
+
const data = await api.deprecatedGetCloudinaryConsoleRestResourcesByFolder(body);
|
|
669
|
+
console.log(data);
|
|
670
|
+
} catch (error) {
|
|
671
|
+
console.error(error);
|
|
672
|
+
}
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
// Run the test
|
|
676
|
+
example().catch(console.error);
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
### Parameters
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
| Name | Type | Description | Notes |
|
|
683
|
+
|------------- | ------------- | ------------- | -------------|
|
|
684
|
+
| **folderId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
685
|
+
| **resourceType** | `image`, `javascript`, `css`, `video`, `raw`, `any` | | [Optional] [Defaults to `undefined`] [Enum: image, javascript, css, video, raw, any] |
|
|
686
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
687
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
688
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
689
|
+
|
|
690
|
+
### Return type
|
|
691
|
+
|
|
692
|
+
[**ListAssetsByFolderResponse**](ListAssetsByFolderResponse.md)
|
|
693
|
+
|
|
694
|
+
### Authorization
|
|
695
|
+
|
|
696
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
697
|
+
|
|
698
|
+
### HTTP request headers
|
|
699
|
+
|
|
700
|
+
- **Content-Type**: Not defined
|
|
701
|
+
- **Accept**: `application/json`
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
### HTTP response details
|
|
705
|
+
| Status code | Description | Response headers |
|
|
706
|
+
|-------------|-------------|------------------|
|
|
707
|
+
| **200** | Successful operation | - |
|
|
708
|
+
|
|
709
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
## deprecatedGetCloudinaryConsoleTransformations
|
|
713
|
+
|
|
714
|
+
> ListTransformationsResponse deprecatedGetCloudinaryConsoleTransformations(maxResults, nextCursor, name)
|
|
715
|
+
|
|
716
|
+
List of named Transformations
|
|
717
|
+
|
|
718
|
+
### Example
|
|
719
|
+
|
|
720
|
+
```ts
|
|
721
|
+
import {
|
|
722
|
+
Configuration,
|
|
723
|
+
ConsoleApi,
|
|
724
|
+
} from '@cloudinary/apps-api';
|
|
725
|
+
import type { DeprecatedGetCloudinaryConsoleTransformationsRequest } from '@cloudinary/apps-api';
|
|
726
|
+
|
|
727
|
+
async function example() {
|
|
728
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
729
|
+
const config = new Configuration({
|
|
730
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
731
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
732
|
+
});
|
|
733
|
+
const api = new ConsoleApi(config);
|
|
734
|
+
|
|
735
|
+
const body = {
|
|
736
|
+
// number (optional)
|
|
737
|
+
maxResults: 56,
|
|
738
|
+
// string (optional)
|
|
739
|
+
nextCursor: nextCursor_example,
|
|
740
|
+
// string (optional)
|
|
741
|
+
name: name_example,
|
|
742
|
+
} satisfies DeprecatedGetCloudinaryConsoleTransformationsRequest;
|
|
743
|
+
|
|
744
|
+
try {
|
|
745
|
+
const data = await api.deprecatedGetCloudinaryConsoleTransformations(body);
|
|
746
|
+
console.log(data);
|
|
747
|
+
} catch (error) {
|
|
748
|
+
console.error(error);
|
|
749
|
+
}
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
// Run the test
|
|
753
|
+
example().catch(console.error);
|
|
754
|
+
```
|
|
755
|
+
|
|
756
|
+
### Parameters
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
| Name | Type | Description | Notes |
|
|
760
|
+
|------------- | ------------- | ------------- | -------------|
|
|
761
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
762
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
763
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
764
|
+
|
|
765
|
+
### Return type
|
|
766
|
+
|
|
767
|
+
[**ListTransformationsResponse**](ListTransformationsResponse.md)
|
|
768
|
+
|
|
769
|
+
### Authorization
|
|
770
|
+
|
|
771
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
772
|
+
|
|
773
|
+
### HTTP request headers
|
|
774
|
+
|
|
775
|
+
- **Content-Type**: Not defined
|
|
776
|
+
- **Accept**: `application/json`
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### HTTP response details
|
|
780
|
+
| Status code | Description | Response headers |
|
|
781
|
+
|-------------|-------------|------------------|
|
|
782
|
+
| **200** | Successful operation | - |
|
|
783
|
+
|
|
784
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
## deprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariant
|
|
788
|
+
|
|
789
|
+
> string deprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariant(resourceType, type, version, cloudName, variant, publicId, token)
|
|
790
|
+
|
|
791
|
+
res console
|
|
792
|
+
|
|
793
|
+
thumbnail
|
|
794
|
+
|
|
795
|
+
### Example
|
|
796
|
+
|
|
797
|
+
```ts
|
|
798
|
+
import {
|
|
799
|
+
Configuration,
|
|
800
|
+
ConsoleApi,
|
|
801
|
+
} from '@cloudinary/apps-api';
|
|
802
|
+
import type { DeprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariantRequest } from '@cloudinary/apps-api';
|
|
803
|
+
|
|
804
|
+
async function example() {
|
|
805
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
806
|
+
const config = new Configuration({
|
|
807
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
808
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
809
|
+
});
|
|
810
|
+
const api = new ConsoleApi(config);
|
|
811
|
+
|
|
812
|
+
const body = {
|
|
813
|
+
// 'image' | 'video' | 'raw'
|
|
814
|
+
resourceType: resourceType_example,
|
|
815
|
+
// 'upload' | 'private' | 'authenticated'
|
|
816
|
+
type: type_example,
|
|
817
|
+
// string
|
|
818
|
+
version: version_example,
|
|
819
|
+
// string
|
|
820
|
+
cloudName: cloudName_example,
|
|
821
|
+
// 'grid' | 'grid_landscape' | 'grid_square' | 'grid_animated_landscape' | 'grid_animated_square' | 'preview' | 'drilldown' | 'template' | 'template_primary' | 'folder_thumbnail' | 'get_info' | 'list' | 'list_v2' | 'square90' | 'grid_preview' | 'grid_large_preview' | 'grid_large_preview_v2' | 'asset_picker_grid' | 'grid_video_square' | 'grid_video_landscape' | 'media_editor_widget' | 'play_video' | 'hls_video_preview' | 'video_segment' | 'video_stream' | 'audio_stream' | 'audio_segment'
|
|
822
|
+
variant: variant_example,
|
|
823
|
+
// string
|
|
824
|
+
publicId: publicId_example,
|
|
825
|
+
// string (optional)
|
|
826
|
+
token: token_example,
|
|
827
|
+
} satisfies DeprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariantRequest;
|
|
828
|
+
|
|
829
|
+
try {
|
|
830
|
+
const data = await api.deprecatedGetCloudinaryResConsoleThumbnailsCloudNameResourceTypeTypeVersionVariant(body);
|
|
831
|
+
console.log(data);
|
|
832
|
+
} catch (error) {
|
|
833
|
+
console.error(error);
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
// Run the test
|
|
838
|
+
example().catch(console.error);
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
### Parameters
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
| Name | Type | Description | Notes |
|
|
845
|
+
|------------- | ------------- | ------------- | -------------|
|
|
846
|
+
| **resourceType** | `image`, `video`, `raw` | | [Defaults to `undefined`] [Enum: image, video, raw] |
|
|
847
|
+
| **type** | `upload`, `private`, `authenticated` | | [Defaults to `undefined`] [Enum: upload, private, authenticated] |
|
|
848
|
+
| **version** | `string` | | [Defaults to `undefined`] |
|
|
849
|
+
| **cloudName** | `string` | | [Defaults to `undefined`] |
|
|
850
|
+
| **variant** | `grid`, `grid_landscape`, `grid_square`, `grid_animated_landscape`, `grid_animated_square`, `preview`, `drilldown`, `template`, `template_primary`, `folder_thumbnail`, `get_info`, `list`, `list_v2`, `square90`, `grid_preview`, `grid_large_preview`, `grid_large_preview_v2`, `asset_picker_grid`, `grid_video_square`, `grid_video_landscape`, `media_editor_widget`, `play_video`, `hls_video_preview`, `video_segment`, `video_stream`, `audio_stream`, `audio_segment` | | [Defaults to `undefined`] [Enum: grid, grid_landscape, grid_square, grid_animated_landscape, grid_animated_square, preview, drilldown, template, template_primary, folder_thumbnail, get_info, list, list_v2, square90, grid_preview, grid_large_preview, grid_large_preview_v2, asset_picker_grid, grid_video_square, grid_video_landscape, media_editor_widget, play_video, hls_video_preview, video_segment, video_stream, audio_stream, audio_segment] |
|
|
851
|
+
| **publicId** | `string` | | [Defaults to `undefined`] |
|
|
852
|
+
| **token** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
853
|
+
|
|
854
|
+
### Return type
|
|
855
|
+
|
|
856
|
+
**string**
|
|
857
|
+
|
|
858
|
+
### Authorization
|
|
859
|
+
|
|
860
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
861
|
+
|
|
862
|
+
### HTTP request headers
|
|
863
|
+
|
|
864
|
+
- **Content-Type**: Not defined
|
|
865
|
+
- **Accept**: `image/jpeg`, `application/json`
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
### HTTP response details
|
|
869
|
+
| Status code | Description | Response headers |
|
|
870
|
+
|-------------|-------------|------------------|
|
|
871
|
+
| **200** | Thumbnail image binary | - |
|
|
872
|
+
| **400** | Bad request - missing cloud name or public_id | - |
|
|
873
|
+
| **502** | Upstream thumbnail service error | - |
|
|
874
|
+
|
|
875
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
## deprecatedPatchCloudinaryConsoleHandlersAssetMetadata
|
|
879
|
+
|
|
880
|
+
> UpdateAssetMetadataResponse deprecatedPatchCloudinaryConsoleHandlersAssetMetadata(updateAssetMetadataRequest)
|
|
881
|
+
|
|
882
|
+
res console
|
|
883
|
+
|
|
884
|
+
update metadata
|
|
885
|
+
|
|
886
|
+
### Example
|
|
887
|
+
|
|
888
|
+
```ts
|
|
889
|
+
import {
|
|
890
|
+
Configuration,
|
|
891
|
+
ConsoleApi,
|
|
892
|
+
} from '@cloudinary/apps-api';
|
|
893
|
+
import type { DeprecatedPatchCloudinaryConsoleHandlersAssetMetadataRequest } from '@cloudinary/apps-api';
|
|
894
|
+
|
|
895
|
+
async function example() {
|
|
896
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
897
|
+
const config = new Configuration({
|
|
898
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
899
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
900
|
+
});
|
|
901
|
+
const api = new ConsoleApi(config);
|
|
902
|
+
|
|
903
|
+
const body = {
|
|
904
|
+
// UpdateAssetMetadataRequest (optional)
|
|
905
|
+
updateAssetMetadataRequest: ...,
|
|
906
|
+
} satisfies DeprecatedPatchCloudinaryConsoleHandlersAssetMetadataRequest;
|
|
907
|
+
|
|
908
|
+
try {
|
|
909
|
+
const data = await api.deprecatedPatchCloudinaryConsoleHandlersAssetMetadata(body);
|
|
910
|
+
console.log(data);
|
|
911
|
+
} catch (error) {
|
|
912
|
+
console.error(error);
|
|
913
|
+
}
|
|
914
|
+
}
|
|
915
|
+
|
|
916
|
+
// Run the test
|
|
917
|
+
example().catch(console.error);
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
### Parameters
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
| Name | Type | Description | Notes |
|
|
924
|
+
|------------- | ------------- | ------------- | -------------|
|
|
925
|
+
| **updateAssetMetadataRequest** | [UpdateAssetMetadataRequest](UpdateAssetMetadataRequest.md) | | [Optional] |
|
|
926
|
+
|
|
927
|
+
### Return type
|
|
928
|
+
|
|
929
|
+
[**UpdateAssetMetadataResponse**](UpdateAssetMetadataResponse.md)
|
|
930
|
+
|
|
931
|
+
### Authorization
|
|
932
|
+
|
|
933
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
934
|
+
|
|
935
|
+
### HTTP request headers
|
|
936
|
+
|
|
937
|
+
- **Content-Type**: `application/json`
|
|
938
|
+
- **Accept**: `application/json`
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
### HTTP response details
|
|
942
|
+
| Status code | Description | Response headers |
|
|
943
|
+
|-------------|-------------|------------------|
|
|
944
|
+
| **200** | Successful operation | - |
|
|
945
|
+
|
|
946
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
## deprecatedPostCloudinaryConsoleAuthPrepareUpload
|
|
950
|
+
|
|
951
|
+
> PrepareUploadResponse deprecatedPostCloudinaryConsoleAuthPrepareUpload(prepareUploadRequest)
|
|
952
|
+
|
|
953
|
+
Get current user and cloud credentials
|
|
954
|
+
|
|
955
|
+
### Example
|
|
956
|
+
|
|
957
|
+
```ts
|
|
958
|
+
import {
|
|
959
|
+
Configuration,
|
|
960
|
+
ConsoleApi,
|
|
961
|
+
} from '@cloudinary/apps-api';
|
|
962
|
+
import type { DeprecatedPostCloudinaryConsoleAuthPrepareUploadRequest } from '@cloudinary/apps-api';
|
|
963
|
+
|
|
964
|
+
async function example() {
|
|
965
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
966
|
+
const config = new Configuration({
|
|
967
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
968
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
969
|
+
});
|
|
970
|
+
const api = new ConsoleApi(config);
|
|
971
|
+
|
|
972
|
+
const body = {
|
|
973
|
+
// PrepareUploadRequest (optional)
|
|
974
|
+
prepareUploadRequest: ...,
|
|
975
|
+
} satisfies DeprecatedPostCloudinaryConsoleAuthPrepareUploadRequest;
|
|
976
|
+
|
|
977
|
+
try {
|
|
978
|
+
const data = await api.deprecatedPostCloudinaryConsoleAuthPrepareUpload(body);
|
|
979
|
+
console.log(data);
|
|
980
|
+
} catch (error) {
|
|
981
|
+
console.error(error);
|
|
982
|
+
}
|
|
983
|
+
}
|
|
984
|
+
|
|
985
|
+
// Run the test
|
|
986
|
+
example().catch(console.error);
|
|
987
|
+
```
|
|
988
|
+
|
|
989
|
+
### Parameters
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
| Name | Type | Description | Notes |
|
|
993
|
+
|------------- | ------------- | ------------- | -------------|
|
|
994
|
+
| **prepareUploadRequest** | [PrepareUploadRequest](PrepareUploadRequest.md) | | [Optional] |
|
|
995
|
+
|
|
996
|
+
### Return type
|
|
997
|
+
|
|
998
|
+
[**PrepareUploadResponse**](PrepareUploadResponse.md)
|
|
999
|
+
|
|
1000
|
+
### Authorization
|
|
1001
|
+
|
|
1002
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: `application/json`
|
|
1007
|
+
- **Accept**: `application/json`
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
### HTTP response details
|
|
1011
|
+
| Status code | Description | Response headers |
|
|
1012
|
+
|-------------|-------------|------------------|
|
|
1013
|
+
| **200** | Successful authentication response with user identity and permissions | - |
|
|
1014
|
+
|
|
1015
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
## deprecatedPostCloudinaryConsoleAuthThumbnailsToken
|
|
1019
|
+
|
|
1020
|
+
> ThumbnailsTokenResponse deprecatedPostCloudinaryConsoleAuthThumbnailsToken(validFor)
|
|
1021
|
+
|
|
1022
|
+
Get thumbnail token
|
|
1023
|
+
|
|
1024
|
+
### Example
|
|
1025
|
+
|
|
1026
|
+
```ts
|
|
1027
|
+
import {
|
|
1028
|
+
Configuration,
|
|
1029
|
+
ConsoleApi,
|
|
1030
|
+
} from '@cloudinary/apps-api';
|
|
1031
|
+
import type { DeprecatedPostCloudinaryConsoleAuthThumbnailsTokenRequest } from '@cloudinary/apps-api';
|
|
1032
|
+
|
|
1033
|
+
async function example() {
|
|
1034
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1035
|
+
const config = new Configuration({
|
|
1036
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1037
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1038
|
+
});
|
|
1039
|
+
const api = new ConsoleApi(config);
|
|
1040
|
+
|
|
1041
|
+
const body = {
|
|
1042
|
+
// number (optional)
|
|
1043
|
+
validFor: 8.14,
|
|
1044
|
+
} satisfies DeprecatedPostCloudinaryConsoleAuthThumbnailsTokenRequest;
|
|
1045
|
+
|
|
1046
|
+
try {
|
|
1047
|
+
const data = await api.deprecatedPostCloudinaryConsoleAuthThumbnailsToken(body);
|
|
1048
|
+
console.log(data);
|
|
1049
|
+
} catch (error) {
|
|
1050
|
+
console.error(error);
|
|
1051
|
+
}
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
// Run the test
|
|
1055
|
+
example().catch(console.error);
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
### Parameters
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
| Name | Type | Description | Notes |
|
|
1062
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1063
|
+
| **validFor** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1064
|
+
|
|
1065
|
+
### Return type
|
|
1066
|
+
|
|
1067
|
+
[**ThumbnailsTokenResponse**](ThumbnailsTokenResponse.md)
|
|
1068
|
+
|
|
1069
|
+
### Authorization
|
|
1070
|
+
|
|
1071
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1072
|
+
|
|
1073
|
+
### HTTP request headers
|
|
1074
|
+
|
|
1075
|
+
- **Content-Type**: Not defined
|
|
1076
|
+
- **Accept**: `application/json`
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
### HTTP response details
|
|
1080
|
+
| Status code | Description | Response headers |
|
|
1081
|
+
|-------------|-------------|------------------|
|
|
1082
|
+
| **200** | Successful authentication response with user identity and permissions | - |
|
|
1083
|
+
|
|
1084
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
## deprecatedPostCloudinaryConsoleFolders
|
|
1088
|
+
|
|
1089
|
+
> CreateFolderResponse deprecatedPostCloudinaryConsoleFolders(createFolderRequest)
|
|
1090
|
+
|
|
1091
|
+
Creates a new subfolder under the specified parent folder, or under root if no parent is given.2
|
|
1092
|
+
|
|
1093
|
+
### Example
|
|
1094
|
+
|
|
1095
|
+
```ts
|
|
1096
|
+
import {
|
|
1097
|
+
Configuration,
|
|
1098
|
+
ConsoleApi,
|
|
1099
|
+
} from '@cloudinary/apps-api';
|
|
1100
|
+
import type { DeprecatedPostCloudinaryConsoleFoldersRequest } from '@cloudinary/apps-api';
|
|
1101
|
+
|
|
1102
|
+
async function example() {
|
|
1103
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1104
|
+
const config = new Configuration({
|
|
1105
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1106
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1107
|
+
});
|
|
1108
|
+
const api = new ConsoleApi(config);
|
|
1109
|
+
|
|
1110
|
+
const body = {
|
|
1111
|
+
// CreateFolderRequest (optional)
|
|
1112
|
+
createFolderRequest: ...,
|
|
1113
|
+
} satisfies DeprecatedPostCloudinaryConsoleFoldersRequest;
|
|
1114
|
+
|
|
1115
|
+
try {
|
|
1116
|
+
const data = await api.deprecatedPostCloudinaryConsoleFolders(body);
|
|
1117
|
+
console.log(data);
|
|
1118
|
+
} catch (error) {
|
|
1119
|
+
console.error(error);
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
// Run the test
|
|
1124
|
+
example().catch(console.error);
|
|
1125
|
+
```
|
|
1126
|
+
|
|
1127
|
+
### Parameters
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
| Name | Type | Description | Notes |
|
|
1131
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1132
|
+
| **createFolderRequest** | [CreateFolderRequest](CreateFolderRequest.md) | | [Optional] |
|
|
1133
|
+
|
|
1134
|
+
### Return type
|
|
1135
|
+
|
|
1136
|
+
[**CreateFolderResponse**](CreateFolderResponse.md)
|
|
1137
|
+
|
|
1138
|
+
### Authorization
|
|
1139
|
+
|
|
1140
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1141
|
+
|
|
1142
|
+
### HTTP request headers
|
|
1143
|
+
|
|
1144
|
+
- **Content-Type**: `application/json`
|
|
1145
|
+
- **Accept**: `application/json`
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
### HTTP response details
|
|
1149
|
+
| Status code | Description | Response headers |
|
|
1150
|
+
|-------------|-------------|------------------|
|
|
1151
|
+
| **200** | Successful operation | - |
|
|
1152
|
+
|
|
1153
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
## deprecatedPostCloudinaryConsoleHandlersSignAndUpload
|
|
1157
|
+
|
|
1158
|
+
> SignAndUploadResponse deprecatedPostCloudinaryConsoleHandlersSignAndUpload(file, resourceType, publicId, folder, assetFolder, tags, type, overwrite, invalidate, context, metadata, transformation, format, eager, eagerAsync, eagerNotificationUrl, notificationUrl, displayName, useFilename, uniqueFilename, filenameOverride, accessMode, discardOriginalFilename, phash, async)
|
|
1159
|
+
|
|
1160
|
+
Sign and upload an asset to Cloudinary
|
|
1161
|
+
|
|
1162
|
+
Signs the upload request via Console API and uploads to Cloudinary in a single operation. Accepts multipart/form-data (with binary file) or application/json (with URL or base64 data URI).
|
|
1163
|
+
|
|
1164
|
+
### Example
|
|
1165
|
+
|
|
1166
|
+
```ts
|
|
1167
|
+
import {
|
|
1168
|
+
Configuration,
|
|
1169
|
+
ConsoleApi,
|
|
1170
|
+
} from '@cloudinary/apps-api';
|
|
1171
|
+
import type { DeprecatedPostCloudinaryConsoleHandlersSignAndUploadRequest } from '@cloudinary/apps-api';
|
|
1172
|
+
|
|
1173
|
+
async function example() {
|
|
1174
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1175
|
+
const config = new Configuration({
|
|
1176
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1177
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1178
|
+
});
|
|
1179
|
+
const api = new ConsoleApi(config);
|
|
1180
|
+
|
|
1181
|
+
const body = {
|
|
1182
|
+
// Blob | The binary file to upload
|
|
1183
|
+
file: BINARY_DATA_HERE,
|
|
1184
|
+
// string | The type of resource (image, video, raw, auto). Defaults to auto (optional)
|
|
1185
|
+
resourceType: resourceType_example,
|
|
1186
|
+
// string | Custom public identifier for the uploaded asset (optional)
|
|
1187
|
+
publicId: publicId_example,
|
|
1188
|
+
// string | Folder name where the file should be stored (optional)
|
|
1189
|
+
folder: folder_example,
|
|
1190
|
+
// string | Asset folder path in the Cloudinary repository (optional)
|
|
1191
|
+
assetFolder: assetFolder_example,
|
|
1192
|
+
// string | Comma-separated list of tags (optional)
|
|
1193
|
+
tags: tags_example,
|
|
1194
|
+
// string | Storage/delivery type (upload, private, authenticated) (optional)
|
|
1195
|
+
type: type_example,
|
|
1196
|
+
// string | Whether to overwrite an existing asset (true/false) (optional)
|
|
1197
|
+
overwrite: overwrite_example,
|
|
1198
|
+
// string | Whether to invalidate CDN cache (true/false) (optional)
|
|
1199
|
+
invalidate: invalidate_example,
|
|
1200
|
+
// string | Pipe-separated contextual metadata (optional)
|
|
1201
|
+
context: context_example,
|
|
1202
|
+
// string | Pipe-separated structured metadata (optional)
|
|
1203
|
+
metadata: metadata_example,
|
|
1204
|
+
// string | Transformation to apply on upload (optional)
|
|
1205
|
+
transformation: transformation_example,
|
|
1206
|
+
// string | Format to convert to (optional)
|
|
1207
|
+
format: format_example,
|
|
1208
|
+
// string | Eager transformations to generate (optional)
|
|
1209
|
+
eager: eager_example,
|
|
1210
|
+
// string | Whether to generate eager transformations asynchronously (true/false) (optional)
|
|
1211
|
+
eagerAsync: eagerAsync_example,
|
|
1212
|
+
// string | Webhook URL for eager transformation completion (optional)
|
|
1213
|
+
eagerNotificationUrl: eagerNotificationUrl_example,
|
|
1214
|
+
// string | Webhook URL for upload completion (optional)
|
|
1215
|
+
notificationUrl: notificationUrl_example,
|
|
1216
|
+
// string | Display name for the asset (optional)
|
|
1217
|
+
displayName: displayName_example,
|
|
1218
|
+
// string | Use original filename as public_id (true/false) (optional)
|
|
1219
|
+
useFilename: useFilename_example,
|
|
1220
|
+
// string | Append random characters to filename (true/false) (optional)
|
|
1221
|
+
uniqueFilename: uniqueFilename_example,
|
|
1222
|
+
// string | Override the original filename metadata (optional)
|
|
1223
|
+
filenameOverride: filenameOverride_example,
|
|
1224
|
+
// string | Access mode (public, authenticated) (optional)
|
|
1225
|
+
accessMode: accessMode_example,
|
|
1226
|
+
// string | Whether to discard original filename (true/false) (optional)
|
|
1227
|
+
discardOriginalFilename: discardOriginalFilename_example,
|
|
1228
|
+
// string | Whether to return perceptual hash (true/false) (optional)
|
|
1229
|
+
phash: phash_example,
|
|
1230
|
+
// string | Whether to perform upload asynchronously (true/false) (optional)
|
|
1231
|
+
async: async_example,
|
|
1232
|
+
} satisfies DeprecatedPostCloudinaryConsoleHandlersSignAndUploadRequest;
|
|
1233
|
+
|
|
1234
|
+
try {
|
|
1235
|
+
const data = await api.deprecatedPostCloudinaryConsoleHandlersSignAndUpload(body);
|
|
1236
|
+
console.log(data);
|
|
1237
|
+
} catch (error) {
|
|
1238
|
+
console.error(error);
|
|
1239
|
+
}
|
|
1240
|
+
}
|
|
1241
|
+
|
|
1242
|
+
// Run the test
|
|
1243
|
+
example().catch(console.error);
|
|
1244
|
+
```
|
|
1245
|
+
|
|
1246
|
+
### Parameters
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
| Name | Type | Description | Notes |
|
|
1250
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1251
|
+
| **file** | `Blob` | The binary file to upload | [Defaults to `undefined`] |
|
|
1252
|
+
| **resourceType** | `string` | The type of resource (image, video, raw, auto). Defaults to auto | [Optional] [Defaults to `undefined`] |
|
|
1253
|
+
| **publicId** | `string` | Custom public identifier for the uploaded asset | [Optional] [Defaults to `undefined`] |
|
|
1254
|
+
| **folder** | `string` | Folder name where the file should be stored | [Optional] [Defaults to `undefined`] |
|
|
1255
|
+
| **assetFolder** | `string` | Asset folder path in the Cloudinary repository | [Optional] [Defaults to `undefined`] |
|
|
1256
|
+
| **tags** | `string` | Comma-separated list of tags | [Optional] [Defaults to `undefined`] |
|
|
1257
|
+
| **type** | `string` | Storage/delivery type (upload, private, authenticated) | [Optional] [Defaults to `undefined`] |
|
|
1258
|
+
| **overwrite** | `string` | Whether to overwrite an existing asset (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1259
|
+
| **invalidate** | `string` | Whether to invalidate CDN cache (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1260
|
+
| **context** | `string` | Pipe-separated contextual metadata | [Optional] [Defaults to `undefined`] |
|
|
1261
|
+
| **metadata** | `string` | Pipe-separated structured metadata | [Optional] [Defaults to `undefined`] |
|
|
1262
|
+
| **transformation** | `string` | Transformation to apply on upload | [Optional] [Defaults to `undefined`] |
|
|
1263
|
+
| **format** | `string` | Format to convert to | [Optional] [Defaults to `undefined`] |
|
|
1264
|
+
| **eager** | `string` | Eager transformations to generate | [Optional] [Defaults to `undefined`] |
|
|
1265
|
+
| **eagerAsync** | `string` | Whether to generate eager transformations asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1266
|
+
| **eagerNotificationUrl** | `string` | Webhook URL for eager transformation completion | [Optional] [Defaults to `undefined`] |
|
|
1267
|
+
| **notificationUrl** | `string` | Webhook URL for upload completion | [Optional] [Defaults to `undefined`] |
|
|
1268
|
+
| **displayName** | `string` | Display name for the asset | [Optional] [Defaults to `undefined`] |
|
|
1269
|
+
| **useFilename** | `string` | Use original filename as public_id (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1270
|
+
| **uniqueFilename** | `string` | Append random characters to filename (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1271
|
+
| **filenameOverride** | `string` | Override the original filename metadata | [Optional] [Defaults to `undefined`] |
|
|
1272
|
+
| **accessMode** | `string` | Access mode (public, authenticated) | [Optional] [Defaults to `undefined`] |
|
|
1273
|
+
| **discardOriginalFilename** | `string` | Whether to discard original filename (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1274
|
+
| **phash** | `string` | Whether to return perceptual hash (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1275
|
+
| **async** | `string` | Whether to perform upload asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
|
|
1276
|
+
|
|
1277
|
+
### Return type
|
|
1278
|
+
|
|
1279
|
+
[**SignAndUploadResponse**](SignAndUploadResponse.md)
|
|
1280
|
+
|
|
1281
|
+
### Authorization
|
|
1282
|
+
|
|
1283
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1284
|
+
|
|
1285
|
+
### HTTP request headers
|
|
1286
|
+
|
|
1287
|
+
- **Content-Type**: `multipart/form-data`, `application/json`
|
|
1288
|
+
- **Accept**: `application/json`
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
### HTTP response details
|
|
1292
|
+
| Status code | Description | Response headers |
|
|
1293
|
+
|-------------|-------------|------------------|
|
|
1294
|
+
| **200** | Asset uploaded successfully | - |
|
|
1295
|
+
|
|
1296
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
## deprecatedPostCloudinaryConsoleOperationsDownload
|
|
1300
|
+
|
|
1301
|
+
> DownloadAssetResponse deprecatedPostCloudinaryConsoleOperationsDownload(downloadAssetRequest)
|
|
1302
|
+
|
|
1303
|
+
Downloads a resource
|
|
1304
|
+
|
|
1305
|
+
Downloads a resource by external_id, id, or public_id. If id or public_id is provided, it will be translated to external_id.
|
|
1306
|
+
|
|
1307
|
+
### Example
|
|
1308
|
+
|
|
1309
|
+
```ts
|
|
1310
|
+
import {
|
|
1311
|
+
Configuration,
|
|
1312
|
+
ConsoleApi,
|
|
1313
|
+
} from '@cloudinary/apps-api';
|
|
1314
|
+
import type { DeprecatedPostCloudinaryConsoleOperationsDownloadRequest } from '@cloudinary/apps-api';
|
|
1315
|
+
|
|
1316
|
+
async function example() {
|
|
1317
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1318
|
+
const config = new Configuration({
|
|
1319
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1320
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1321
|
+
});
|
|
1322
|
+
const api = new ConsoleApi(config);
|
|
1323
|
+
|
|
1324
|
+
const body = {
|
|
1325
|
+
// DownloadAssetRequest (optional)
|
|
1326
|
+
downloadAssetRequest: ...,
|
|
1327
|
+
} satisfies DeprecatedPostCloudinaryConsoleOperationsDownloadRequest;
|
|
1328
|
+
|
|
1329
|
+
try {
|
|
1330
|
+
const data = await api.deprecatedPostCloudinaryConsoleOperationsDownload(body);
|
|
1331
|
+
console.log(data);
|
|
1332
|
+
} catch (error) {
|
|
1333
|
+
console.error(error);
|
|
1334
|
+
}
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
// Run the test
|
|
1338
|
+
example().catch(console.error);
|
|
1339
|
+
```
|
|
1340
|
+
|
|
1341
|
+
### Parameters
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
| Name | Type | Description | Notes |
|
|
1345
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1346
|
+
| **downloadAssetRequest** | [DownloadAssetRequest](DownloadAssetRequest.md) | | [Optional] |
|
|
1347
|
+
|
|
1348
|
+
### Return type
|
|
1349
|
+
|
|
1350
|
+
[**DownloadAssetResponse**](DownloadAssetResponse.md)
|
|
1351
|
+
|
|
1352
|
+
### Authorization
|
|
1353
|
+
|
|
1354
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1355
|
+
|
|
1356
|
+
### HTTP request headers
|
|
1357
|
+
|
|
1358
|
+
- **Content-Type**: `application/json`
|
|
1359
|
+
- **Accept**: `application/json`
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
### HTTP response details
|
|
1363
|
+
| Status code | Description | Response headers |
|
|
1364
|
+
|-------------|-------------|------------------|
|
|
1365
|
+
| **200** | Successful download response with URL | - |
|
|
1366
|
+
|
|
1367
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
## deprecatedPostCloudinaryConsoleSearch
|
|
1371
|
+
|
|
1372
|
+
> AssetSearchResponse deprecatedPostCloudinaryConsoleSearch(expression, maxResults, nextCursor, sortBy, backend, aggregate)
|
|
1373
|
+
|
|
1374
|
+
Search resources
|
|
1375
|
+
|
|
1376
|
+
Search for assets using Cloudinary\'s search expression language
|
|
1377
|
+
|
|
1378
|
+
### Example
|
|
1379
|
+
|
|
1380
|
+
```ts
|
|
1381
|
+
import {
|
|
1382
|
+
Configuration,
|
|
1383
|
+
ConsoleApi,
|
|
1384
|
+
} from '@cloudinary/apps-api';
|
|
1385
|
+
import type { DeprecatedPostCloudinaryConsoleSearchRequest } from '@cloudinary/apps-api';
|
|
1386
|
+
|
|
1387
|
+
async function example() {
|
|
1388
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
1389
|
+
const config = new Configuration({
|
|
1390
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1391
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1392
|
+
});
|
|
1393
|
+
const api = new ConsoleApi(config);
|
|
1394
|
+
|
|
1395
|
+
const body = {
|
|
1396
|
+
// string
|
|
1397
|
+
expression: expression_example,
|
|
1398
|
+
// number (optional)
|
|
1399
|
+
maxResults: 56,
|
|
1400
|
+
// string (optional)
|
|
1401
|
+
nextCursor: nextCursor_example,
|
|
1402
|
+
// string (optional)
|
|
1403
|
+
sortBy: sortBy_example,
|
|
1404
|
+
// 'relational' | 'elastic' | 'clip' | 'clip_text' | 'clip_url' (optional)
|
|
1405
|
+
backend: backend_example,
|
|
1406
|
+
// string (optional)
|
|
1407
|
+
aggregate: aggregate_example,
|
|
1408
|
+
} satisfies DeprecatedPostCloudinaryConsoleSearchRequest;
|
|
1409
|
+
|
|
1410
|
+
try {
|
|
1411
|
+
const data = await api.deprecatedPostCloudinaryConsoleSearch(body);
|
|
1412
|
+
console.log(data);
|
|
1413
|
+
} catch (error) {
|
|
1414
|
+
console.error(error);
|
|
1415
|
+
}
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1418
|
+
// Run the test
|
|
1419
|
+
example().catch(console.error);
|
|
1420
|
+
```
|
|
1421
|
+
|
|
1422
|
+
### Parameters
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
| Name | Type | Description | Notes |
|
|
1426
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1427
|
+
| **expression** | `string` | | [Defaults to `undefined`] |
|
|
1428
|
+
| **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1429
|
+
| **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1430
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1431
|
+
| **backend** | `relational`, `elastic`, `clip`, `clip_text`, `clip_url` | | [Optional] [Defaults to `undefined`] [Enum: relational, elastic, clip, clip_text, clip_url] |
|
|
1432
|
+
| **aggregate** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1433
|
+
|
|
1434
|
+
### Return type
|
|
1435
|
+
|
|
1436
|
+
[**AssetSearchResponse**](AssetSearchResponse.md)
|
|
1437
|
+
|
|
1438
|
+
### Authorization
|
|
1439
|
+
|
|
1440
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1441
|
+
|
|
1442
|
+
### HTTP request headers
|
|
1443
|
+
|
|
1444
|
+
- **Content-Type**: Not defined
|
|
1445
|
+
- **Accept**: `application/json`
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
### HTTP response details
|
|
1449
|
+
| Status code | Description | Response headers |
|
|
1450
|
+
|-------------|-------------|------------------|
|
|
1451
|
+
| **200** | Successful operation | - |
|
|
1452
|
+
|
|
1453
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1454
|
+
|