@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,915 @@
|
|
|
1
|
+
# PlatformApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**createNamespaceToken**](PlatformApi.md#createnamespacetokenoperation) | **POST** /v2605/platform/apps/storage/namespace-token | Create a namespace token for shared app storage |
|
|
8
|
+
| [**deployApp**](PlatformApi.md#deployapp) | **POST** /v2605/platform/apps/{app_id}/deploy | Deploy a DAM app bundle |
|
|
9
|
+
| [**getApp**](PlatformApi.md#getapp) | **GET** /v2605/platform/apps/{app_id} | Get a DAM app |
|
|
10
|
+
| [**getAppStorageValue**](PlatformApi.md#getappstoragevalue) | **GET** /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Get a value from app persistent storage |
|
|
11
|
+
| [**getAuthCredentials**](PlatformApi.md#getauthcredentials) | **GET** /v2605/platform/auth/credentials | Get current user and cloud identity |
|
|
12
|
+
| [**getCustomerByCloud**](PlatformApi.md#getcustomerbycloud) | **GET** /v2605/platform/customers/by-cloud/{cloud_name} | Get a customer by cloud name |
|
|
13
|
+
| [**listCustomers**](PlatformApi.md#listcustomers) | **GET** /v2605/platform/customers | List customers (clouds) accessible to the user |
|
|
14
|
+
| [**refreshCloudinaryToken**](PlatformApi.md#refreshcloudinarytoken) | **GET** /v2605/platform/auth/tokens/cloudinary/{type}/refresh | Refresh a Cloudinary token |
|
|
15
|
+
| [**setAppStorageValue**](PlatformApi.md#setappstoragevalueoperation) | **PUT** /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Set a value in app persistent storage |
|
|
16
|
+
| [**trackAnalyticsEvent**](PlatformApi.md#trackanalyticseventoperation) | **POST** /v2605/platform/analytics | Submit analytics events |
|
|
17
|
+
| [**updateApp**](PlatformApi.md#updateappoperation) | **PUT** /v2605/platform/apps/{app_id} | Update DAM app configuration |
|
|
18
|
+
| [**validateToken**](PlatformApi.md#validatetoken) | **GET** /v2605/platform/auth/tokens/validate | Validate a gateway token |
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## createNamespaceToken
|
|
23
|
+
|
|
24
|
+
> NamespaceTokenCreateResponse createNamespaceToken(createNamespaceTokenRequest)
|
|
25
|
+
|
|
26
|
+
Create a namespace token for shared app storage
|
|
27
|
+
|
|
28
|
+
Mints an encrypted namespace token for app storage. Pass the token as the namespace_token path segment on get/set endpoints. Requires the mint secret.
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import {
|
|
34
|
+
Configuration,
|
|
35
|
+
PlatformApi,
|
|
36
|
+
} from '@cloudinary/apps-api';
|
|
37
|
+
import type { CreateNamespaceTokenOperationRequest } from '@cloudinary/apps-api';
|
|
38
|
+
|
|
39
|
+
async function example() {
|
|
40
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
41
|
+
const config = new Configuration({
|
|
42
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
43
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
44
|
+
});
|
|
45
|
+
const api = new PlatformApi(config);
|
|
46
|
+
|
|
47
|
+
const body = {
|
|
48
|
+
// CreateNamespaceTokenRequest (optional)
|
|
49
|
+
createNamespaceTokenRequest: ...,
|
|
50
|
+
} satisfies CreateNamespaceTokenOperationRequest;
|
|
51
|
+
|
|
52
|
+
try {
|
|
53
|
+
const data = await api.createNamespaceToken(body);
|
|
54
|
+
console.log(data);
|
|
55
|
+
} catch (error) {
|
|
56
|
+
console.error(error);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// Run the test
|
|
61
|
+
example().catch(console.error);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
|------------- | ------------- | ------------- | -------------|
|
|
69
|
+
| **createNamespaceTokenRequest** | [CreateNamespaceTokenRequest](CreateNamespaceTokenRequest.md) | | [Optional] |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**NamespaceTokenCreateResponse**](NamespaceTokenCreateResponse.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: `application/json`
|
|
82
|
+
- **Accept**: `application/json`
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### HTTP response details
|
|
86
|
+
| Status code | Description | Response headers |
|
|
87
|
+
|-------------|-------------|------------------|
|
|
88
|
+
| **200** | Namespace token created | - |
|
|
89
|
+
| **403** | Invalid mint secret | - |
|
|
90
|
+
|
|
91
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## deployApp
|
|
95
|
+
|
|
96
|
+
> DeployApp200Response deployApp(appId, bundle, env, version, updateAppUrl)
|
|
97
|
+
|
|
98
|
+
Deploy a DAM app bundle
|
|
99
|
+
|
|
100
|
+
deploy a DAM app to https://dam.cloudinary.app/{app_id}/{env}/{version}/ and optionally updates the app\'s appUrl and manifest from cloudinary.app.json in the bundle.
|
|
101
|
+
|
|
102
|
+
### Example
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
import {
|
|
106
|
+
Configuration,
|
|
107
|
+
PlatformApi,
|
|
108
|
+
} from '@cloudinary/apps-api';
|
|
109
|
+
import type { DeployAppRequest } from '@cloudinary/apps-api';
|
|
110
|
+
|
|
111
|
+
async function example() {
|
|
112
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
113
|
+
const config = new Configuration({
|
|
114
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
115
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
116
|
+
});
|
|
117
|
+
const api = new PlatformApi(config);
|
|
118
|
+
|
|
119
|
+
const body = {
|
|
120
|
+
// string | DAM app ID (CustomAction id)
|
|
121
|
+
appId: appId_example,
|
|
122
|
+
// Blob | Zip archive of the built app
|
|
123
|
+
bundle: BINARY_DATA_HERE,
|
|
124
|
+
// string | Target environment (e.g. development, staging, production)
|
|
125
|
+
env: env_example,
|
|
126
|
+
// string | Semver version string, e.g. 1.2.3
|
|
127
|
+
version: version_example,
|
|
128
|
+
// string | \\\"true\\\" to update appUrl and manifest (from cloudinary.app.json in the bundle) in dam_apps after successful deploy (optional)
|
|
129
|
+
updateAppUrl: updateAppUrl_example,
|
|
130
|
+
} satisfies DeployAppRequest;
|
|
131
|
+
|
|
132
|
+
try {
|
|
133
|
+
const data = await api.deployApp(body);
|
|
134
|
+
console.log(data);
|
|
135
|
+
} catch (error) {
|
|
136
|
+
console.error(error);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// Run the test
|
|
141
|
+
example().catch(console.error);
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
| Name | Type | Description | Notes |
|
|
148
|
+
|------------- | ------------- | ------------- | -------------|
|
|
149
|
+
| **appId** | `string` | DAM app ID (CustomAction id) | [Defaults to `undefined`] |
|
|
150
|
+
| **bundle** | `Blob` | Zip archive of the built app | [Defaults to `undefined`] |
|
|
151
|
+
| **env** | `string` | Target environment (e.g. development, staging, production) | [Defaults to `undefined`] |
|
|
152
|
+
| **version** | `string` | Semver version string, e.g. 1.2.3 | [Defaults to `undefined`] |
|
|
153
|
+
| **updateAppUrl** | `string` | \\\"true\\\" to update appUrl and manifest (from cloudinary.app.json in the bundle) in dam_apps after successful deploy | [Optional] [Defaults to `undefined`] |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**DeployApp200Response**](DeployApp200Response.md)
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: `multipart/form-data`
|
|
166
|
+
- **Accept**: `application/json`
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### HTTP response details
|
|
170
|
+
| Status code | Description | Response headers |
|
|
171
|
+
|-------------|-------------|------------------|
|
|
172
|
+
| **200** | Deploy succeeded | - |
|
|
173
|
+
| **207** | Deploy succeeded but appUrl update failed | - |
|
|
174
|
+
| **400** | Bad request | - |
|
|
175
|
+
| **403** | Not the app owner | - |
|
|
176
|
+
| **404** | App not found | - |
|
|
177
|
+
| **500** | Deploy failure | - |
|
|
178
|
+
|
|
179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
## getApp
|
|
183
|
+
|
|
184
|
+
> DamAppResponse getApp(appId)
|
|
185
|
+
|
|
186
|
+
Get a DAM app
|
|
187
|
+
|
|
188
|
+
Returns custom action metadata for a DAM app by ID from the Custom Actions service.
|
|
189
|
+
|
|
190
|
+
### Example
|
|
191
|
+
|
|
192
|
+
```ts
|
|
193
|
+
import {
|
|
194
|
+
Configuration,
|
|
195
|
+
PlatformApi,
|
|
196
|
+
} from '@cloudinary/apps-api';
|
|
197
|
+
import type { GetAppRequest } from '@cloudinary/apps-api';
|
|
198
|
+
|
|
199
|
+
async function example() {
|
|
200
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
201
|
+
const config = new Configuration({
|
|
202
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
203
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
204
|
+
});
|
|
205
|
+
const api = new PlatformApi(config);
|
|
206
|
+
|
|
207
|
+
const body = {
|
|
208
|
+
// string | DAM app ID (CustomAction id)
|
|
209
|
+
appId: appId_example,
|
|
210
|
+
} satisfies GetAppRequest;
|
|
211
|
+
|
|
212
|
+
try {
|
|
213
|
+
const data = await api.getApp(body);
|
|
214
|
+
console.log(data);
|
|
215
|
+
} catch (error) {
|
|
216
|
+
console.error(error);
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
// Run the test
|
|
221
|
+
example().catch(console.error);
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
| Name | Type | Description | Notes |
|
|
228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
229
|
+
| **appId** | `string` | DAM app ID (CustomAction id) | [Defaults to `undefined`] |
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**DamAppResponse**](DamAppResponse.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: Not defined
|
|
242
|
+
- **Accept**: `application/json`
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### HTTP response details
|
|
246
|
+
| Status code | Description | Response headers |
|
|
247
|
+
|-------------|-------------|------------------|
|
|
248
|
+
| **200** | DAM app metadata | - |
|
|
249
|
+
| **404** | App not found | - |
|
|
250
|
+
| **500** | Failed to fetch app | - |
|
|
251
|
+
|
|
252
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
## getAppStorageValue
|
|
256
|
+
|
|
257
|
+
> AppStorageGetResponse getAppStorageValue(namespaceToken, level, key)
|
|
258
|
+
|
|
259
|
+
Get a value from app persistent storage
|
|
260
|
+
|
|
261
|
+
Retrieves a previously stored JSON value by key. Storage is namespaced by a validated namespace_token path segment. Personal level is scoped to the user; shared level is scoped to the customer (cloud). Requires OAuth authentication.
|
|
262
|
+
|
|
263
|
+
### Example
|
|
264
|
+
|
|
265
|
+
```ts
|
|
266
|
+
import {
|
|
267
|
+
Configuration,
|
|
268
|
+
PlatformApi,
|
|
269
|
+
} from '@cloudinary/apps-api';
|
|
270
|
+
import type { GetAppStorageValueRequest } from '@cloudinary/apps-api';
|
|
271
|
+
|
|
272
|
+
async function example() {
|
|
273
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
274
|
+
const config = new Configuration({
|
|
275
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
276
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
277
|
+
});
|
|
278
|
+
const api = new PlatformApi(config);
|
|
279
|
+
|
|
280
|
+
const body = {
|
|
281
|
+
// string | Encrypted namespace token minted via the namespace-token endpoint
|
|
282
|
+
namespaceToken: namespaceToken_example,
|
|
283
|
+
// 'personal' | 'shared' | Storage level: personal (user-scoped) or shared (customer-scoped)
|
|
284
|
+
level: level_example,
|
|
285
|
+
// string | User-defined key name
|
|
286
|
+
key: key_example,
|
|
287
|
+
} satisfies GetAppStorageValueRequest;
|
|
288
|
+
|
|
289
|
+
try {
|
|
290
|
+
const data = await api.getAppStorageValue(body);
|
|
291
|
+
console.log(data);
|
|
292
|
+
} catch (error) {
|
|
293
|
+
console.error(error);
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
// Run the test
|
|
298
|
+
example().catch(console.error);
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
| Name | Type | Description | Notes |
|
|
305
|
+
|------------- | ------------- | ------------- | -------------|
|
|
306
|
+
| **namespaceToken** | `string` | Encrypted namespace token minted via the namespace-token endpoint | [Defaults to `undefined`] |
|
|
307
|
+
| **level** | `personal`, `shared` | Storage level: personal (user-scoped) or shared (customer-scoped) | [Defaults to `undefined`] [Enum: personal, shared] |
|
|
308
|
+
| **key** | `string` | User-defined key name | [Defaults to `undefined`] |
|
|
309
|
+
|
|
310
|
+
### Return type
|
|
311
|
+
|
|
312
|
+
[**AppStorageGetResponse**](AppStorageGetResponse.md)
|
|
313
|
+
|
|
314
|
+
### Authorization
|
|
315
|
+
|
|
316
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
317
|
+
|
|
318
|
+
### HTTP request headers
|
|
319
|
+
|
|
320
|
+
- **Content-Type**: Not defined
|
|
321
|
+
- **Accept**: `application/json`
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
### HTTP response details
|
|
325
|
+
| Status code | Description | Response headers |
|
|
326
|
+
|-------------|-------------|------------------|
|
|
327
|
+
| **200** | Value retrieved successfully | - |
|
|
328
|
+
| **400** | Invalid namespace_token | - |
|
|
329
|
+
| **404** | Key not found | - |
|
|
330
|
+
|
|
331
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
## getAuthCredentials
|
|
335
|
+
|
|
336
|
+
> AuthCredentialsResponse getAuthCredentials()
|
|
337
|
+
|
|
338
|
+
Get current user and cloud identity
|
|
339
|
+
|
|
340
|
+
Returns the authenticated user profile and associated customer (cloud) record. Use to confirm session identity and cloud context.
|
|
341
|
+
|
|
342
|
+
### Example
|
|
343
|
+
|
|
344
|
+
```ts
|
|
345
|
+
import {
|
|
346
|
+
Configuration,
|
|
347
|
+
PlatformApi,
|
|
348
|
+
} from '@cloudinary/apps-api';
|
|
349
|
+
import type { GetAuthCredentialsRequest } from '@cloudinary/apps-api';
|
|
350
|
+
|
|
351
|
+
async function example() {
|
|
352
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
353
|
+
const config = new Configuration({
|
|
354
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
355
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
356
|
+
});
|
|
357
|
+
const api = new PlatformApi(config);
|
|
358
|
+
|
|
359
|
+
try {
|
|
360
|
+
const data = await api.getAuthCredentials();
|
|
361
|
+
console.log(data);
|
|
362
|
+
} catch (error) {
|
|
363
|
+
console.error(error);
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
// Run the test
|
|
368
|
+
example().catch(console.error);
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Parameters
|
|
372
|
+
|
|
373
|
+
This endpoint does not need any parameter.
|
|
374
|
+
|
|
375
|
+
### Return type
|
|
376
|
+
|
|
377
|
+
[**AuthCredentialsResponse**](AuthCredentialsResponse.md)
|
|
378
|
+
|
|
379
|
+
### Authorization
|
|
380
|
+
|
|
381
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
382
|
+
|
|
383
|
+
### HTTP request headers
|
|
384
|
+
|
|
385
|
+
- **Content-Type**: Not defined
|
|
386
|
+
- **Accept**: `application/json`
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
### HTTP response details
|
|
390
|
+
| Status code | Description | Response headers |
|
|
391
|
+
|-------------|-------------|------------------|
|
|
392
|
+
| **200** | Successful authentication response with user identity and permissions | - |
|
|
393
|
+
|
|
394
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
## getCustomerByCloud
|
|
398
|
+
|
|
399
|
+
> Customer getCustomerByCloud(cloudName)
|
|
400
|
+
|
|
401
|
+
Get a customer by cloud name
|
|
402
|
+
|
|
403
|
+
Looks up a specific customer record by its Cloudinary cloud_name. Returns the full customer object or null if not found.
|
|
404
|
+
|
|
405
|
+
### Example
|
|
406
|
+
|
|
407
|
+
```ts
|
|
408
|
+
import {
|
|
409
|
+
Configuration,
|
|
410
|
+
PlatformApi,
|
|
411
|
+
} from '@cloudinary/apps-api';
|
|
412
|
+
import type { GetCustomerByCloudRequest } from '@cloudinary/apps-api';
|
|
413
|
+
|
|
414
|
+
async function example() {
|
|
415
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
416
|
+
const config = new Configuration({
|
|
417
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
418
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
419
|
+
});
|
|
420
|
+
const api = new PlatformApi(config);
|
|
421
|
+
|
|
422
|
+
const body = {
|
|
423
|
+
// string
|
|
424
|
+
cloudName: cloudName_example,
|
|
425
|
+
} satisfies GetCustomerByCloudRequest;
|
|
426
|
+
|
|
427
|
+
try {
|
|
428
|
+
const data = await api.getCustomerByCloud(body);
|
|
429
|
+
console.log(data);
|
|
430
|
+
} catch (error) {
|
|
431
|
+
console.error(error);
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
// Run the test
|
|
436
|
+
example().catch(console.error);
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Parameters
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
| Name | Type | Description | Notes |
|
|
443
|
+
|------------- | ------------- | ------------- | -------------|
|
|
444
|
+
| **cloudName** | `string` | | [Defaults to `undefined`] |
|
|
445
|
+
|
|
446
|
+
### Return type
|
|
447
|
+
|
|
448
|
+
[**Customer**](Customer.md)
|
|
449
|
+
|
|
450
|
+
### Authorization
|
|
451
|
+
|
|
452
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
453
|
+
|
|
454
|
+
### HTTP request headers
|
|
455
|
+
|
|
456
|
+
- **Content-Type**: Not defined
|
|
457
|
+
- **Accept**: `application/json`
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
### HTTP response details
|
|
461
|
+
| Status code | Description | Response headers |
|
|
462
|
+
|-------------|-------------|------------------|
|
|
463
|
+
| **200** | Successful operation | - |
|
|
464
|
+
|
|
465
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
## listCustomers
|
|
469
|
+
|
|
470
|
+
> ListCustomersResponse listCustomers(nameContains, cloudName, product, sortBy, sortOrder)
|
|
471
|
+
|
|
472
|
+
List customers (clouds) accessible to the user
|
|
473
|
+
|
|
474
|
+
Returns all Cloudinary customer accounts the authenticated user has access to. Supports filtering by name, cloud_name, and product, with configurable sorting.
|
|
475
|
+
|
|
476
|
+
### Example
|
|
477
|
+
|
|
478
|
+
```ts
|
|
479
|
+
import {
|
|
480
|
+
Configuration,
|
|
481
|
+
PlatformApi,
|
|
482
|
+
} from '@cloudinary/apps-api';
|
|
483
|
+
import type { ListCustomersRequest } from '@cloudinary/apps-api';
|
|
484
|
+
|
|
485
|
+
async function example() {
|
|
486
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
487
|
+
const config = new Configuration({
|
|
488
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
489
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
490
|
+
});
|
|
491
|
+
const api = new PlatformApi(config);
|
|
492
|
+
|
|
493
|
+
const body = {
|
|
494
|
+
// string (optional)
|
|
495
|
+
nameContains: nameContains_example,
|
|
496
|
+
// string (optional)
|
|
497
|
+
cloudName: cloudName_example,
|
|
498
|
+
// string (optional)
|
|
499
|
+
product: product_example,
|
|
500
|
+
// string (optional)
|
|
501
|
+
sortBy: sortBy_example,
|
|
502
|
+
// string (optional)
|
|
503
|
+
sortOrder: sortOrder_example,
|
|
504
|
+
} satisfies ListCustomersRequest;
|
|
505
|
+
|
|
506
|
+
try {
|
|
507
|
+
const data = await api.listCustomers(body);
|
|
508
|
+
console.log(data);
|
|
509
|
+
} catch (error) {
|
|
510
|
+
console.error(error);
|
|
511
|
+
}
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
// Run the test
|
|
515
|
+
example().catch(console.error);
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
| Name | Type | Description | Notes |
|
|
522
|
+
|------------- | ------------- | ------------- | -------------|
|
|
523
|
+
| **nameContains** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
524
|
+
| **cloudName** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
525
|
+
| **product** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
526
|
+
| **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
527
|
+
| **sortOrder** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
528
|
+
|
|
529
|
+
### Return type
|
|
530
|
+
|
|
531
|
+
[**ListCustomersResponse**](ListCustomersResponse.md)
|
|
532
|
+
|
|
533
|
+
### Authorization
|
|
534
|
+
|
|
535
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
536
|
+
|
|
537
|
+
### HTTP request headers
|
|
538
|
+
|
|
539
|
+
- **Content-Type**: Not defined
|
|
540
|
+
- **Accept**: `application/json`
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
### HTTP response details
|
|
544
|
+
| Status code | Description | Response headers |
|
|
545
|
+
|-------------|-------------|------------------|
|
|
546
|
+
| **200** | Successful operation | - |
|
|
547
|
+
|
|
548
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
## refreshCloudinaryToken
|
|
552
|
+
|
|
553
|
+
> RefreshTokenResponse refreshCloudinaryToken(type)
|
|
554
|
+
|
|
555
|
+
Refresh a Cloudinary token
|
|
556
|
+
|
|
557
|
+
Exchanges the current gateway bearer token for a fresh underlying Cloudinary token of the specified type (oauth or console). Returns a 401 and invalidates the session if the token cannot be refreshed.
|
|
558
|
+
|
|
559
|
+
### Example
|
|
560
|
+
|
|
561
|
+
```ts
|
|
562
|
+
import {
|
|
563
|
+
Configuration,
|
|
564
|
+
PlatformApi,
|
|
565
|
+
} from '@cloudinary/apps-api';
|
|
566
|
+
import type { RefreshCloudinaryTokenRequest } from '@cloudinary/apps-api';
|
|
567
|
+
|
|
568
|
+
async function example() {
|
|
569
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
570
|
+
const config = new Configuration({
|
|
571
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
572
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
573
|
+
});
|
|
574
|
+
const api = new PlatformApi(config);
|
|
575
|
+
|
|
576
|
+
const body = {
|
|
577
|
+
// 'oauth' | 'console'
|
|
578
|
+
type: type_example,
|
|
579
|
+
} satisfies RefreshCloudinaryTokenRequest;
|
|
580
|
+
|
|
581
|
+
try {
|
|
582
|
+
const data = await api.refreshCloudinaryToken(body);
|
|
583
|
+
console.log(data);
|
|
584
|
+
} catch (error) {
|
|
585
|
+
console.error(error);
|
|
586
|
+
}
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
// Run the test
|
|
590
|
+
example().catch(console.error);
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
| Name | Type | Description | Notes |
|
|
597
|
+
|------------- | ------------- | ------------- | -------------|
|
|
598
|
+
| **type** | `oauth`, `console` | | [Defaults to `undefined`] [Enum: oauth, console] |
|
|
599
|
+
|
|
600
|
+
### Return type
|
|
601
|
+
|
|
602
|
+
[**RefreshTokenResponse**](RefreshTokenResponse.md)
|
|
603
|
+
|
|
604
|
+
### Authorization
|
|
605
|
+
|
|
606
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
607
|
+
|
|
608
|
+
### HTTP request headers
|
|
609
|
+
|
|
610
|
+
- **Content-Type**: Not defined
|
|
611
|
+
- **Accept**: `application/json`
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
### HTTP response details
|
|
615
|
+
| Status code | Description | Response headers |
|
|
616
|
+
|-------------|-------------|------------------|
|
|
617
|
+
| **200** | Successful operation | - |
|
|
618
|
+
| **401** | Invalid or expired session | - |
|
|
619
|
+
|
|
620
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
## setAppStorageValue
|
|
624
|
+
|
|
625
|
+
> AppStorageSetResponse setAppStorageValue(namespaceToken, level, key, setAppStorageValueRequest)
|
|
626
|
+
|
|
627
|
+
Set a value in app persistent storage
|
|
628
|
+
|
|
629
|
+
Stores an arbitrary JSON value under the specified key. Storage is namespaced by a validated namespace_token path segment. Personal level: any user can write. Shared level: only admins (master_admin role) can write. Requires OAuth authentication.
|
|
630
|
+
|
|
631
|
+
### Example
|
|
632
|
+
|
|
633
|
+
```ts
|
|
634
|
+
import {
|
|
635
|
+
Configuration,
|
|
636
|
+
PlatformApi,
|
|
637
|
+
} from '@cloudinary/apps-api';
|
|
638
|
+
import type { SetAppStorageValueOperationRequest } from '@cloudinary/apps-api';
|
|
639
|
+
|
|
640
|
+
async function example() {
|
|
641
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
642
|
+
const config = new Configuration({
|
|
643
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
644
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
645
|
+
});
|
|
646
|
+
const api = new PlatformApi(config);
|
|
647
|
+
|
|
648
|
+
const body = {
|
|
649
|
+
// string | Encrypted namespace token minted via the namespace-token endpoint
|
|
650
|
+
namespaceToken: namespaceToken_example,
|
|
651
|
+
// 'personal' | 'shared' | Storage level: personal (user-scoped) or shared (customer-scoped)
|
|
652
|
+
level: level_example,
|
|
653
|
+
// string | User-defined key name
|
|
654
|
+
key: key_example,
|
|
655
|
+
// SetAppStorageValueRequest (optional)
|
|
656
|
+
setAppStorageValueRequest: ...,
|
|
657
|
+
} satisfies SetAppStorageValueOperationRequest;
|
|
658
|
+
|
|
659
|
+
try {
|
|
660
|
+
const data = await api.setAppStorageValue(body);
|
|
661
|
+
console.log(data);
|
|
662
|
+
} catch (error) {
|
|
663
|
+
console.error(error);
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
// Run the test
|
|
668
|
+
example().catch(console.error);
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### Parameters
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
| Name | Type | Description | Notes |
|
|
675
|
+
|------------- | ------------- | ------------- | -------------|
|
|
676
|
+
| **namespaceToken** | `string` | Encrypted namespace token minted via the namespace-token endpoint | [Defaults to `undefined`] |
|
|
677
|
+
| **level** | `personal`, `shared` | Storage level: personal (user-scoped) or shared (customer-scoped) | [Defaults to `undefined`] [Enum: personal, shared] |
|
|
678
|
+
| **key** | `string` | User-defined key name | [Defaults to `undefined`] |
|
|
679
|
+
| **setAppStorageValueRequest** | [SetAppStorageValueRequest](SetAppStorageValueRequest.md) | | [Optional] |
|
|
680
|
+
|
|
681
|
+
### Return type
|
|
682
|
+
|
|
683
|
+
[**AppStorageSetResponse**](AppStorageSetResponse.md)
|
|
684
|
+
|
|
685
|
+
### Authorization
|
|
686
|
+
|
|
687
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
688
|
+
|
|
689
|
+
### HTTP request headers
|
|
690
|
+
|
|
691
|
+
- **Content-Type**: `application/json`
|
|
692
|
+
- **Accept**: `application/json`
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
### HTTP response details
|
|
696
|
+
| Status code | Description | Response headers |
|
|
697
|
+
|-------------|-------------|------------------|
|
|
698
|
+
| **200** | Value stored successfully | - |
|
|
699
|
+
| **400** | Invalid namespace_token | - |
|
|
700
|
+
| **403** | Forbidden - only admins can write to shared storage | - |
|
|
701
|
+
|
|
702
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
## trackAnalyticsEvent
|
|
706
|
+
|
|
707
|
+
> AnalyticsResponse trackAnalyticsEvent(trackAnalyticsEventRequest)
|
|
708
|
+
|
|
709
|
+
Submit analytics events
|
|
710
|
+
|
|
711
|
+
Accepts a batch of client-side analytics events for server-side processing and forwarding. Each event is an opaque JSON object; the gateway enriches events with IP and user-agent before logging.
|
|
712
|
+
|
|
713
|
+
### Example
|
|
714
|
+
|
|
715
|
+
```ts
|
|
716
|
+
import {
|
|
717
|
+
Configuration,
|
|
718
|
+
PlatformApi,
|
|
719
|
+
} from '@cloudinary/apps-api';
|
|
720
|
+
import type { TrackAnalyticsEventOperationRequest } from '@cloudinary/apps-api';
|
|
721
|
+
|
|
722
|
+
async function example() {
|
|
723
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
724
|
+
const api = new PlatformApi();
|
|
725
|
+
|
|
726
|
+
const body = {
|
|
727
|
+
// TrackAnalyticsEventRequest (optional)
|
|
728
|
+
trackAnalyticsEventRequest: ...,
|
|
729
|
+
} satisfies TrackAnalyticsEventOperationRequest;
|
|
730
|
+
|
|
731
|
+
try {
|
|
732
|
+
const data = await api.trackAnalyticsEvent(body);
|
|
733
|
+
console.log(data);
|
|
734
|
+
} catch (error) {
|
|
735
|
+
console.error(error);
|
|
736
|
+
}
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
// Run the test
|
|
740
|
+
example().catch(console.error);
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
### Parameters
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
| Name | Type | Description | Notes |
|
|
747
|
+
|------------- | ------------- | ------------- | -------------|
|
|
748
|
+
| **trackAnalyticsEventRequest** | [TrackAnalyticsEventRequest](TrackAnalyticsEventRequest.md) | | [Optional] |
|
|
749
|
+
|
|
750
|
+
### Return type
|
|
751
|
+
|
|
752
|
+
[**AnalyticsResponse**](AnalyticsResponse.md)
|
|
753
|
+
|
|
754
|
+
### Authorization
|
|
755
|
+
|
|
756
|
+
No authorization required
|
|
757
|
+
|
|
758
|
+
### HTTP request headers
|
|
759
|
+
|
|
760
|
+
- **Content-Type**: `application/json`
|
|
761
|
+
- **Accept**: `application/json`
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
### HTTP response details
|
|
765
|
+
| Status code | Description | Response headers |
|
|
766
|
+
|-------------|-------------|------------------|
|
|
767
|
+
| **200** | Analytics events successfully processed | - |
|
|
768
|
+
| **400** | Bad request - invalid event data | - |
|
|
769
|
+
| **500** | Internal server error | - |
|
|
770
|
+
|
|
771
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
## updateApp
|
|
775
|
+
|
|
776
|
+
> DamAppResponse updateApp(appId, updateAppRequest)
|
|
777
|
+
|
|
778
|
+
Update DAM app configuration
|
|
779
|
+
|
|
780
|
+
Updates app configuration fields for a DAM app. Currently supports appUrl and manifest.
|
|
781
|
+
|
|
782
|
+
### Example
|
|
783
|
+
|
|
784
|
+
```ts
|
|
785
|
+
import {
|
|
786
|
+
Configuration,
|
|
787
|
+
PlatformApi,
|
|
788
|
+
} from '@cloudinary/apps-api';
|
|
789
|
+
import type { UpdateAppOperationRequest } from '@cloudinary/apps-api';
|
|
790
|
+
|
|
791
|
+
async function example() {
|
|
792
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
793
|
+
const config = new Configuration({
|
|
794
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
795
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
796
|
+
});
|
|
797
|
+
const api = new PlatformApi(config);
|
|
798
|
+
|
|
799
|
+
const body = {
|
|
800
|
+
// string | DAM app ID (CustomAction id)
|
|
801
|
+
appId: appId_example,
|
|
802
|
+
// UpdateAppRequest (optional)
|
|
803
|
+
updateAppRequest: ...,
|
|
804
|
+
} satisfies UpdateAppOperationRequest;
|
|
805
|
+
|
|
806
|
+
try {
|
|
807
|
+
const data = await api.updateApp(body);
|
|
808
|
+
console.log(data);
|
|
809
|
+
} catch (error) {
|
|
810
|
+
console.error(error);
|
|
811
|
+
}
|
|
812
|
+
}
|
|
813
|
+
|
|
814
|
+
// Run the test
|
|
815
|
+
example().catch(console.error);
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
### Parameters
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
| Name | Type | Description | Notes |
|
|
822
|
+
|------------- | ------------- | ------------- | -------------|
|
|
823
|
+
| **appId** | `string` | DAM app ID (CustomAction id) | [Defaults to `undefined`] |
|
|
824
|
+
| **updateAppRequest** | [UpdateAppRequest](UpdateAppRequest.md) | | [Optional] |
|
|
825
|
+
|
|
826
|
+
### Return type
|
|
827
|
+
|
|
828
|
+
[**DamAppResponse**](DamAppResponse.md)
|
|
829
|
+
|
|
830
|
+
### Authorization
|
|
831
|
+
|
|
832
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
833
|
+
|
|
834
|
+
### HTTP request headers
|
|
835
|
+
|
|
836
|
+
- **Content-Type**: `application/json`
|
|
837
|
+
- **Accept**: `application/json`
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
### HTTP response details
|
|
841
|
+
| Status code | Description | Response headers |
|
|
842
|
+
|-------------|-------------|------------------|
|
|
843
|
+
| **200** | Updated DAM app metadata | - |
|
|
844
|
+
| **400** | Bad request | - |
|
|
845
|
+
| **403** | Not the app owner | - |
|
|
846
|
+
| **404** | App not found | - |
|
|
847
|
+
| **422** | Invalid configuration | - |
|
|
848
|
+
| **500** | Update failed | - |
|
|
849
|
+
|
|
850
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
## validateToken
|
|
854
|
+
|
|
855
|
+
> ValidateTokenResponse validateToken()
|
|
856
|
+
|
|
857
|
+
Validate a gateway token
|
|
858
|
+
|
|
859
|
+
Verifies that the provided API gateway bearer token is well-formed, correctly signed, and not expired. Returns {ok: 1} on success or a 401 error with a descriptive message on failure.
|
|
860
|
+
|
|
861
|
+
### Example
|
|
862
|
+
|
|
863
|
+
```ts
|
|
864
|
+
import {
|
|
865
|
+
Configuration,
|
|
866
|
+
PlatformApi,
|
|
867
|
+
} from '@cloudinary/apps-api';
|
|
868
|
+
import type { ValidateTokenRequest } from '@cloudinary/apps-api';
|
|
869
|
+
|
|
870
|
+
async function example() {
|
|
871
|
+
console.log("🚀 Testing @cloudinary/apps-api SDK...");
|
|
872
|
+
const config = new Configuration({
|
|
873
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
874
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
875
|
+
});
|
|
876
|
+
const api = new PlatformApi(config);
|
|
877
|
+
|
|
878
|
+
try {
|
|
879
|
+
const data = await api.validateToken();
|
|
880
|
+
console.log(data);
|
|
881
|
+
} catch (error) {
|
|
882
|
+
console.error(error);
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
// Run the test
|
|
887
|
+
example().catch(console.error);
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Parameters
|
|
891
|
+
|
|
892
|
+
This endpoint does not need any parameter.
|
|
893
|
+
|
|
894
|
+
### Return type
|
|
895
|
+
|
|
896
|
+
[**ValidateTokenResponse**](ValidateTokenResponse.md)
|
|
897
|
+
|
|
898
|
+
### Authorization
|
|
899
|
+
|
|
900
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
901
|
+
|
|
902
|
+
### HTTP request headers
|
|
903
|
+
|
|
904
|
+
- **Content-Type**: Not defined
|
|
905
|
+
- **Accept**: `application/json`
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
### HTTP response details
|
|
909
|
+
| Status code | Description | Response headers |
|
|
910
|
+
|-------------|-------------|------------------|
|
|
911
|
+
| **200** | Token is valid | - |
|
|
912
|
+
| **401** | Invalid or expired token | - |
|
|
913
|
+
|
|
914
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
915
|
+
|