@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.
Files changed (825) hide show
  1. package/.openapi-generator/FILES +277 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +325 -0
  5. package/dist/apis/AssetManagementApi.d.ts +436 -0
  6. package/dist/apis/AssetManagementApi.js +1199 -0
  7. package/dist/apis/ConsoleApi.d.ts +412 -0
  8. package/dist/apis/ConsoleApi.js +1028 -0
  9. package/dist/apis/MediaApi.d.ts +229 -0
  10. package/dist/apis/MediaApi.js +606 -0
  11. package/dist/apis/PlatformApi.d.ts +206 -0
  12. package/dist/apis/PlatformApi.js +571 -0
  13. package/dist/apis/UploadApi.d.ts +64 -0
  14. package/dist/apis/UploadApi.js +198 -0
  15. package/dist/apis/UtilsApi.d.ts +194 -0
  16. package/dist/apis/UtilsApi.js +461 -0
  17. package/dist/apis/index.d.ts +6 -0
  18. package/dist/apis/index.js +24 -0
  19. package/dist/esm/apis/AssetManagementApi.d.ts +436 -0
  20. package/dist/esm/apis/AssetManagementApi.js +1195 -0
  21. package/dist/esm/apis/ConsoleApi.d.ts +412 -0
  22. package/dist/esm/apis/ConsoleApi.js +1024 -0
  23. package/dist/esm/apis/MediaApi.d.ts +229 -0
  24. package/dist/esm/apis/MediaApi.js +602 -0
  25. package/dist/esm/apis/PlatformApi.d.ts +206 -0
  26. package/dist/esm/apis/PlatformApi.js +567 -0
  27. package/dist/esm/apis/UploadApi.d.ts +64 -0
  28. package/dist/esm/apis/UploadApi.js +194 -0
  29. package/dist/esm/apis/UtilsApi.d.ts +194 -0
  30. package/dist/esm/apis/UtilsApi.js +457 -0
  31. package/dist/esm/apis/index.d.ts +6 -0
  32. package/dist/esm/apis/index.js +8 -0
  33. package/dist/esm/index.d.ts +3 -0
  34. package/dist/esm/index.js +5 -0
  35. package/dist/esm/models/AddCollectionAssetsRequest.d.ts +38 -0
  36. package/dist/esm/models/AddCollectionAssetsRequest.js +43 -0
  37. package/dist/esm/models/AddCollectionAssetsResponse.d.ts +33 -0
  38. package/dist/esm/models/AddCollectionAssetsResponse.js +44 -0
  39. package/dist/esm/models/AiVisionGeneralResponse.d.ts +32 -0
  40. package/dist/esm/models/AiVisionGeneralResponse.js +41 -0
  41. package/dist/esm/models/AnalyticsResponse.d.ts +32 -0
  42. package/dist/esm/models/AnalyticsResponse.js +43 -0
  43. package/dist/esm/models/AnalyzeAiVisionGeneralRequest.d.ts +51 -0
  44. package/dist/esm/models/AnalyzeAiVisionGeneralRequest.js +52 -0
  45. package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.d.ts +38 -0
  46. package/dist/esm/models/AnalyzeAiVisionGeneralRequestSource.js +43 -0
  47. package/dist/esm/models/AppStorageErrorResponse.d.ts +32 -0
  48. package/dist/esm/models/AppStorageErrorResponse.js +43 -0
  49. package/dist/esm/models/AppStorageGetResponse.d.ts +38 -0
  50. package/dist/esm/models/AppStorageGetResponse.js +45 -0
  51. package/dist/esm/models/AppStorageSetErrorResponse.d.ts +32 -0
  52. package/dist/esm/models/AppStorageSetErrorResponse.js +43 -0
  53. package/dist/esm/models/AppStorageSetResponse.d.ts +38 -0
  54. package/dist/esm/models/AppStorageSetResponse.js +45 -0
  55. package/dist/esm/models/Asset.d.ts +134 -0
  56. package/dist/esm/models/Asset.js +83 -0
  57. package/dist/esm/models/AssetHistoryResponse.d.ts +39 -0
  58. package/dist/esm/models/AssetHistoryResponse.js +44 -0
  59. package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.d.ts +67 -0
  60. package/dist/esm/models/AssetHistoryResponseAssetHistoryInner.js +63 -0
  61. package/dist/esm/models/AssetSearchResponse.d.ts +76 -0
  62. package/dist/esm/models/AssetSearchResponse.js +71 -0
  63. package/dist/esm/models/AuthCredentialsResponse.d.ts +40 -0
  64. package/dist/esm/models/AuthCredentialsResponse.js +49 -0
  65. package/dist/esm/models/AuthCustomer.d.ts +80 -0
  66. package/dist/esm/models/AuthCustomer.js +73 -0
  67. package/dist/esm/models/AuthUser.d.ts +50 -0
  68. package/dist/esm/models/AuthUser.js +51 -0
  69. package/dist/esm/models/AutocompleteAsset.d.ts +259 -0
  70. package/dist/esm/models/AutocompleteAsset.js +188 -0
  71. package/dist/esm/models/AutocompleteAssetCustomer.d.ts +33 -0
  72. package/dist/esm/models/AutocompleteAssetCustomer.js +44 -0
  73. package/dist/esm/models/AutocompleteAssetCustomerCustomer.d.ts +509 -0
  74. package/dist/esm/models/AutocompleteAssetCustomerCustomer.js +360 -0
  75. package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +38 -0
  76. package/dist/esm/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +47 -0
  77. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.d.ts +76 -0
  78. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfig.js +73 -0
  79. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +32 -0
  80. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +43 -0
  81. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +38 -0
  82. package/dist/esm/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +47 -0
  83. package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.d.ts +56 -0
  84. package/dist/esm/models/AutocompleteAssetCustomerCustomerLimits.js +59 -0
  85. package/dist/esm/models/AutocompleteAssetFullProps.d.ts +245 -0
  86. package/dist/esm/models/AutocompleteAssetFullProps.js +178 -0
  87. package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.d.ts +44 -0
  88. package/dist/esm/models/AutocompleteAssetFullPropsCreatedBy.js +51 -0
  89. package/dist/esm/models/AutocompleteFolder.d.ts +50 -0
  90. package/dist/esm/models/AutocompleteFolder.js +55 -0
  91. package/dist/esm/models/AutocompleteResponse.d.ts +70 -0
  92. package/dist/esm/models/AutocompleteResponse.js +69 -0
  93. package/dist/esm/models/BackreferenceHistoryEntry.d.ts +53 -0
  94. package/dist/esm/models/BackreferenceHistoryEntry.js +59 -0
  95. package/dist/esm/models/BackreferenceResult.d.ts +39 -0
  96. package/dist/esm/models/BackreferenceResult.js +48 -0
  97. package/dist/esm/models/BackreferenceResultBackref.d.ts +52 -0
  98. package/dist/esm/models/BackreferenceResultBackref.js +57 -0
  99. package/dist/esm/models/CldtTemplate.d.ts +107 -0
  100. package/dist/esm/models/CldtTemplate.js +94 -0
  101. package/dist/esm/models/CldtTemplateCanvas.d.ts +38 -0
  102. package/dist/esm/models/CldtTemplateCanvas.js +47 -0
  103. package/dist/esm/models/CldtTemplateProvenance.d.ts +64 -0
  104. package/dist/esm/models/CldtTemplateProvenance.js +61 -0
  105. package/dist/esm/models/CldtTemplateVariable.d.ts +56 -0
  106. package/dist/esm/models/CldtTemplateVariable.js +55 -0
  107. package/dist/esm/models/Collection.d.ts +135 -0
  108. package/dist/esm/models/Collection.js +76 -0
  109. package/dist/esm/models/CollectionPermissions.d.ts +38 -0
  110. package/dist/esm/models/CollectionPermissions.js +43 -0
  111. package/dist/esm/models/ContextualMetadataField.d.ts +32 -0
  112. package/dist/esm/models/ContextualMetadataField.js +43 -0
  113. package/dist/esm/models/CreateAssetMetadataFieldRequest.d.ts +56 -0
  114. package/dist/esm/models/CreateAssetMetadataFieldRequest.js +53 -0
  115. package/dist/esm/models/CreateCollectionRequest.d.ts +61 -0
  116. package/dist/esm/models/CreateCollectionRequest.js +55 -0
  117. package/dist/esm/models/CreateCollectionResponse.d.ts +33 -0
  118. package/dist/esm/models/CreateCollectionResponse.js +44 -0
  119. package/dist/esm/models/CreateFolderRequest.d.ts +38 -0
  120. package/dist/esm/models/CreateFolderRequest.js +45 -0
  121. package/dist/esm/models/CreateFolderResponse.d.ts +33 -0
  122. package/dist/esm/models/CreateFolderResponse.js +44 -0
  123. package/dist/esm/models/CreateFolderResponseFolder.d.ts +75 -0
  124. package/dist/esm/models/CreateFolderResponseFolder.js +72 -0
  125. package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.d.ts +38 -0
  126. package/dist/esm/models/CreateFolderResponseFolderViewableParentsInner.js +47 -0
  127. package/dist/esm/models/CreateMetadataFieldResponse.d.ts +44 -0
  128. package/dist/esm/models/CreateMetadataFieldResponse.js +51 -0
  129. package/dist/esm/models/CreateNamespaceTokenRequest.d.ts +38 -0
  130. package/dist/esm/models/CreateNamespaceTokenRequest.js +47 -0
  131. package/dist/esm/models/Customer.d.ts +207 -0
  132. package/dist/esm/models/Customer.js +158 -0
  133. package/dist/esm/models/CustomerListMeta.d.ts +74 -0
  134. package/dist/esm/models/CustomerListMeta.js +71 -0
  135. package/dist/esm/models/CustomerUploadLimits.d.ts +56 -0
  136. package/dist/esm/models/CustomerUploadLimits.js +59 -0
  137. package/dist/esm/models/DamAppErrorResponse.d.ts +32 -0
  138. package/dist/esm/models/DamAppErrorResponse.js +43 -0
  139. package/dist/esm/models/DamAppResponse.d.ts +153 -0
  140. package/dist/esm/models/DamAppResponse.js +102 -0
  141. package/dist/esm/models/DamAppResponseAppMessageParamsValue.d.ts +38 -0
  142. package/dist/esm/models/DamAppResponseAppMessageParamsValue.js +45 -0
  143. package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +38 -0
  144. package/dist/esm/models/DamAppResponseAppMessageParamsValueAnyOf.js +45 -0
  145. package/dist/esm/models/DamAppResponseAssetAmountLimit.d.ts +26 -0
  146. package/dist/esm/models/DamAppResponseAssetAmountLimit.js +31 -0
  147. package/dist/esm/models/DamAppUserSnapshot.d.ts +50 -0
  148. package/dist/esm/models/DamAppUserSnapshot.js +47 -0
  149. package/dist/esm/models/DeleteFolderResponse.d.ts +38 -0
  150. package/dist/esm/models/DeleteFolderResponse.js +43 -0
  151. package/dist/esm/models/DeployApp200Response.d.ts +44 -0
  152. package/dist/esm/models/DeployApp200Response.js +51 -0
  153. package/dist/esm/models/DeployApp207Response.d.ts +50 -0
  154. package/dist/esm/models/DeployApp207Response.js +55 -0
  155. package/dist/esm/models/DeployApp400Response.d.ts +32 -0
  156. package/dist/esm/models/DeployApp400Response.js +43 -0
  157. package/dist/esm/models/DeployAppRequest.d.ts +50 -0
  158. package/dist/esm/models/DeployAppRequest.js +53 -0
  159. package/dist/esm/models/DownloadAssetRequest.d.ts +50 -0
  160. package/dist/esm/models/DownloadAssetRequest.js +47 -0
  161. package/dist/esm/models/DownloadAssetResponse.d.ts +32 -0
  162. package/dist/esm/models/DownloadAssetResponse.js +41 -0
  163. package/dist/esm/models/DownloadCollectionResponse.d.ts +38 -0
  164. package/dist/esm/models/DownloadCollectionResponse.js +43 -0
  165. package/dist/esm/models/ErrorResponse.d.ts +32 -0
  166. package/dist/esm/models/ErrorResponse.js +43 -0
  167. package/dist/esm/models/ErrorWithMessageResponse.d.ts +38 -0
  168. package/dist/esm/models/ErrorWithMessageResponse.js +47 -0
  169. package/dist/esm/models/FieldAggregation.d.ts +39 -0
  170. package/dist/esm/models/FieldAggregation.js +48 -0
  171. package/dist/esm/models/FieldAggregationBucketsInner.d.ts +38 -0
  172. package/dist/esm/models/FieldAggregationBucketsInner.js +47 -0
  173. package/dist/esm/models/FontDefinition.d.ts +44 -0
  174. package/dist/esm/models/FontDefinition.js +51 -0
  175. package/dist/esm/models/FontLookupResponse.d.ts +33 -0
  176. package/dist/esm/models/FontLookupResponse.js +44 -0
  177. package/dist/esm/models/FontLookupResponseFontsInner.d.ts +96 -0
  178. package/dist/esm/models/FontLookupResponseFontsInner.js +92 -0
  179. package/dist/esm/models/FontProvisioningResponse.d.ts +33 -0
  180. package/dist/esm/models/FontProvisioningResponse.js +44 -0
  181. package/dist/esm/models/ForbiddenResponse.d.ts +32 -0
  182. package/dist/esm/models/ForbiddenResponse.js +43 -0
  183. package/dist/esm/models/GoogleFontListingResponse.d.ts +33 -0
  184. package/dist/esm/models/GoogleFontListingResponse.js +44 -0
  185. package/dist/esm/models/ListAssetsByFolderResponse.d.ts +40 -0
  186. package/dist/esm/models/ListAssetsByFolderResponse.js +47 -0
  187. package/dist/esm/models/ListAssetsByFolderResponseMeta.d.ts +38 -0
  188. package/dist/esm/models/ListAssetsByFolderResponseMeta.js +45 -0
  189. package/dist/esm/models/ListBackreferencesResponse.d.ts +45 -0
  190. package/dist/esm/models/ListBackreferencesResponse.js +52 -0
  191. package/dist/esm/models/ListBackreferencesResponseBackrefsInner.d.ts +52 -0
  192. package/dist/esm/models/ListBackreferencesResponseBackrefsInner.js +57 -0
  193. package/dist/esm/models/ListCollectionsResponse.d.ts +51 -0
  194. package/dist/esm/models/ListCollectionsResponse.js +50 -0
  195. package/dist/esm/models/ListContextualMetadataFieldsResponse.d.ts +39 -0
  196. package/dist/esm/models/ListContextualMetadataFieldsResponse.js +46 -0
  197. package/dist/esm/models/ListCustomersResponse.d.ts +40 -0
  198. package/dist/esm/models/ListCustomersResponse.js +49 -0
  199. package/dist/esm/models/ListMetadataFieldsResponse.d.ts +33 -0
  200. package/dist/esm/models/ListMetadataFieldsResponse.js +44 -0
  201. package/dist/esm/models/ListSubfoldersResponse.d.ts +57 -0
  202. package/dist/esm/models/ListSubfoldersResponse.js +52 -0
  203. package/dist/esm/models/ListSubfoldersResponseFoldersInner.d.ts +62 -0
  204. package/dist/esm/models/ListSubfoldersResponseFoldersInner.js +57 -0
  205. package/dist/esm/models/ListTransformationsResponse.d.ts +39 -0
  206. package/dist/esm/models/ListTransformationsResponse.js +46 -0
  207. package/dist/esm/models/LocationSegment.d.ts +38 -0
  208. package/dist/esm/models/LocationSegment.js +45 -0
  209. package/dist/esm/models/LookupFontRequest.d.ts +33 -0
  210. package/dist/esm/models/LookupFontRequest.js +44 -0
  211. package/dist/esm/models/LookupFontRequestFontsInner.d.ts +69 -0
  212. package/dist/esm/models/LookupFontRequestFontsInner.js +74 -0
  213. package/dist/esm/models/NamespaceTokenCreateErrorResponse.d.ts +32 -0
  214. package/dist/esm/models/NamespaceTokenCreateErrorResponse.js +43 -0
  215. package/dist/esm/models/NamespaceTokenCreateResponse.d.ts +32 -0
  216. package/dist/esm/models/NamespaceTokenCreateResponse.js +43 -0
  217. package/dist/esm/models/PrepareUploadRequest.d.ts +33 -0
  218. package/dist/esm/models/PrepareUploadRequest.js +42 -0
  219. package/dist/esm/models/PrepareUploadRequestUploadParams.d.ts +200 -0
  220. package/dist/esm/models/PrepareUploadRequestUploadParams.js +97 -0
  221. package/dist/esm/models/PrepareUploadResponse.d.ts +51 -0
  222. package/dist/esm/models/PrepareUploadResponse.js +54 -0
  223. package/dist/esm/models/ProvisionFontRequest.d.ts +39 -0
  224. package/dist/esm/models/ProvisionFontRequest.js +46 -0
  225. package/dist/esm/models/RefreshTokenErrorResponse.d.ts +32 -0
  226. package/dist/esm/models/RefreshTokenErrorResponse.js +43 -0
  227. package/dist/esm/models/RefreshTokenResponse.d.ts +32 -0
  228. package/dist/esm/models/RefreshTokenResponse.js +43 -0
  229. package/dist/esm/models/RemoveCollectionAssetsRequest.d.ts +38 -0
  230. package/dist/esm/models/RemoveCollectionAssetsRequest.js +43 -0
  231. package/dist/esm/models/RemoveCollectionAssetsResponse.d.ts +33 -0
  232. package/dist/esm/models/RemoveCollectionAssetsResponse.js +44 -0
  233. package/dist/esm/models/ResourceActor.d.ts +38 -0
  234. package/dist/esm/models/ResourceActor.js +47 -0
  235. package/dist/esm/models/SearchAsset.d.ts +257 -0
  236. package/dist/esm/models/SearchAsset.js +182 -0
  237. package/dist/esm/models/SearchCollectionsRequest.d.ts +60 -0
  238. package/dist/esm/models/SearchCollectionsRequest.js +49 -0
  239. package/dist/esm/models/SearchCollectionsResponse.d.ts +51 -0
  240. package/dist/esm/models/SearchCollectionsResponse.js +50 -0
  241. package/dist/esm/models/SetAppStorageValueRequest.d.ts +32 -0
  242. package/dist/esm/models/SetAppStorageValueRequest.js +41 -0
  243. package/dist/esm/models/SignAndUploadRequest.d.ts +176 -0
  244. package/dist/esm/models/SignAndUploadRequest.js +91 -0
  245. package/dist/esm/models/SignAndUploadRequest1.d.ts +176 -0
  246. package/dist/esm/models/SignAndUploadRequest1.js +91 -0
  247. package/dist/esm/models/SignAndUploadResponse.d.ts +122 -0
  248. package/dist/esm/models/SignAndUploadResponse.js +93 -0
  249. package/dist/esm/models/StructuredMetadataField.d.ts +68 -0
  250. package/dist/esm/models/StructuredMetadataField.js +53 -0
  251. package/dist/esm/models/TemplateResourceTuple.d.ts +40 -0
  252. package/dist/esm/models/TemplateResourceTuple.js +49 -0
  253. package/dist/esm/models/TemplateSearchResponse.d.ts +57 -0
  254. package/dist/esm/models/TemplateSearchResponse.js +60 -0
  255. package/dist/esm/models/ThumbnailsTokenResponse.d.ts +44 -0
  256. package/dist/esm/models/ThumbnailsTokenResponse.js +51 -0
  257. package/dist/esm/models/TrackAnalyticsEventRequest.d.ts +32 -0
  258. package/dist/esm/models/TrackAnalyticsEventRequest.js +43 -0
  259. package/dist/esm/models/Transformation.d.ts +80 -0
  260. package/dist/esm/models/Transformation.js +57 -0
  261. package/dist/esm/models/UpdateAppRequest.d.ts +40 -0
  262. package/dist/esm/models/UpdateAppRequest.js +43 -0
  263. package/dist/esm/models/UpdateAssetBackreferencesRequest.d.ts +62 -0
  264. package/dist/esm/models/UpdateAssetBackreferencesRequest.js +62 -0
  265. package/dist/esm/models/UpdateAssetMetadataRequest.d.ts +49 -0
  266. package/dist/esm/models/UpdateAssetMetadataRequest.js +49 -0
  267. package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.d.ts +26 -0
  268. package/dist/esm/models/UpdateAssetMetadataRequestMetadataValue.js +31 -0
  269. package/dist/esm/models/UpdateAssetMetadataResponse.d.ts +49 -0
  270. package/dist/esm/models/UpdateAssetMetadataResponse.js +49 -0
  271. package/dist/esm/models/UpdateAssetTagsRequest.d.ts +52 -0
  272. package/dist/esm/models/UpdateAssetTagsRequest.js +58 -0
  273. package/dist/esm/models/UpdateAssetTagsResponse.d.ts +32 -0
  274. package/dist/esm/models/UpdateAssetTagsResponse.js +43 -0
  275. package/dist/esm/models/UpdateBackreferencesResponse.d.ts +33 -0
  276. package/dist/esm/models/UpdateBackreferencesResponse.js +44 -0
  277. package/dist/esm/models/UpdateCollectionRequest.d.ts +46 -0
  278. package/dist/esm/models/UpdateCollectionRequest.js +45 -0
  279. package/dist/esm/models/UpdateCollectionResponse.d.ts +33 -0
  280. package/dist/esm/models/UpdateCollectionResponse.js +44 -0
  281. package/dist/esm/models/UploadAssetRequest.d.ts +128 -0
  282. package/dist/esm/models/UploadAssetRequest.js +79 -0
  283. package/dist/esm/models/UploadAssetRequest1.d.ts +128 -0
  284. package/dist/esm/models/UploadAssetRequest1.js +79 -0
  285. package/dist/esm/models/UploadAssetResponse.d.ts +122 -0
  286. package/dist/esm/models/UploadAssetResponse.js +93 -0
  287. package/dist/esm/models/ValidateTokenResponse.d.ts +32 -0
  288. package/dist/esm/models/ValidateTokenResponse.js +43 -0
  289. package/dist/esm/models/index.d.ts +127 -0
  290. package/dist/esm/models/index.js +129 -0
  291. package/dist/esm/runtime.d.ts +184 -0
  292. package/dist/esm/runtime.js +334 -0
  293. package/dist/index.d.ts +3 -0
  294. package/dist/index.js +21 -0
  295. package/dist/models/AddCollectionAssetsRequest.d.ts +38 -0
  296. package/dist/models/AddCollectionAssetsRequest.js +50 -0
  297. package/dist/models/AddCollectionAssetsResponse.d.ts +33 -0
  298. package/dist/models/AddCollectionAssetsResponse.js +51 -0
  299. package/dist/models/AiVisionGeneralResponse.d.ts +32 -0
  300. package/dist/models/AiVisionGeneralResponse.js +48 -0
  301. package/dist/models/AnalyticsResponse.d.ts +32 -0
  302. package/dist/models/AnalyticsResponse.js +50 -0
  303. package/dist/models/AnalyzeAiVisionGeneralRequest.d.ts +51 -0
  304. package/dist/models/AnalyzeAiVisionGeneralRequest.js +59 -0
  305. package/dist/models/AnalyzeAiVisionGeneralRequestSource.d.ts +38 -0
  306. package/dist/models/AnalyzeAiVisionGeneralRequestSource.js +50 -0
  307. package/dist/models/AppStorageErrorResponse.d.ts +32 -0
  308. package/dist/models/AppStorageErrorResponse.js +50 -0
  309. package/dist/models/AppStorageGetResponse.d.ts +38 -0
  310. package/dist/models/AppStorageGetResponse.js +52 -0
  311. package/dist/models/AppStorageSetErrorResponse.d.ts +32 -0
  312. package/dist/models/AppStorageSetErrorResponse.js +50 -0
  313. package/dist/models/AppStorageSetResponse.d.ts +38 -0
  314. package/dist/models/AppStorageSetResponse.js +52 -0
  315. package/dist/models/Asset.d.ts +134 -0
  316. package/dist/models/Asset.js +90 -0
  317. package/dist/models/AssetHistoryResponse.d.ts +39 -0
  318. package/dist/models/AssetHistoryResponse.js +51 -0
  319. package/dist/models/AssetHistoryResponseAssetHistoryInner.d.ts +67 -0
  320. package/dist/models/AssetHistoryResponseAssetHistoryInner.js +71 -0
  321. package/dist/models/AssetSearchResponse.d.ts +76 -0
  322. package/dist/models/AssetSearchResponse.js +78 -0
  323. package/dist/models/AuthCredentialsResponse.d.ts +40 -0
  324. package/dist/models/AuthCredentialsResponse.js +56 -0
  325. package/dist/models/AuthCustomer.d.ts +80 -0
  326. package/dist/models/AuthCustomer.js +80 -0
  327. package/dist/models/AuthUser.d.ts +50 -0
  328. package/dist/models/AuthUser.js +58 -0
  329. package/dist/models/AutocompleteAsset.d.ts +259 -0
  330. package/dist/models/AutocompleteAsset.js +195 -0
  331. package/dist/models/AutocompleteAssetCustomer.d.ts +33 -0
  332. package/dist/models/AutocompleteAssetCustomer.js +51 -0
  333. package/dist/models/AutocompleteAssetCustomerCustomer.d.ts +509 -0
  334. package/dist/models/AutocompleteAssetCustomerCustomer.js +367 -0
  335. package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.d.ts +38 -0
  336. package/dist/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.js +54 -0
  337. package/dist/models/AutocompleteAssetCustomerCustomerConfig.d.ts +76 -0
  338. package/dist/models/AutocompleteAssetCustomerCustomerConfig.js +80 -0
  339. package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.d.ts +32 -0
  340. package/dist/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.js +50 -0
  341. package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.d.ts +38 -0
  342. package/dist/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.js +54 -0
  343. package/dist/models/AutocompleteAssetCustomerCustomerLimits.d.ts +56 -0
  344. package/dist/models/AutocompleteAssetCustomerCustomerLimits.js +66 -0
  345. package/dist/models/AutocompleteAssetFullProps.d.ts +245 -0
  346. package/dist/models/AutocompleteAssetFullProps.js +185 -0
  347. package/dist/models/AutocompleteAssetFullPropsCreatedBy.d.ts +44 -0
  348. package/dist/models/AutocompleteAssetFullPropsCreatedBy.js +58 -0
  349. package/dist/models/AutocompleteFolder.d.ts +50 -0
  350. package/dist/models/AutocompleteFolder.js +62 -0
  351. package/dist/models/AutocompleteResponse.d.ts +70 -0
  352. package/dist/models/AutocompleteResponse.js +76 -0
  353. package/dist/models/BackreferenceHistoryEntry.d.ts +53 -0
  354. package/dist/models/BackreferenceHistoryEntry.js +67 -0
  355. package/dist/models/BackreferenceResult.d.ts +39 -0
  356. package/dist/models/BackreferenceResult.js +55 -0
  357. package/dist/models/BackreferenceResultBackref.d.ts +52 -0
  358. package/dist/models/BackreferenceResultBackref.js +64 -0
  359. package/dist/models/CldtTemplate.d.ts +107 -0
  360. package/dist/models/CldtTemplate.js +101 -0
  361. package/dist/models/CldtTemplateCanvas.d.ts +38 -0
  362. package/dist/models/CldtTemplateCanvas.js +54 -0
  363. package/dist/models/CldtTemplateProvenance.d.ts +64 -0
  364. package/dist/models/CldtTemplateProvenance.js +68 -0
  365. package/dist/models/CldtTemplateVariable.d.ts +56 -0
  366. package/dist/models/CldtTemplateVariable.js +62 -0
  367. package/dist/models/Collection.d.ts +135 -0
  368. package/dist/models/Collection.js +83 -0
  369. package/dist/models/CollectionPermissions.d.ts +38 -0
  370. package/dist/models/CollectionPermissions.js +50 -0
  371. package/dist/models/ContextualMetadataField.d.ts +32 -0
  372. package/dist/models/ContextualMetadataField.js +50 -0
  373. package/dist/models/CreateAssetMetadataFieldRequest.d.ts +56 -0
  374. package/dist/models/CreateAssetMetadataFieldRequest.js +60 -0
  375. package/dist/models/CreateCollectionRequest.d.ts +61 -0
  376. package/dist/models/CreateCollectionRequest.js +63 -0
  377. package/dist/models/CreateCollectionResponse.d.ts +33 -0
  378. package/dist/models/CreateCollectionResponse.js +51 -0
  379. package/dist/models/CreateFolderRequest.d.ts +38 -0
  380. package/dist/models/CreateFolderRequest.js +52 -0
  381. package/dist/models/CreateFolderResponse.d.ts +33 -0
  382. package/dist/models/CreateFolderResponse.js +51 -0
  383. package/dist/models/CreateFolderResponseFolder.d.ts +75 -0
  384. package/dist/models/CreateFolderResponseFolder.js +79 -0
  385. package/dist/models/CreateFolderResponseFolderViewableParentsInner.d.ts +38 -0
  386. package/dist/models/CreateFolderResponseFolderViewableParentsInner.js +54 -0
  387. package/dist/models/CreateMetadataFieldResponse.d.ts +44 -0
  388. package/dist/models/CreateMetadataFieldResponse.js +58 -0
  389. package/dist/models/CreateNamespaceTokenRequest.d.ts +38 -0
  390. package/dist/models/CreateNamespaceTokenRequest.js +54 -0
  391. package/dist/models/Customer.d.ts +207 -0
  392. package/dist/models/Customer.js +165 -0
  393. package/dist/models/CustomerListMeta.d.ts +74 -0
  394. package/dist/models/CustomerListMeta.js +78 -0
  395. package/dist/models/CustomerUploadLimits.d.ts +56 -0
  396. package/dist/models/CustomerUploadLimits.js +66 -0
  397. package/dist/models/DamAppErrorResponse.d.ts +32 -0
  398. package/dist/models/DamAppErrorResponse.js +50 -0
  399. package/dist/models/DamAppResponse.d.ts +153 -0
  400. package/dist/models/DamAppResponse.js +110 -0
  401. package/dist/models/DamAppResponseAppMessageParamsValue.d.ts +38 -0
  402. package/dist/models/DamAppResponseAppMessageParamsValue.js +52 -0
  403. package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.d.ts +38 -0
  404. package/dist/models/DamAppResponseAppMessageParamsValueAnyOf.js +52 -0
  405. package/dist/models/DamAppResponseAssetAmountLimit.d.ts +26 -0
  406. package/dist/models/DamAppResponseAssetAmountLimit.js +38 -0
  407. package/dist/models/DamAppUserSnapshot.d.ts +50 -0
  408. package/dist/models/DamAppUserSnapshot.js +54 -0
  409. package/dist/models/DeleteFolderResponse.d.ts +38 -0
  410. package/dist/models/DeleteFolderResponse.js +50 -0
  411. package/dist/models/DeployApp200Response.d.ts +44 -0
  412. package/dist/models/DeployApp200Response.js +58 -0
  413. package/dist/models/DeployApp207Response.d.ts +50 -0
  414. package/dist/models/DeployApp207Response.js +62 -0
  415. package/dist/models/DeployApp400Response.d.ts +32 -0
  416. package/dist/models/DeployApp400Response.js +50 -0
  417. package/dist/models/DeployAppRequest.d.ts +50 -0
  418. package/dist/models/DeployAppRequest.js +60 -0
  419. package/dist/models/DownloadAssetRequest.d.ts +50 -0
  420. package/dist/models/DownloadAssetRequest.js +54 -0
  421. package/dist/models/DownloadAssetResponse.d.ts +32 -0
  422. package/dist/models/DownloadAssetResponse.js +48 -0
  423. package/dist/models/DownloadCollectionResponse.d.ts +38 -0
  424. package/dist/models/DownloadCollectionResponse.js +50 -0
  425. package/dist/models/ErrorResponse.d.ts +32 -0
  426. package/dist/models/ErrorResponse.js +50 -0
  427. package/dist/models/ErrorWithMessageResponse.d.ts +38 -0
  428. package/dist/models/ErrorWithMessageResponse.js +54 -0
  429. package/dist/models/FieldAggregation.d.ts +39 -0
  430. package/dist/models/FieldAggregation.js +55 -0
  431. package/dist/models/FieldAggregationBucketsInner.d.ts +38 -0
  432. package/dist/models/FieldAggregationBucketsInner.js +54 -0
  433. package/dist/models/FontDefinition.d.ts +44 -0
  434. package/dist/models/FontDefinition.js +58 -0
  435. package/dist/models/FontLookupResponse.d.ts +33 -0
  436. package/dist/models/FontLookupResponse.js +51 -0
  437. package/dist/models/FontLookupResponseFontsInner.d.ts +96 -0
  438. package/dist/models/FontLookupResponseFontsInner.js +100 -0
  439. package/dist/models/FontProvisioningResponse.d.ts +33 -0
  440. package/dist/models/FontProvisioningResponse.js +51 -0
  441. package/dist/models/ForbiddenResponse.d.ts +32 -0
  442. package/dist/models/ForbiddenResponse.js +50 -0
  443. package/dist/models/GoogleFontListingResponse.d.ts +33 -0
  444. package/dist/models/GoogleFontListingResponse.js +51 -0
  445. package/dist/models/ListAssetsByFolderResponse.d.ts +40 -0
  446. package/dist/models/ListAssetsByFolderResponse.js +54 -0
  447. package/dist/models/ListAssetsByFolderResponseMeta.d.ts +38 -0
  448. package/dist/models/ListAssetsByFolderResponseMeta.js +52 -0
  449. package/dist/models/ListBackreferencesResponse.d.ts +45 -0
  450. package/dist/models/ListBackreferencesResponse.js +59 -0
  451. package/dist/models/ListBackreferencesResponseBackrefsInner.d.ts +52 -0
  452. package/dist/models/ListBackreferencesResponseBackrefsInner.js +64 -0
  453. package/dist/models/ListCollectionsResponse.d.ts +51 -0
  454. package/dist/models/ListCollectionsResponse.js +57 -0
  455. package/dist/models/ListContextualMetadataFieldsResponse.d.ts +39 -0
  456. package/dist/models/ListContextualMetadataFieldsResponse.js +53 -0
  457. package/dist/models/ListCustomersResponse.d.ts +40 -0
  458. package/dist/models/ListCustomersResponse.js +56 -0
  459. package/dist/models/ListMetadataFieldsResponse.d.ts +33 -0
  460. package/dist/models/ListMetadataFieldsResponse.js +51 -0
  461. package/dist/models/ListSubfoldersResponse.d.ts +57 -0
  462. package/dist/models/ListSubfoldersResponse.js +59 -0
  463. package/dist/models/ListSubfoldersResponseFoldersInner.d.ts +62 -0
  464. package/dist/models/ListSubfoldersResponseFoldersInner.js +64 -0
  465. package/dist/models/ListTransformationsResponse.d.ts +39 -0
  466. package/dist/models/ListTransformationsResponse.js +53 -0
  467. package/dist/models/LocationSegment.d.ts +38 -0
  468. package/dist/models/LocationSegment.js +52 -0
  469. package/dist/models/LookupFontRequest.d.ts +33 -0
  470. package/dist/models/LookupFontRequest.js +51 -0
  471. package/dist/models/LookupFontRequestFontsInner.d.ts +69 -0
  472. package/dist/models/LookupFontRequestFontsInner.js +82 -0
  473. package/dist/models/NamespaceTokenCreateErrorResponse.d.ts +32 -0
  474. package/dist/models/NamespaceTokenCreateErrorResponse.js +50 -0
  475. package/dist/models/NamespaceTokenCreateResponse.d.ts +32 -0
  476. package/dist/models/NamespaceTokenCreateResponse.js +50 -0
  477. package/dist/models/PrepareUploadRequest.d.ts +33 -0
  478. package/dist/models/PrepareUploadRequest.js +49 -0
  479. package/dist/models/PrepareUploadRequestUploadParams.d.ts +200 -0
  480. package/dist/models/PrepareUploadRequestUploadParams.js +104 -0
  481. package/dist/models/PrepareUploadResponse.d.ts +51 -0
  482. package/dist/models/PrepareUploadResponse.js +61 -0
  483. package/dist/models/ProvisionFontRequest.d.ts +39 -0
  484. package/dist/models/ProvisionFontRequest.js +53 -0
  485. package/dist/models/RefreshTokenErrorResponse.d.ts +32 -0
  486. package/dist/models/RefreshTokenErrorResponse.js +50 -0
  487. package/dist/models/RefreshTokenResponse.d.ts +32 -0
  488. package/dist/models/RefreshTokenResponse.js +50 -0
  489. package/dist/models/RemoveCollectionAssetsRequest.d.ts +38 -0
  490. package/dist/models/RemoveCollectionAssetsRequest.js +50 -0
  491. package/dist/models/RemoveCollectionAssetsResponse.d.ts +33 -0
  492. package/dist/models/RemoveCollectionAssetsResponse.js +51 -0
  493. package/dist/models/ResourceActor.d.ts +38 -0
  494. package/dist/models/ResourceActor.js +54 -0
  495. package/dist/models/SearchAsset.d.ts +257 -0
  496. package/dist/models/SearchAsset.js +189 -0
  497. package/dist/models/SearchCollectionsRequest.d.ts +60 -0
  498. package/dist/models/SearchCollectionsRequest.js +56 -0
  499. package/dist/models/SearchCollectionsResponse.d.ts +51 -0
  500. package/dist/models/SearchCollectionsResponse.js +57 -0
  501. package/dist/models/SetAppStorageValueRequest.d.ts +32 -0
  502. package/dist/models/SetAppStorageValueRequest.js +48 -0
  503. package/dist/models/SignAndUploadRequest.d.ts +176 -0
  504. package/dist/models/SignAndUploadRequest.js +98 -0
  505. package/dist/models/SignAndUploadRequest1.d.ts +176 -0
  506. package/dist/models/SignAndUploadRequest1.js +98 -0
  507. package/dist/models/SignAndUploadResponse.d.ts +122 -0
  508. package/dist/models/SignAndUploadResponse.js +100 -0
  509. package/dist/models/StructuredMetadataField.d.ts +68 -0
  510. package/dist/models/StructuredMetadataField.js +60 -0
  511. package/dist/models/TemplateResourceTuple.d.ts +40 -0
  512. package/dist/models/TemplateResourceTuple.js +56 -0
  513. package/dist/models/TemplateSearchResponse.d.ts +57 -0
  514. package/dist/models/TemplateSearchResponse.js +67 -0
  515. package/dist/models/ThumbnailsTokenResponse.d.ts +44 -0
  516. package/dist/models/ThumbnailsTokenResponse.js +58 -0
  517. package/dist/models/TrackAnalyticsEventRequest.d.ts +32 -0
  518. package/dist/models/TrackAnalyticsEventRequest.js +50 -0
  519. package/dist/models/Transformation.d.ts +80 -0
  520. package/dist/models/Transformation.js +64 -0
  521. package/dist/models/UpdateAppRequest.d.ts +40 -0
  522. package/dist/models/UpdateAppRequest.js +50 -0
  523. package/dist/models/UpdateAssetBackreferencesRequest.d.ts +62 -0
  524. package/dist/models/UpdateAssetBackreferencesRequest.js +70 -0
  525. package/dist/models/UpdateAssetMetadataRequest.d.ts +49 -0
  526. package/dist/models/UpdateAssetMetadataRequest.js +56 -0
  527. package/dist/models/UpdateAssetMetadataRequestMetadataValue.d.ts +26 -0
  528. package/dist/models/UpdateAssetMetadataRequestMetadataValue.js +38 -0
  529. package/dist/models/UpdateAssetMetadataResponse.d.ts +49 -0
  530. package/dist/models/UpdateAssetMetadataResponse.js +56 -0
  531. package/dist/models/UpdateAssetTagsRequest.d.ts +52 -0
  532. package/dist/models/UpdateAssetTagsRequest.js +66 -0
  533. package/dist/models/UpdateAssetTagsResponse.d.ts +32 -0
  534. package/dist/models/UpdateAssetTagsResponse.js +50 -0
  535. package/dist/models/UpdateBackreferencesResponse.d.ts +33 -0
  536. package/dist/models/UpdateBackreferencesResponse.js +51 -0
  537. package/dist/models/UpdateCollectionRequest.d.ts +46 -0
  538. package/dist/models/UpdateCollectionRequest.js +52 -0
  539. package/dist/models/UpdateCollectionResponse.d.ts +33 -0
  540. package/dist/models/UpdateCollectionResponse.js +51 -0
  541. package/dist/models/UploadAssetRequest.d.ts +128 -0
  542. package/dist/models/UploadAssetRequest.js +86 -0
  543. package/dist/models/UploadAssetRequest1.d.ts +128 -0
  544. package/dist/models/UploadAssetRequest1.js +86 -0
  545. package/dist/models/UploadAssetResponse.d.ts +122 -0
  546. package/dist/models/UploadAssetResponse.js +100 -0
  547. package/dist/models/ValidateTokenResponse.d.ts +32 -0
  548. package/dist/models/ValidateTokenResponse.js +50 -0
  549. package/dist/models/index.d.ts +127 -0
  550. package/dist/models/index.js +145 -0
  551. package/dist/runtime.d.ts +184 -0
  552. package/dist/runtime.js +350 -0
  553. package/docs/AddCollectionAssetsRequest.md +36 -0
  554. package/docs/AddCollectionAssetsResponse.md +34 -0
  555. package/docs/AiVisionGeneralResponse.md +34 -0
  556. package/docs/AnalyticsResponse.md +34 -0
  557. package/docs/AnalyzeAiVisionGeneralRequest.md +40 -0
  558. package/docs/AnalyzeAiVisionGeneralRequestSource.md +37 -0
  559. package/docs/AppStorageErrorResponse.md +34 -0
  560. package/docs/AppStorageGetResponse.md +36 -0
  561. package/docs/AppStorageSetErrorResponse.md +34 -0
  562. package/docs/AppStorageSetResponse.md +36 -0
  563. package/docs/Asset.md +68 -0
  564. package/docs/AssetHistoryResponse.md +36 -0
  565. package/docs/AssetHistoryResponseAssetHistoryInner.md +40 -0
  566. package/docs/AssetManagementApi.md +2029 -0
  567. package/docs/AssetSearchResponse.md +48 -0
  568. package/docs/AuthCredentialsResponse.md +36 -0
  569. package/docs/AuthCustomer.md +50 -0
  570. package/docs/AuthUser.md +40 -0
  571. package/docs/AutocompleteAsset.md +108 -0
  572. package/docs/AutocompleteAssetCustomer.md +34 -0
  573. package/docs/AutocompleteAssetCustomerCustomer.md +192 -0
  574. package/docs/AutocompleteAssetCustomerCustomerCdnConfigAttrs.md +36 -0
  575. package/docs/AutocompleteAssetCustomerCustomerConfig.md +48 -0
  576. package/docs/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.md +34 -0
  577. package/docs/AutocompleteAssetCustomerCustomerConfigHookTimeouts.md +36 -0
  578. package/docs/AutocompleteAssetCustomerCustomerLimits.md +42 -0
  579. package/docs/AutocompleteAssetFullProps.md +104 -0
  580. package/docs/AutocompleteAssetFullPropsCreatedBy.md +38 -0
  581. package/docs/AutocompleteFolder.md +40 -0
  582. package/docs/AutocompleteResponse.md +46 -0
  583. package/docs/BackreferenceHistoryEntry.md +38 -0
  584. package/docs/BackreferenceResult.md +36 -0
  585. package/docs/BackreferenceResultBackref.md +40 -0
  586. package/docs/CldtTemplate.md +58 -0
  587. package/docs/CldtTemplateCanvas.md +36 -0
  588. package/docs/CldtTemplateProvenance.md +44 -0
  589. package/docs/CldtTemplateVariable.md +42 -0
  590. package/docs/Collection.md +68 -0
  591. package/docs/CollectionPermissions.md +36 -0
  592. package/docs/ConsoleApi.md +1454 -0
  593. package/docs/ContextualMetadataField.md +34 -0
  594. package/docs/CreateAssetMetadataFieldRequest.md +42 -0
  595. package/docs/CreateCollectionRequest.md +40 -0
  596. package/docs/CreateCollectionResponse.md +34 -0
  597. package/docs/CreateFolderRequest.md +36 -0
  598. package/docs/CreateFolderResponse.md +34 -0
  599. package/docs/CreateFolderResponseFolder.md +48 -0
  600. package/docs/CreateFolderResponseFolderViewableParentsInner.md +36 -0
  601. package/docs/CreateMetadataFieldResponse.md +38 -0
  602. package/docs/CreateNamespaceTokenRequest.md +36 -0
  603. package/docs/Customer.md +92 -0
  604. package/docs/CustomerListMeta.md +48 -0
  605. package/docs/CustomerUploadLimits.md +42 -0
  606. package/docs/DamAppErrorResponse.md +34 -0
  607. package/docs/DamAppResponse.md +68 -0
  608. package/docs/DamAppResponseAppMessageParamsValue.md +36 -0
  609. package/docs/DamAppResponseAppMessageParamsValueAnyOf.md +36 -0
  610. package/docs/DamAppResponseAssetAmountLimit.md +33 -0
  611. package/docs/DamAppUserSnapshot.md +40 -0
  612. package/docs/DeleteFolderResponse.md +36 -0
  613. package/docs/DeployApp200Response.md +38 -0
  614. package/docs/DeployApp207Response.md +40 -0
  615. package/docs/DeployApp400Response.md +34 -0
  616. package/docs/DeployAppRequest.md +40 -0
  617. package/docs/DownloadAssetRequest.md +40 -0
  618. package/docs/DownloadAssetResponse.md +34 -0
  619. package/docs/DownloadCollectionResponse.md +36 -0
  620. package/docs/ErrorResponse.md +34 -0
  621. package/docs/ErrorWithMessageResponse.md +36 -0
  622. package/docs/FieldAggregation.md +36 -0
  623. package/docs/FieldAggregationBucketsInner.md +36 -0
  624. package/docs/FontDefinition.md +38 -0
  625. package/docs/FontLookupResponse.md +34 -0
  626. package/docs/FontLookupResponseFontsInner.md +44 -0
  627. package/docs/FontProvisioningResponse.md +34 -0
  628. package/docs/ForbiddenResponse.md +34 -0
  629. package/docs/GoogleFontListingResponse.md +34 -0
  630. package/docs/ListAssetsByFolderResponse.md +36 -0
  631. package/docs/ListAssetsByFolderResponseMeta.md +36 -0
  632. package/docs/ListBackreferencesResponse.md +38 -0
  633. package/docs/ListBackreferencesResponseBackrefsInner.md +40 -0
  634. package/docs/ListCollectionsResponse.md +40 -0
  635. package/docs/ListContextualMetadataFieldsResponse.md +36 -0
  636. package/docs/ListCustomersResponse.md +36 -0
  637. package/docs/ListMetadataFieldsResponse.md +34 -0
  638. package/docs/ListSubfoldersResponse.md +42 -0
  639. package/docs/ListSubfoldersResponseFoldersInner.md +44 -0
  640. package/docs/ListTransformationsResponse.md +36 -0
  641. package/docs/LocationSegment.md +36 -0
  642. package/docs/LookupFontRequest.md +34 -0
  643. package/docs/LookupFontRequestFontsInner.md +38 -0
  644. package/docs/MediaApi.md +790 -0
  645. package/docs/NamespaceTokenCreateErrorResponse.md +34 -0
  646. package/docs/NamespaceTokenCreateResponse.md +34 -0
  647. package/docs/PlatformApi.md +915 -0
  648. package/docs/PrepareUploadRequest.md +34 -0
  649. package/docs/PrepareUploadRequestUploadParams.md +90 -0
  650. package/docs/PrepareUploadResponse.md +40 -0
  651. package/docs/ProvisionFontRequest.md +36 -0
  652. package/docs/RefreshTokenErrorResponse.md +34 -0
  653. package/docs/RefreshTokenResponse.md +34 -0
  654. package/docs/RemoveCollectionAssetsRequest.md +36 -0
  655. package/docs/RemoveCollectionAssetsResponse.md +34 -0
  656. package/docs/ResourceActor.md +36 -0
  657. package/docs/SearchAsset.md +108 -0
  658. package/docs/SearchCollectionsRequest.md +42 -0
  659. package/docs/SearchCollectionsResponse.md +40 -0
  660. package/docs/SetAppStorageValueRequest.md +34 -0
  661. package/docs/SignAndUploadRequest.md +82 -0
  662. package/docs/SignAndUploadRequest1.md +82 -0
  663. package/docs/SignAndUploadResponse.md +64 -0
  664. package/docs/StructuredMetadataField.md +46 -0
  665. package/docs/TemplateResourceTuple.md +36 -0
  666. package/docs/TemplateSearchResponse.md +42 -0
  667. package/docs/ThumbnailsTokenResponse.md +38 -0
  668. package/docs/TrackAnalyticsEventRequest.md +34 -0
  669. package/docs/Transformation.md +50 -0
  670. package/docs/UpdateAppRequest.md +36 -0
  671. package/docs/UpdateAssetBackreferencesRequest.md +40 -0
  672. package/docs/UpdateAssetMetadataRequest.md +38 -0
  673. package/docs/UpdateAssetMetadataRequestMetadataValue.md +32 -0
  674. package/docs/UpdateAssetMetadataResponse.md +38 -0
  675. package/docs/UpdateAssetTagsRequest.md +38 -0
  676. package/docs/UpdateAssetTagsResponse.md +34 -0
  677. package/docs/UpdateBackreferencesResponse.md +34 -0
  678. package/docs/UpdateCollectionRequest.md +38 -0
  679. package/docs/UpdateCollectionResponse.md +34 -0
  680. package/docs/UploadApi.md +210 -0
  681. package/docs/UploadAssetRequest.md +66 -0
  682. package/docs/UploadAssetRequest1.md +66 -0
  683. package/docs/UploadAssetResponse.md +64 -0
  684. package/docs/UtilsApi.md +745 -0
  685. package/docs/ValidateTokenResponse.md +34 -0
  686. package/package.json +21 -0
  687. package/src/apis/AssetManagementApi.ts +1671 -0
  688. package/src/apis/ConsoleApi.ts +1404 -0
  689. package/src/apis/MediaApi.ts +849 -0
  690. package/src/apis/PlatformApi.ts +812 -0
  691. package/src/apis/UploadApi.ts +284 -0
  692. package/src/apis/UtilsApi.ts +637 -0
  693. package/src/apis/index.ts +8 -0
  694. package/src/index.ts +5 -0
  695. package/src/models/AddCollectionAssetsRequest.ts +73 -0
  696. package/src/models/AddCollectionAssetsResponse.ts +74 -0
  697. package/src/models/AiVisionGeneralResponse.ts +65 -0
  698. package/src/models/AnalyticsResponse.ts +66 -0
  699. package/src/models/AnalyzeAiVisionGeneralRequest.ts +99 -0
  700. package/src/models/AnalyzeAiVisionGeneralRequestSource.ts +73 -0
  701. package/src/models/AppStorageErrorResponse.ts +66 -0
  702. package/src/models/AppStorageGetResponse.ts +74 -0
  703. package/src/models/AppStorageSetErrorResponse.ts +66 -0
  704. package/src/models/AppStorageSetResponse.ts +74 -0
  705. package/src/models/Asset.ts +205 -0
  706. package/src/models/AssetHistoryResponse.ts +81 -0
  707. package/src/models/AssetHistoryResponseAssetHistoryInner.ts +109 -0
  708. package/src/models/AssetSearchResponse.ts +143 -0
  709. package/src/models/AuthCredentialsResponse.ts +90 -0
  710. package/src/models/AuthCustomer.ts +137 -0
  711. package/src/models/AuthUser.ts +91 -0
  712. package/src/models/AutocompleteAsset.ts +418 -0
  713. package/src/models/AutocompleteAssetCustomer.ts +74 -0
  714. package/src/models/AutocompleteAssetCustomerCustomer.ts +798 -0
  715. package/src/models/AutocompleteAssetCustomerCustomerCdnConfigAttrs.ts +75 -0
  716. package/src/models/AutocompleteAssetCustomerCustomerConfig.ts +144 -0
  717. package/src/models/AutocompleteAssetCustomerCustomerConfigFlagProbabilities.ts +66 -0
  718. package/src/models/AutocompleteAssetCustomerCustomerConfigHookTimeouts.ts +75 -0
  719. package/src/models/AutocompleteAssetCustomerCustomerLimits.ts +102 -0
  720. package/src/models/AutocompleteAssetFullProps.ts +386 -0
  721. package/src/models/AutocompleteAssetFullPropsCreatedBy.ts +84 -0
  722. package/src/models/AutocompleteFolder.ts +93 -0
  723. package/src/models/AutocompleteResponse.ts +135 -0
  724. package/src/models/BackreferenceHistoryEntry.ts +96 -0
  725. package/src/models/BackreferenceResult.ts +83 -0
  726. package/src/models/BackreferenceResultBackref.ts +108 -0
  727. package/src/models/CldtTemplate.ts +196 -0
  728. package/src/models/CldtTemplateCanvas.ts +75 -0
  729. package/src/models/CldtTemplateProvenance.ts +110 -0
  730. package/src/models/CldtTemplateVariable.ts +100 -0
  731. package/src/models/Collection.ts +209 -0
  732. package/src/models/CollectionPermissions.ts +73 -0
  733. package/src/models/ContextualMetadataField.ts +66 -0
  734. package/src/models/CreateAssetMetadataFieldRequest.ts +99 -0
  735. package/src/models/CreateCollectionRequest.ts +101 -0
  736. package/src/models/CreateCollectionResponse.ts +74 -0
  737. package/src/models/CreateFolderRequest.ts +74 -0
  738. package/src/models/CreateFolderResponse.ts +74 -0
  739. package/src/models/CreateFolderResponseFolder.ts +137 -0
  740. package/src/models/CreateFolderResponseFolderViewableParentsInner.ts +75 -0
  741. package/src/models/CreateMetadataFieldResponse.ts +84 -0
  742. package/src/models/CreateNamespaceTokenRequest.ts +75 -0
  743. package/src/models/Customer.ts +334 -0
  744. package/src/models/CustomerListMeta.ts +129 -0
  745. package/src/models/CustomerUploadLimits.ts +102 -0
  746. package/src/models/DamAppErrorResponse.ts +66 -0
  747. package/src/models/DamAppResponse.ts +243 -0
  748. package/src/models/DamAppResponseAppMessageParamsValue.ts +82 -0
  749. package/src/models/DamAppResponseAppMessageParamsValueAnyOf.ts +74 -0
  750. package/src/models/DamAppResponseAssetAmountLimit.ts +46 -0
  751. package/src/models/DamAppUserSnapshot.ts +89 -0
  752. package/src/models/DeleteFolderResponse.ts +73 -0
  753. package/src/models/DeployApp200Response.ts +84 -0
  754. package/src/models/DeployApp207Response.ts +93 -0
  755. package/src/models/DeployApp400Response.ts +66 -0
  756. package/src/models/DeployAppRequest.ts +92 -0
  757. package/src/models/DownloadAssetRequest.ts +89 -0
  758. package/src/models/DownloadAssetResponse.ts +65 -0
  759. package/src/models/DownloadCollectionResponse.ts +73 -0
  760. package/src/models/ErrorResponse.ts +66 -0
  761. package/src/models/ErrorWithMessageResponse.ts +75 -0
  762. package/src/models/FieldAggregation.ts +83 -0
  763. package/src/models/FieldAggregationBucketsInner.ts +75 -0
  764. package/src/models/FontDefinition.ts +84 -0
  765. package/src/models/FontLookupResponse.ts +74 -0
  766. package/src/models/FontLookupResponseFontsInner.ts +149 -0
  767. package/src/models/FontProvisioningResponse.ts +74 -0
  768. package/src/models/ForbiddenResponse.ts +66 -0
  769. package/src/models/GoogleFontListingResponse.ts +74 -0
  770. package/src/models/ListAssetsByFolderResponse.ts +89 -0
  771. package/src/models/ListAssetsByFolderResponseMeta.ts +74 -0
  772. package/src/models/ListBackreferencesResponse.ts +92 -0
  773. package/src/models/ListBackreferencesResponseBackrefsInner.ts +108 -0
  774. package/src/models/ListCollectionsResponse.ts +98 -0
  775. package/src/models/ListContextualMetadataFieldsResponse.ts +82 -0
  776. package/src/models/ListCustomersResponse.ts +90 -0
  777. package/src/models/ListMetadataFieldsResponse.ts +74 -0
  778. package/src/models/ListSubfoldersResponse.ts +106 -0
  779. package/src/models/ListSubfoldersResponseFoldersInner.ts +108 -0
  780. package/src/models/ListTransformationsResponse.ts +82 -0
  781. package/src/models/LocationSegment.ts +74 -0
  782. package/src/models/LookupFontRequest.ts +74 -0
  783. package/src/models/LookupFontRequestFontsInner.ts +113 -0
  784. package/src/models/NamespaceTokenCreateErrorResponse.ts +66 -0
  785. package/src/models/NamespaceTokenCreateResponse.ts +66 -0
  786. package/src/models/PrepareUploadRequest.ts +73 -0
  787. package/src/models/PrepareUploadRequestUploadParams.ts +289 -0
  788. package/src/models/PrepareUploadResponse.ts +100 -0
  789. package/src/models/ProvisionFontRequest.ts +82 -0
  790. package/src/models/RefreshTokenErrorResponse.ts +66 -0
  791. package/src/models/RefreshTokenResponse.ts +66 -0
  792. package/src/models/RemoveCollectionAssetsRequest.ts +73 -0
  793. package/src/models/RemoveCollectionAssetsResponse.ts +74 -0
  794. package/src/models/ResourceActor.ts +75 -0
  795. package/src/models/SearchAsset.ts +402 -0
  796. package/src/models/SearchCollectionsRequest.ts +97 -0
  797. package/src/models/SearchCollectionsResponse.ts +98 -0
  798. package/src/models/SetAppStorageValueRequest.ts +65 -0
  799. package/src/models/SignAndUploadRequest.ts +258 -0
  800. package/src/models/SignAndUploadRequest1.ts +258 -0
  801. package/src/models/SignAndUploadResponse.ts +196 -0
  802. package/src/models/StructuredMetadataField.ts +113 -0
  803. package/src/models/TemplateResourceTuple.ts +90 -0
  804. package/src/models/TemplateSearchResponse.ts +110 -0
  805. package/src/models/ThumbnailsTokenResponse.ts +84 -0
  806. package/src/models/TrackAnalyticsEventRequest.ts +66 -0
  807. package/src/models/Transformation.ts +129 -0
  808. package/src/models/UpdateAppRequest.ts +73 -0
  809. package/src/models/UpdateAssetBackreferencesRequest.ts +112 -0
  810. package/src/models/UpdateAssetMetadataRequest.ts +90 -0
  811. package/src/models/UpdateAssetMetadataRequestMetadataValue.ts +46 -0
  812. package/src/models/UpdateAssetMetadataResponse.ts +90 -0
  813. package/src/models/UpdateAssetTagsRequest.ts +95 -0
  814. package/src/models/UpdateAssetTagsResponse.ts +66 -0
  815. package/src/models/UpdateBackreferencesResponse.ts +74 -0
  816. package/src/models/UpdateCollectionRequest.ts +81 -0
  817. package/src/models/UpdateCollectionResponse.ts +74 -0
  818. package/src/models/UploadAssetRequest.ts +196 -0
  819. package/src/models/UploadAssetRequest1.ts +196 -0
  820. package/src/models/UploadAssetResponse.ts +196 -0
  821. package/src/models/ValidateTokenResponse.ts +66 -0
  822. package/src/models/index.ts +129 -0
  823. package/src/runtime.ts +432 -0
  824. package/tsconfig.esm.json +7 -0
  825. package/tsconfig.json +16 -0
@@ -0,0 +1,2029 @@
1
+ # AssetManagementApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**addCollectionAssets**](AssetManagementApi.md#addcollectionassetsoperation) | **POST** /v2605/asset-management/collections/{collection_id}/assets | Add assets to a collection |
8
+ | [**autocompleteAssets**](AssetManagementApi.md#autocompleteassets) | **GET** /v2605/asset-management/assets/autocomplete | Autocomplete across assets, folders, collections, tags, and metadata |
9
+ | [**createAssetMetadataField**](AssetManagementApi.md#createassetmetadatafieldoperation) | **POST** /v2605/asset-management/assets/metadata/fields | Create a structured metadata field definition |
10
+ | [**createCollection**](AssetManagementApi.md#createcollectionoperation) | **POST** /v2605/asset-management/collections | Create a collection |
11
+ | [**createFolder**](AssetManagementApi.md#createfolderoperation) | **POST** /v2605/asset-management/folders | Create a folder |
12
+ | [**deleteFolder**](AssetManagementApi.md#deletefolder) | **DELETE** /v2605/asset-management/folders/{id} | Delete a folder |
13
+ | [**destroyCollection**](AssetManagementApi.md#destroycollection) | **DELETE** /v2605/asset-management/collections/{collection_id} | Delete a collection |
14
+ | [**downloadAsset**](AssetManagementApi.md#downloadassetoperation) | **POST** /v2605/asset-management/assets/download | Generate a download URL for an asset |
15
+ | [**downloadCollection**](AssetManagementApi.md#downloadcollection) | **POST** /v2605/asset-management/collections/{collection_id}/download | Download a collection as an archive |
16
+ | [**listAssetBackreferences**](AssetManagementApi.md#listassetbackreferences) | **GET** /v2605/asset-management/backreferences/assets/{assetId} | List backreferences for an asset |
17
+ | [**listAssetContextFields**](AssetManagementApi.md#listassetcontextfields) | **GET** /v2605/asset-management/assets/metadata/context-fields | List contextual metadata fields |
18
+ | [**listAssetHistory**](AssetManagementApi.md#listassethistory) | **GET** /v2605/asset-management/assets/{external_id}/asset-history | List asset audit history |
19
+ | [**listAssetMetadataFields**](AssetManagementApi.md#listassetmetadatafields) | **GET** /v2605/asset-management/assets/metadata/fields | List structured metadata field definitions |
20
+ | [**listAssetsByFolder**](AssetManagementApi.md#listassetsbyfolder) | **GET** /v2605/asset-management/assets/by-folder | List assets in a folder |
21
+ | [**listCollections**](AssetManagementApi.md#listcollections) | **GET** /v2605/asset-management/collections | List collections |
22
+ | [**listSubfolders**](AssetManagementApi.md#listsubfolders) | **GET** /v2605/asset-management/folders/subfolders | List child folders |
23
+ | [**listTransformations**](AssetManagementApi.md#listtransformations) | **GET** /v2605/asset-management/transformations | List named transformations |
24
+ | [**removeCollectionAssets**](AssetManagementApi.md#removecollectionassetsoperation) | **DELETE** /v2605/asset-management/collections/{collection_id}/assets | Remove assets from a collection |
25
+ | [**searchAssets**](AssetManagementApi.md#searchassets) | **POST** /v2605/asset-management/assets/search | Search assets using Cloudinary expression language |
26
+ | [**searchCollections**](AssetManagementApi.md#searchcollectionsoperation) | **POST** /v2605/asset-management/collections/search | Search collections |
27
+ | [**searchTemplates**](AssetManagementApi.md#searchtemplates) | **GET** /v2605/asset-management/templates | Search creative automation templates |
28
+ | [**showCollection**](AssetManagementApi.md#showcollection) | **GET** /v2605/asset-management/collections/{collection_id} | Get a single collection with its assets |
29
+ | [**updateAssetBackreferences**](AssetManagementApi.md#updateassetbackreferencesoperation) | **POST** /v2605/asset-management/backreferences/assets | Create, update, or remove asset backreferences |
30
+ | [**updateAssetMetadata**](AssetManagementApi.md#updateassetmetadataoperation) | **PATCH** /v2605/asset-management/assets/metadata | Update asset contextual and structured metadata |
31
+ | [**updateAssetTags**](AssetManagementApi.md#updateassettagsoperation) | **POST** /v2605/asset-management/assets/{resource_type}/tags | Add or remove a tag on assets |
32
+ | [**updateCollection**](AssetManagementApi.md#updatecollectionoperation) | **PUT** /v2605/asset-management/collections/{collection_id} | Update a collection |
33
+
34
+
35
+
36
+ ## addCollectionAssets
37
+
38
+ > AddCollectionAssetsResponse addCollectionAssets(collectionId, addCollectionAssetsRequest)
39
+
40
+ Add assets to a collection
41
+
42
+ Adds one or more assets to an existing collection by resource_ids or external_ids. Caller must have write access to both the collection and the assets.
43
+
44
+ ### Example
45
+
46
+ ```ts
47
+ import {
48
+ Configuration,
49
+ AssetManagementApi,
50
+ } from '@cloudinary/apps-api';
51
+ import type { AddCollectionAssetsOperationRequest } from '@cloudinary/apps-api';
52
+
53
+ async function example() {
54
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
55
+ const config = new Configuration({
56
+ // Configure HTTP bearer authorization: bearerAuth
57
+ accessToken: "YOUR BEARER TOKEN",
58
+ });
59
+ const api = new AssetManagementApi(config);
60
+
61
+ const body = {
62
+ // string | Collection external ID
63
+ collectionId: collectionId_example,
64
+ // AddCollectionAssetsRequest (optional)
65
+ addCollectionAssetsRequest: ...,
66
+ } satisfies AddCollectionAssetsOperationRequest;
67
+
68
+ try {
69
+ const data = await api.addCollectionAssets(body);
70
+ console.log(data);
71
+ } catch (error) {
72
+ console.error(error);
73
+ }
74
+ }
75
+
76
+ // Run the test
77
+ example().catch(console.error);
78
+ ```
79
+
80
+ ### Parameters
81
+
82
+
83
+ | Name | Type | Description | Notes |
84
+ |------------- | ------------- | ------------- | -------------|
85
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
86
+ | **addCollectionAssetsRequest** | [AddCollectionAssetsRequest](AddCollectionAssetsRequest.md) | | [Optional] |
87
+
88
+ ### Return type
89
+
90
+ [**AddCollectionAssetsResponse**](AddCollectionAssetsResponse.md)
91
+
92
+ ### Authorization
93
+
94
+ [bearerAuth](../README.md#bearerAuth)
95
+
96
+ ### HTTP request headers
97
+
98
+ - **Content-Type**: `application/json`
99
+ - **Accept**: `application/json`
100
+
101
+
102
+ ### HTTP response details
103
+ | Status code | Description | Response headers |
104
+ |-------------|-------------|------------------|
105
+ | **200** | Successful operation | - |
106
+ | **403** | Forbidden | - |
107
+
108
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
109
+
110
+
111
+ ## autocompleteAssets
112
+
113
+ > AutocompleteResponse autocompleteAssets(term, resourceType, assets, collections, folders, tags, users, withDeletedUsers, userGroups, metadataFieldOptions)
114
+
115
+ Autocomplete across assets, folders, collections, tags, and metadata
116
+
117
+ Returns typeahead suggestions for a search term across multiple entity types. Each type param (assets, folders, tags, etc.) controls the max results returned for that category; omit a param to exclude that category.
118
+
119
+ ### Example
120
+
121
+ ```ts
122
+ import {
123
+ Configuration,
124
+ AssetManagementApi,
125
+ } from '@cloudinary/apps-api';
126
+ import type { AutocompleteAssetsRequest } from '@cloudinary/apps-api';
127
+
128
+ async function example() {
129
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
130
+ const config = new Configuration({
131
+ // Configure HTTP bearer authorization: bearerAuth
132
+ accessToken: "YOUR BEARER TOKEN",
133
+ });
134
+ const api = new AssetManagementApi(config);
135
+
136
+ const body = {
137
+ // string
138
+ term: term_example,
139
+ // 'image' | 'javascript' | 'css' | 'video' | 'raw' | 'any' (optional)
140
+ resourceType: resourceType_example,
141
+ // number (optional)
142
+ assets: 56,
143
+ // number (optional)
144
+ collections: 56,
145
+ // number (optional)
146
+ folders: 56,
147
+ // number (optional)
148
+ tags: 56,
149
+ // number (optional)
150
+ users: 56,
151
+ // boolean (optional)
152
+ withDeletedUsers: true,
153
+ // number (optional)
154
+ userGroups: 56,
155
+ // number (optional)
156
+ metadataFieldOptions: 56,
157
+ } satisfies AutocompleteAssetsRequest;
158
+
159
+ try {
160
+ const data = await api.autocompleteAssets(body);
161
+ console.log(data);
162
+ } catch (error) {
163
+ console.error(error);
164
+ }
165
+ }
166
+
167
+ // Run the test
168
+ example().catch(console.error);
169
+ ```
170
+
171
+ ### Parameters
172
+
173
+
174
+ | Name | Type | Description | Notes |
175
+ |------------- | ------------- | ------------- | -------------|
176
+ | **term** | `string` | | [Defaults to `undefined`] |
177
+ | **resourceType** | `image`, `javascript`, `css`, `video`, `raw`, `any` | | [Optional] [Defaults to `undefined`] [Enum: image, javascript, css, video, raw, any] |
178
+ | **assets** | `number` | | [Optional] [Defaults to `undefined`] |
179
+ | **collections** | `number` | | [Optional] [Defaults to `undefined`] |
180
+ | **folders** | `number` | | [Optional] [Defaults to `undefined`] |
181
+ | **tags** | `number` | | [Optional] [Defaults to `undefined`] |
182
+ | **users** | `number` | | [Optional] [Defaults to `undefined`] |
183
+ | **withDeletedUsers** | `boolean` | | [Optional] [Defaults to `undefined`] |
184
+ | **userGroups** | `number` | | [Optional] [Defaults to `undefined`] |
185
+ | **metadataFieldOptions** | `number` | | [Optional] [Defaults to `undefined`] |
186
+
187
+ ### Return type
188
+
189
+ [**AutocompleteResponse**](AutocompleteResponse.md)
190
+
191
+ ### Authorization
192
+
193
+ [bearerAuth](../README.md#bearerAuth)
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: Not defined
198
+ - **Accept**: `application/json`
199
+
200
+
201
+ ### HTTP response details
202
+ | Status code | Description | Response headers |
203
+ |-------------|-------------|------------------|
204
+ | **200** | Successful operation | - |
205
+
206
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
207
+
208
+
209
+ ## createAssetMetadataField
210
+
211
+ > CreateMetadataFieldResponse createAssetMetadataField(createAssetMetadataFieldRequest)
212
+
213
+ Create a structured metadata field definition
214
+
215
+ Idempotently creates a structured metadata field for the cloud. Returns already_exists=true if a field with the given external_id is already defined.
216
+
217
+ ### Example
218
+
219
+ ```ts
220
+ import {
221
+ Configuration,
222
+ AssetManagementApi,
223
+ } from '@cloudinary/apps-api';
224
+ import type { CreateAssetMetadataFieldOperationRequest } from '@cloudinary/apps-api';
225
+
226
+ async function example() {
227
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
228
+ const config = new Configuration({
229
+ // Configure HTTP bearer authorization: bearerAuth
230
+ accessToken: "YOUR BEARER TOKEN",
231
+ });
232
+ const api = new AssetManagementApi(config);
233
+
234
+ const body = {
235
+ // CreateAssetMetadataFieldRequest (optional)
236
+ createAssetMetadataFieldRequest: ...,
237
+ } satisfies CreateAssetMetadataFieldOperationRequest;
238
+
239
+ try {
240
+ const data = await api.createAssetMetadataField(body);
241
+ console.log(data);
242
+ } catch (error) {
243
+ console.error(error);
244
+ }
245
+ }
246
+
247
+ // Run the test
248
+ example().catch(console.error);
249
+ ```
250
+
251
+ ### Parameters
252
+
253
+
254
+ | Name | Type | Description | Notes |
255
+ |------------- | ------------- | ------------- | -------------|
256
+ | **createAssetMetadataFieldRequest** | [CreateAssetMetadataFieldRequest](CreateAssetMetadataFieldRequest.md) | | [Optional] |
257
+
258
+ ### Return type
259
+
260
+ [**CreateMetadataFieldResponse**](CreateMetadataFieldResponse.md)
261
+
262
+ ### Authorization
263
+
264
+ [bearerAuth](../README.md#bearerAuth)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: `application/json`
269
+ - **Accept**: `application/json`
270
+
271
+
272
+ ### HTTP response details
273
+ | Status code | Description | Response headers |
274
+ |-------------|-------------|------------------|
275
+ | **200** | Field created or already exists | - |
276
+ | **400** | Bad request - invalid field definition | - |
277
+
278
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
279
+
280
+
281
+ ## createCollection
282
+
283
+ > CreateCollectionResponse createCollection(createCollectionRequest)
284
+
285
+ Create a collection
286
+
287
+ Creates a new collection (classic, dynamic, or temp). Dynamic collections auto-populate based on dynamic_filters; classic collections are manually curated.
288
+
289
+ ### Example
290
+
291
+ ```ts
292
+ import {
293
+ Configuration,
294
+ AssetManagementApi,
295
+ } from '@cloudinary/apps-api';
296
+ import type { CreateCollectionOperationRequest } from '@cloudinary/apps-api';
297
+
298
+ async function example() {
299
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
300
+ const config = new Configuration({
301
+ // Configure HTTP bearer authorization: bearerAuth
302
+ accessToken: "YOUR BEARER TOKEN",
303
+ });
304
+ const api = new AssetManagementApi(config);
305
+
306
+ const body = {
307
+ // CreateCollectionRequest (optional)
308
+ createCollectionRequest: ...,
309
+ } satisfies CreateCollectionOperationRequest;
310
+
311
+ try {
312
+ const data = await api.createCollection(body);
313
+ console.log(data);
314
+ } catch (error) {
315
+ console.error(error);
316
+ }
317
+ }
318
+
319
+ // Run the test
320
+ example().catch(console.error);
321
+ ```
322
+
323
+ ### Parameters
324
+
325
+
326
+ | Name | Type | Description | Notes |
327
+ |------------- | ------------- | ------------- | -------------|
328
+ | **createCollectionRequest** | [CreateCollectionRequest](CreateCollectionRequest.md) | | [Optional] |
329
+
330
+ ### Return type
331
+
332
+ [**CreateCollectionResponse**](CreateCollectionResponse.md)
333
+
334
+ ### Authorization
335
+
336
+ [bearerAuth](../README.md#bearerAuth)
337
+
338
+ ### HTTP request headers
339
+
340
+ - **Content-Type**: `application/json`
341
+ - **Accept**: `application/json`
342
+
343
+
344
+ ### HTTP response details
345
+ | Status code | Description | Response headers |
346
+ |-------------|-------------|------------------|
347
+ | **200** | Successful operation | - |
348
+ | **403** | Forbidden | - |
349
+
350
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
351
+
352
+
353
+ ## createFolder
354
+
355
+ > CreateFolderResponse createFolder(createFolderRequest)
356
+
357
+ Create a folder
358
+
359
+ Creates a new subfolder under the specified parent_id, or under the root folder when parent_id is omitted.
360
+
361
+ ### Example
362
+
363
+ ```ts
364
+ import {
365
+ Configuration,
366
+ AssetManagementApi,
367
+ } from '@cloudinary/apps-api';
368
+ import type { CreateFolderOperationRequest } from '@cloudinary/apps-api';
369
+
370
+ async function example() {
371
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
372
+ const config = new Configuration({
373
+ // Configure HTTP bearer authorization: bearerAuth
374
+ accessToken: "YOUR BEARER TOKEN",
375
+ });
376
+ const api = new AssetManagementApi(config);
377
+
378
+ const body = {
379
+ // CreateFolderRequest (optional)
380
+ createFolderRequest: ...,
381
+ } satisfies CreateFolderOperationRequest;
382
+
383
+ try {
384
+ const data = await api.createFolder(body);
385
+ console.log(data);
386
+ } catch (error) {
387
+ console.error(error);
388
+ }
389
+ }
390
+
391
+ // Run the test
392
+ example().catch(console.error);
393
+ ```
394
+
395
+ ### Parameters
396
+
397
+
398
+ | Name | Type | Description | Notes |
399
+ |------------- | ------------- | ------------- | -------------|
400
+ | **createFolderRequest** | [CreateFolderRequest](CreateFolderRequest.md) | | [Optional] |
401
+
402
+ ### Return type
403
+
404
+ [**CreateFolderResponse**](CreateFolderResponse.md)
405
+
406
+ ### Authorization
407
+
408
+ [bearerAuth](../README.md#bearerAuth)
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: `application/json`
413
+ - **Accept**: `application/json`
414
+
415
+
416
+ ### HTTP response details
417
+ | Status code | Description | Response headers |
418
+ |-------------|-------------|------------------|
419
+ | **200** | Successful operation | - |
420
+
421
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
422
+
423
+
424
+ ## deleteFolder
425
+
426
+ > DeleteFolderResponse deleteFolder(id, deleteResources)
427
+
428
+ Delete a folder
429
+
430
+ Deletes a folder by its external ID. The upstream Console API rejects deletion when the folder still contains assets.
431
+
432
+ ### Example
433
+
434
+ ```ts
435
+ import {
436
+ Configuration,
437
+ AssetManagementApi,
438
+ } from '@cloudinary/apps-api';
439
+ import type { DeleteFolderRequest } from '@cloudinary/apps-api';
440
+
441
+ async function example() {
442
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
443
+ const config = new Configuration({
444
+ // Configure HTTP bearer authorization: bearerAuth
445
+ accessToken: "YOUR BEARER TOKEN",
446
+ });
447
+ const api = new AssetManagementApi(config);
448
+
449
+ const body = {
450
+ // string
451
+ id: id_example,
452
+ // boolean (optional)
453
+ deleteResources: true,
454
+ } satisfies DeleteFolderRequest;
455
+
456
+ try {
457
+ const data = await api.deleteFolder(body);
458
+ console.log(data);
459
+ } catch (error) {
460
+ console.error(error);
461
+ }
462
+ }
463
+
464
+ // Run the test
465
+ example().catch(console.error);
466
+ ```
467
+
468
+ ### Parameters
469
+
470
+
471
+ | Name | Type | Description | Notes |
472
+ |------------- | ------------- | ------------- | -------------|
473
+ | **id** | `string` | | [Defaults to `undefined`] |
474
+ | **deleteResources** | `boolean` | | [Optional] [Defaults to `undefined`] |
475
+
476
+ ### Return type
477
+
478
+ [**DeleteFolderResponse**](DeleteFolderResponse.md)
479
+
480
+ ### Authorization
481
+
482
+ [bearerAuth](../README.md#bearerAuth)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: Not defined
487
+ - **Accept**: `application/json`
488
+
489
+
490
+ ### HTTP response details
491
+ | Status code | Description | Response headers |
492
+ |-------------|-------------|------------------|
493
+ | **200** | Successful operation | - |
494
+
495
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
496
+
497
+
498
+ ## destroyCollection
499
+
500
+ > Collection destroyCollection(collectionId)
501
+
502
+ Delete a collection
503
+
504
+ Soft-deletes a collection. The collection\'s assets are not removed from the cloud. Caller must have write access.
505
+
506
+ ### Example
507
+
508
+ ```ts
509
+ import {
510
+ Configuration,
511
+ AssetManagementApi,
512
+ } from '@cloudinary/apps-api';
513
+ import type { DestroyCollectionRequest } from '@cloudinary/apps-api';
514
+
515
+ async function example() {
516
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
517
+ const config = new Configuration({
518
+ // Configure HTTP bearer authorization: bearerAuth
519
+ accessToken: "YOUR BEARER TOKEN",
520
+ });
521
+ const api = new AssetManagementApi(config);
522
+
523
+ const body = {
524
+ // string | Collection external ID
525
+ collectionId: collectionId_example,
526
+ } satisfies DestroyCollectionRequest;
527
+
528
+ try {
529
+ const data = await api.destroyCollection(body);
530
+ console.log(data);
531
+ } catch (error) {
532
+ console.error(error);
533
+ }
534
+ }
535
+
536
+ // Run the test
537
+ example().catch(console.error);
538
+ ```
539
+
540
+ ### Parameters
541
+
542
+
543
+ | Name | Type | Description | Notes |
544
+ |------------- | ------------- | ------------- | -------------|
545
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
546
+
547
+ ### Return type
548
+
549
+ [**Collection**](Collection.md)
550
+
551
+ ### Authorization
552
+
553
+ [bearerAuth](../README.md#bearerAuth)
554
+
555
+ ### HTTP request headers
556
+
557
+ - **Content-Type**: Not defined
558
+ - **Accept**: `application/json`
559
+
560
+
561
+ ### HTTP response details
562
+ | Status code | Description | Response headers |
563
+ |-------------|-------------|------------------|
564
+ | **200** | Successful operation | - |
565
+ | **403** | Forbidden | - |
566
+
567
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
568
+
569
+
570
+ ## downloadAsset
571
+
572
+ > DownloadAssetResponse downloadAsset(downloadAssetRequest)
573
+
574
+ Generate a download URL for an asset
575
+
576
+ Returns a time-limited redirect URL for downloading an asset. Accepts external_id directly, or resolves public_id to external_id via search. Optionally applies a transformation before download.
577
+
578
+ ### Example
579
+
580
+ ```ts
581
+ import {
582
+ Configuration,
583
+ AssetManagementApi,
584
+ } from '@cloudinary/apps-api';
585
+ import type { DownloadAssetOperationRequest } from '@cloudinary/apps-api';
586
+
587
+ async function example() {
588
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
589
+ const config = new Configuration({
590
+ // Configure HTTP bearer authorization: bearerAuth
591
+ accessToken: "YOUR BEARER TOKEN",
592
+ });
593
+ const api = new AssetManagementApi(config);
594
+
595
+ const body = {
596
+ // DownloadAssetRequest (optional)
597
+ downloadAssetRequest: ...,
598
+ } satisfies DownloadAssetOperationRequest;
599
+
600
+ try {
601
+ const data = await api.downloadAsset(body);
602
+ console.log(data);
603
+ } catch (error) {
604
+ console.error(error);
605
+ }
606
+ }
607
+
608
+ // Run the test
609
+ example().catch(console.error);
610
+ ```
611
+
612
+ ### Parameters
613
+
614
+
615
+ | Name | Type | Description | Notes |
616
+ |------------- | ------------- | ------------- | -------------|
617
+ | **downloadAssetRequest** | [DownloadAssetRequest](DownloadAssetRequest.md) | | [Optional] |
618
+
619
+ ### Return type
620
+
621
+ [**DownloadAssetResponse**](DownloadAssetResponse.md)
622
+
623
+ ### Authorization
624
+
625
+ [bearerAuth](../README.md#bearerAuth)
626
+
627
+ ### HTTP request headers
628
+
629
+ - **Content-Type**: `application/json`
630
+ - **Accept**: `application/json`
631
+
632
+
633
+ ### HTTP response details
634
+ | Status code | Description | Response headers |
635
+ |-------------|-------------|------------------|
636
+ | **200** | Successful download response with URL | - |
637
+
638
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
639
+
640
+
641
+ ## downloadCollection
642
+
643
+ > DownloadCollectionResponse downloadCollection(collectionId, targetPublicId, redirect)
644
+
645
+ Download a collection as an archive
646
+
647
+ Generates a ZIP archive containing all assets in the collection. Returns an archive URL or redirects to it depending on the redirect parameter.
648
+
649
+ ### Example
650
+
651
+ ```ts
652
+ import {
653
+ Configuration,
654
+ AssetManagementApi,
655
+ } from '@cloudinary/apps-api';
656
+ import type { DownloadCollectionRequest } from '@cloudinary/apps-api';
657
+
658
+ async function example() {
659
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
660
+ const config = new Configuration({
661
+ // Configure HTTP bearer authorization: bearerAuth
662
+ accessToken: "YOUR BEARER TOKEN",
663
+ });
664
+ const api = new AssetManagementApi(config);
665
+
666
+ const body = {
667
+ // string | Collection external ID
668
+ collectionId: collectionId_example,
669
+ // string | Target public ID for the archive (optional)
670
+ targetPublicId: targetPublicId_example,
671
+ // boolean | Whether to redirect to the archive URL (optional)
672
+ redirect: true,
673
+ } satisfies DownloadCollectionRequest;
674
+
675
+ try {
676
+ const data = await api.downloadCollection(body);
677
+ console.log(data);
678
+ } catch (error) {
679
+ console.error(error);
680
+ }
681
+ }
682
+
683
+ // Run the test
684
+ example().catch(console.error);
685
+ ```
686
+
687
+ ### Parameters
688
+
689
+
690
+ | Name | Type | Description | Notes |
691
+ |------------- | ------------- | ------------- | -------------|
692
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
693
+ | **targetPublicId** | `string` | Target public ID for the archive | [Optional] [Defaults to `undefined`] |
694
+ | **redirect** | `boolean` | Whether to redirect to the archive URL | [Optional] [Defaults to `undefined`] |
695
+
696
+ ### Return type
697
+
698
+ [**DownloadCollectionResponse**](DownloadCollectionResponse.md)
699
+
700
+ ### Authorization
701
+
702
+ [bearerAuth](../README.md#bearerAuth)
703
+
704
+ ### HTTP request headers
705
+
706
+ - **Content-Type**: Not defined
707
+ - **Accept**: `application/json`
708
+
709
+
710
+ ### HTTP response details
711
+ | Status code | Description | Response headers |
712
+ |-------------|-------------|------------------|
713
+ | **200** | Successful operation | - |
714
+ | **403** | Forbidden | - |
715
+
716
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
717
+
718
+
719
+ ## listAssetBackreferences
720
+
721
+ > ListBackreferencesResponse listAssetBackreferences(assetId, system, tenant, includeRemoved)
722
+
723
+ List backreferences for an asset
724
+
725
+ Returns active backreference entries recorded on an asset. Optionally filter by system and/or tenant. Pass includeRemoved=true to include removed links. Context search matches ever-associated ref URIs; list reflects current link state.
726
+
727
+ ### Example
728
+
729
+ ```ts
730
+ import {
731
+ Configuration,
732
+ AssetManagementApi,
733
+ } from '@cloudinary/apps-api';
734
+ import type { ListAssetBackreferencesRequest } from '@cloudinary/apps-api';
735
+
736
+ async function example() {
737
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
738
+ const config = new Configuration({
739
+ // Configure HTTP bearer authorization: bearerAuth
740
+ accessToken: "YOUR BEARER TOKEN",
741
+ });
742
+ const api = new AssetManagementApi(config);
743
+
744
+ const body = {
745
+ // string | Cloudinary asset id
746
+ assetId: assetId_example,
747
+ // string | Filter by system name (e.g., \'monday\') (optional)
748
+ system: system_example,
749
+ // string | Filter by tenant/workspace ID (requires system) (optional)
750
+ tenant: tenant_example,
751
+ // boolean | Include backreferences whose current action is remove (optional)
752
+ includeRemoved: true,
753
+ } satisfies ListAssetBackreferencesRequest;
754
+
755
+ try {
756
+ const data = await api.listAssetBackreferences(body);
757
+ console.log(data);
758
+ } catch (error) {
759
+ console.error(error);
760
+ }
761
+ }
762
+
763
+ // Run the test
764
+ example().catch(console.error);
765
+ ```
766
+
767
+ ### Parameters
768
+
769
+
770
+ | Name | Type | Description | Notes |
771
+ |------------- | ------------- | ------------- | -------------|
772
+ | **assetId** | `string` | Cloudinary asset id | [Defaults to `undefined`] |
773
+ | **system** | `string` | Filter by system name (e.g., \'monday\') | [Optional] [Defaults to `undefined`] |
774
+ | **tenant** | `string` | Filter by tenant/workspace ID (requires system) | [Optional] [Defaults to `undefined`] |
775
+ | **includeRemoved** | `boolean` | Include backreferences whose current action is remove | [Optional] [Defaults to `undefined`] |
776
+
777
+ ### Return type
778
+
779
+ [**ListBackreferencesResponse**](ListBackreferencesResponse.md)
780
+
781
+ ### Authorization
782
+
783
+ [bearerAuth](../README.md#bearerAuth)
784
+
785
+ ### HTTP request headers
786
+
787
+ - **Content-Type**: Not defined
788
+ - **Accept**: `application/json`
789
+
790
+
791
+ ### HTTP response details
792
+ | Status code | Description | Response headers |
793
+ |-------------|-------------|------------------|
794
+ | **200** | Successful operation | - |
795
+ | **404** | Asset not found | - |
796
+
797
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
798
+
799
+
800
+ ## listAssetContextFields
801
+
802
+ > ListContextualMetadataFieldsResponse listAssetContextFields(maxResults, nextCursor, prefix)
803
+
804
+ List contextual metadata fields
805
+
806
+ Returns contextual metadata keys in use across assets in the cloud. Unlike structured metadata fields, contextual fields are simple key-value pairs without type definitions.
807
+
808
+ ### Example
809
+
810
+ ```ts
811
+ import {
812
+ Configuration,
813
+ AssetManagementApi,
814
+ } from '@cloudinary/apps-api';
815
+ import type { ListAssetContextFieldsRequest } from '@cloudinary/apps-api';
816
+
817
+ async function example() {
818
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
819
+ const config = new Configuration({
820
+ // Configure HTTP bearer authorization: bearerAuth
821
+ accessToken: "YOUR BEARER TOKEN",
822
+ });
823
+ const api = new AssetManagementApi(config);
824
+
825
+ const body = {
826
+ // number (optional)
827
+ maxResults: 56,
828
+ // string (optional)
829
+ nextCursor: nextCursor_example,
830
+ // string (optional)
831
+ prefix: prefix_example,
832
+ } satisfies ListAssetContextFieldsRequest;
833
+
834
+ try {
835
+ const data = await api.listAssetContextFields(body);
836
+ console.log(data);
837
+ } catch (error) {
838
+ console.error(error);
839
+ }
840
+ }
841
+
842
+ // Run the test
843
+ example().catch(console.error);
844
+ ```
845
+
846
+ ### Parameters
847
+
848
+
849
+ | Name | Type | Description | Notes |
850
+ |------------- | ------------- | ------------- | -------------|
851
+ | **maxResults** | `number` | | [Optional] [Defaults to `50`] |
852
+ | **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
853
+ | **prefix** | `string` | | [Optional] [Defaults to `undefined`] |
854
+
855
+ ### Return type
856
+
857
+ [**ListContextualMetadataFieldsResponse**](ListContextualMetadataFieldsResponse.md)
858
+
859
+ ### Authorization
860
+
861
+ [bearerAuth](../README.md#bearerAuth)
862
+
863
+ ### HTTP request headers
864
+
865
+ - **Content-Type**: Not defined
866
+ - **Accept**: `application/json`
867
+
868
+
869
+ ### HTTP response details
870
+ | Status code | Description | Response headers |
871
+ |-------------|-------------|------------------|
872
+ | **200** | Successful operation | - |
873
+
874
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
875
+
876
+
877
+ ## listAssetHistory
878
+
879
+ > AssetHistoryResponse listAssetHistory(externalId, maxResults, nextCursor)
880
+
881
+ List asset audit history
882
+
883
+ Returns paginated audit history for an asset identified by external_id, including metadata updates, downloads, version changes, and deletions.
884
+
885
+ ### Example
886
+
887
+ ```ts
888
+ import {
889
+ Configuration,
890
+ AssetManagementApi,
891
+ } from '@cloudinary/apps-api';
892
+ import type { ListAssetHistoryRequest } from '@cloudinary/apps-api';
893
+
894
+ async function example() {
895
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
896
+ const config = new Configuration({
897
+ // Configure HTTP bearer authorization: bearerAuth
898
+ accessToken: "YOUR BEARER TOKEN",
899
+ });
900
+ const api = new AssetManagementApi(config);
901
+
902
+ const body = {
903
+ // string | Asset external ID
904
+ externalId: externalId_example,
905
+ // number | Maximum number of history entries to return (optional)
906
+ maxResults: 8.14,
907
+ // number | Pagination cursor (optional)
908
+ nextCursor: 8.14,
909
+ } satisfies ListAssetHistoryRequest;
910
+
911
+ try {
912
+ const data = await api.listAssetHistory(body);
913
+ console.log(data);
914
+ } catch (error) {
915
+ console.error(error);
916
+ }
917
+ }
918
+
919
+ // Run the test
920
+ example().catch(console.error);
921
+ ```
922
+
923
+ ### Parameters
924
+
925
+
926
+ | Name | Type | Description | Notes |
927
+ |------------- | ------------- | ------------- | -------------|
928
+ | **externalId** | `string` | Asset external ID | [Defaults to `undefined`] |
929
+ | **maxResults** | `number` | Maximum number of history entries to return | [Optional] [Defaults to `undefined`] |
930
+ | **nextCursor** | `number` | Pagination cursor | [Optional] [Defaults to `undefined`] |
931
+
932
+ ### Return type
933
+
934
+ [**AssetHistoryResponse**](AssetHistoryResponse.md)
935
+
936
+ ### Authorization
937
+
938
+ [bearerAuth](../README.md#bearerAuth)
939
+
940
+ ### HTTP request headers
941
+
942
+ - **Content-Type**: Not defined
943
+ - **Accept**: `application/json`
944
+
945
+
946
+ ### HTTP response details
947
+ | Status code | Description | Response headers |
948
+ |-------------|-------------|------------------|
949
+ | **200** | Successful operation | - |
950
+
951
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
952
+
953
+
954
+ ## listAssetMetadataFields
955
+
956
+ > ListMetadataFieldsResponse listAssetMetadataFields()
957
+
958
+ List structured metadata field definitions
959
+
960
+ Returns all structured metadata field definitions configured for the cloud, including field type, label, validation rules, and datasource.
961
+
962
+ ### Example
963
+
964
+ ```ts
965
+ import {
966
+ Configuration,
967
+ AssetManagementApi,
968
+ } from '@cloudinary/apps-api';
969
+ import type { ListAssetMetadataFieldsRequest } from '@cloudinary/apps-api';
970
+
971
+ async function example() {
972
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
973
+ const config = new Configuration({
974
+ // Configure HTTP bearer authorization: bearerAuth
975
+ accessToken: "YOUR BEARER TOKEN",
976
+ });
977
+ const api = new AssetManagementApi(config);
978
+
979
+ try {
980
+ const data = await api.listAssetMetadataFields();
981
+ console.log(data);
982
+ } catch (error) {
983
+ console.error(error);
984
+ }
985
+ }
986
+
987
+ // Run the test
988
+ example().catch(console.error);
989
+ ```
990
+
991
+ ### Parameters
992
+
993
+ This endpoint does not need any parameter.
994
+
995
+ ### Return type
996
+
997
+ [**ListMetadataFieldsResponse**](ListMetadataFieldsResponse.md)
998
+
999
+ ### Authorization
1000
+
1001
+ [bearerAuth](../README.md#bearerAuth)
1002
+
1003
+ ### HTTP request headers
1004
+
1005
+ - **Content-Type**: Not defined
1006
+ - **Accept**: `application/json`
1007
+
1008
+
1009
+ ### HTTP response details
1010
+ | Status code | Description | Response headers |
1011
+ |-------------|-------------|------------------|
1012
+ | **200** | Successful operation | - |
1013
+
1014
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1015
+
1016
+
1017
+ ## listAssetsByFolder
1018
+
1019
+ > ListAssetsByFolderResponse listAssetsByFolder(folderId, resourceType, sortBy, maxResults, nextCursor)
1020
+
1021
+ List assets in a folder
1022
+
1023
+ Returns assets within a folder identified by folder_id, with optional resource_type filter, sorting, and cursor-based pagination.
1024
+
1025
+ ### Example
1026
+
1027
+ ```ts
1028
+ import {
1029
+ Configuration,
1030
+ AssetManagementApi,
1031
+ } from '@cloudinary/apps-api';
1032
+ import type { ListAssetsByFolderRequest } from '@cloudinary/apps-api';
1033
+
1034
+ async function example() {
1035
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1036
+ const config = new Configuration({
1037
+ // Configure HTTP bearer authorization: bearerAuth
1038
+ accessToken: "YOUR BEARER TOKEN",
1039
+ });
1040
+ const api = new AssetManagementApi(config);
1041
+
1042
+ const body = {
1043
+ // string (optional)
1044
+ folderId: folderId_example,
1045
+ // 'image' | 'javascript' | 'css' | 'video' | 'raw' | 'any' (optional)
1046
+ resourceType: resourceType_example,
1047
+ // string (optional)
1048
+ sortBy: sortBy_example,
1049
+ // number (optional)
1050
+ maxResults: 56,
1051
+ // string (optional)
1052
+ nextCursor: nextCursor_example,
1053
+ } satisfies ListAssetsByFolderRequest;
1054
+
1055
+ try {
1056
+ const data = await api.listAssetsByFolder(body);
1057
+ console.log(data);
1058
+ } catch (error) {
1059
+ console.error(error);
1060
+ }
1061
+ }
1062
+
1063
+ // Run the test
1064
+ example().catch(console.error);
1065
+ ```
1066
+
1067
+ ### Parameters
1068
+
1069
+
1070
+ | Name | Type | Description | Notes |
1071
+ |------------- | ------------- | ------------- | -------------|
1072
+ | **folderId** | `string` | | [Optional] [Defaults to `undefined`] |
1073
+ | **resourceType** | `image`, `javascript`, `css`, `video`, `raw`, `any` | | [Optional] [Defaults to `undefined`] [Enum: image, javascript, css, video, raw, any] |
1074
+ | **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
1075
+ | **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
1076
+ | **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
1077
+
1078
+ ### Return type
1079
+
1080
+ [**ListAssetsByFolderResponse**](ListAssetsByFolderResponse.md)
1081
+
1082
+ ### Authorization
1083
+
1084
+ [bearerAuth](../README.md#bearerAuth)
1085
+
1086
+ ### HTTP request headers
1087
+
1088
+ - **Content-Type**: Not defined
1089
+ - **Accept**: `application/json`
1090
+
1091
+
1092
+ ### HTTP response details
1093
+ | Status code | Description | Response headers |
1094
+ |-------------|-------------|------------------|
1095
+ | **200** | Successful operation | - |
1096
+
1097
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1098
+
1099
+
1100
+ ## listCollections
1101
+
1102
+ > ListCollectionsResponse listCollections(sortBy, maxResults, nextCursor, term, ownerType)
1103
+
1104
+ List collections
1105
+
1106
+ Returns all collections accessible to the caller, with optional term filter, owner_type filter, sorting, and cursor-based pagination.
1107
+
1108
+ ### Example
1109
+
1110
+ ```ts
1111
+ import {
1112
+ Configuration,
1113
+ AssetManagementApi,
1114
+ } from '@cloudinary/apps-api';
1115
+ import type { ListCollectionsRequest } from '@cloudinary/apps-api';
1116
+
1117
+ async function example() {
1118
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1119
+ const config = new Configuration({
1120
+ // Configure HTTP bearer authorization: bearerAuth
1121
+ accessToken: "YOUR BEARER TOKEN",
1122
+ });
1123
+ const api = new AssetManagementApi(config);
1124
+
1125
+ const body = {
1126
+ // string | Sort field (optional)
1127
+ sortBy: sortBy_example,
1128
+ // number | Maximum number of results (optional)
1129
+ maxResults: 8.14,
1130
+ // string | Pagination cursor (optional)
1131
+ nextCursor: nextCursor_example,
1132
+ // string | Search term (optional)
1133
+ term: term_example,
1134
+ // string | Filter by owner type (optional)
1135
+ ownerType: ownerType_example,
1136
+ } satisfies ListCollectionsRequest;
1137
+
1138
+ try {
1139
+ const data = await api.listCollections(body);
1140
+ console.log(data);
1141
+ } catch (error) {
1142
+ console.error(error);
1143
+ }
1144
+ }
1145
+
1146
+ // Run the test
1147
+ example().catch(console.error);
1148
+ ```
1149
+
1150
+ ### Parameters
1151
+
1152
+
1153
+ | Name | Type | Description | Notes |
1154
+ |------------- | ------------- | ------------- | -------------|
1155
+ | **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
1156
+ | **maxResults** | `number` | Maximum number of results | [Optional] [Defaults to `undefined`] |
1157
+ | **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
1158
+ | **term** | `string` | Search term | [Optional] [Defaults to `undefined`] |
1159
+ | **ownerType** | `string` | Filter by owner type | [Optional] [Defaults to `undefined`] |
1160
+
1161
+ ### Return type
1162
+
1163
+ [**ListCollectionsResponse**](ListCollectionsResponse.md)
1164
+
1165
+ ### Authorization
1166
+
1167
+ [bearerAuth](../README.md#bearerAuth)
1168
+
1169
+ ### HTTP request headers
1170
+
1171
+ - **Content-Type**: Not defined
1172
+ - **Accept**: `application/json`
1173
+
1174
+
1175
+ ### HTTP response details
1176
+ | Status code | Description | Response headers |
1177
+ |-------------|-------------|------------------|
1178
+ | **200** | Successful operation | - |
1179
+ | **403** | Forbidden | - |
1180
+
1181
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1182
+
1183
+
1184
+ ## listSubfolders
1185
+
1186
+ > ListSubfoldersResponse listSubfolders(parentPath, externalId, maxResults, nextCursor)
1187
+
1188
+ List child folders
1189
+
1190
+ Returns immediate subfolders of a given parent path or folder external ID, with pagination support.
1191
+
1192
+ ### Example
1193
+
1194
+ ```ts
1195
+ import {
1196
+ Configuration,
1197
+ AssetManagementApi,
1198
+ } from '@cloudinary/apps-api';
1199
+ import type { ListSubfoldersRequest } from '@cloudinary/apps-api';
1200
+
1201
+ async function example() {
1202
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1203
+ const config = new Configuration({
1204
+ // Configure HTTP bearer authorization: bearerAuth
1205
+ accessToken: "YOUR BEARER TOKEN",
1206
+ });
1207
+ const api = new AssetManagementApi(config);
1208
+
1209
+ const body = {
1210
+ // string (optional)
1211
+ parentPath: parentPath_example,
1212
+ // string (optional)
1213
+ externalId: externalId_example,
1214
+ // number (optional)
1215
+ maxResults: 56,
1216
+ // string (optional)
1217
+ nextCursor: nextCursor_example,
1218
+ } satisfies ListSubfoldersRequest;
1219
+
1220
+ try {
1221
+ const data = await api.listSubfolders(body);
1222
+ console.log(data);
1223
+ } catch (error) {
1224
+ console.error(error);
1225
+ }
1226
+ }
1227
+
1228
+ // Run the test
1229
+ example().catch(console.error);
1230
+ ```
1231
+
1232
+ ### Parameters
1233
+
1234
+
1235
+ | Name | Type | Description | Notes |
1236
+ |------------- | ------------- | ------------- | -------------|
1237
+ | **parentPath** | `string` | | [Optional] [Defaults to `undefined`] |
1238
+ | **externalId** | `string` | | [Optional] [Defaults to `undefined`] |
1239
+ | **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
1240
+ | **nextCursor** | `string` | | [Optional] [Defaults to `''`] |
1241
+
1242
+ ### Return type
1243
+
1244
+ [**ListSubfoldersResponse**](ListSubfoldersResponse.md)
1245
+
1246
+ ### Authorization
1247
+
1248
+ [bearerAuth](../README.md#bearerAuth)
1249
+
1250
+ ### HTTP request headers
1251
+
1252
+ - **Content-Type**: Not defined
1253
+ - **Accept**: `application/json`
1254
+
1255
+
1256
+ ### HTTP response details
1257
+ | Status code | Description | Response headers |
1258
+ |-------------|-------------|------------------|
1259
+ | **200** | Successful operation | - |
1260
+
1261
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1262
+
1263
+
1264
+ ## listTransformations
1265
+
1266
+ > ListTransformationsResponse listTransformations(maxResults, nextCursor, name)
1267
+
1268
+ List named transformations
1269
+
1270
+ Returns named transformations defined in the cloud. Supports pagination via next_cursor and optional client-side name filtering.
1271
+
1272
+ ### Example
1273
+
1274
+ ```ts
1275
+ import {
1276
+ Configuration,
1277
+ AssetManagementApi,
1278
+ } from '@cloudinary/apps-api';
1279
+ import type { ListTransformationsRequest } from '@cloudinary/apps-api';
1280
+
1281
+ async function example() {
1282
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1283
+ const config = new Configuration({
1284
+ // Configure HTTP bearer authorization: bearerAuth
1285
+ accessToken: "YOUR BEARER TOKEN",
1286
+ });
1287
+ const api = new AssetManagementApi(config);
1288
+
1289
+ const body = {
1290
+ // number (optional)
1291
+ maxResults: 56,
1292
+ // string (optional)
1293
+ nextCursor: nextCursor_example,
1294
+ // string (optional)
1295
+ name: name_example,
1296
+ } satisfies ListTransformationsRequest;
1297
+
1298
+ try {
1299
+ const data = await api.listTransformations(body);
1300
+ console.log(data);
1301
+ } catch (error) {
1302
+ console.error(error);
1303
+ }
1304
+ }
1305
+
1306
+ // Run the test
1307
+ example().catch(console.error);
1308
+ ```
1309
+
1310
+ ### Parameters
1311
+
1312
+
1313
+ | Name | Type | Description | Notes |
1314
+ |------------- | ------------- | ------------- | -------------|
1315
+ | **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
1316
+ | **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
1317
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
1318
+
1319
+ ### Return type
1320
+
1321
+ [**ListTransformationsResponse**](ListTransformationsResponse.md)
1322
+
1323
+ ### Authorization
1324
+
1325
+ [bearerAuth](../README.md#bearerAuth)
1326
+
1327
+ ### HTTP request headers
1328
+
1329
+ - **Content-Type**: Not defined
1330
+ - **Accept**: `application/json`
1331
+
1332
+
1333
+ ### HTTP response details
1334
+ | Status code | Description | Response headers |
1335
+ |-------------|-------------|------------------|
1336
+ | **200** | Successful operation | - |
1337
+
1338
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1339
+
1340
+
1341
+ ## removeCollectionAssets
1342
+
1343
+ > RemoveCollectionAssetsResponse removeCollectionAssets(collectionId, removeCollectionAssetsRequest)
1344
+
1345
+ Remove assets from a collection
1346
+
1347
+ Removes one or more assets from a collection by resource_ids or external_ids. The assets themselves are not deleted.
1348
+
1349
+ ### Example
1350
+
1351
+ ```ts
1352
+ import {
1353
+ Configuration,
1354
+ AssetManagementApi,
1355
+ } from '@cloudinary/apps-api';
1356
+ import type { RemoveCollectionAssetsOperationRequest } from '@cloudinary/apps-api';
1357
+
1358
+ async function example() {
1359
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1360
+ const config = new Configuration({
1361
+ // Configure HTTP bearer authorization: bearerAuth
1362
+ accessToken: "YOUR BEARER TOKEN",
1363
+ });
1364
+ const api = new AssetManagementApi(config);
1365
+
1366
+ const body = {
1367
+ // string | Collection external ID
1368
+ collectionId: collectionId_example,
1369
+ // RemoveCollectionAssetsRequest (optional)
1370
+ removeCollectionAssetsRequest: ...,
1371
+ } satisfies RemoveCollectionAssetsOperationRequest;
1372
+
1373
+ try {
1374
+ const data = await api.removeCollectionAssets(body);
1375
+ console.log(data);
1376
+ } catch (error) {
1377
+ console.error(error);
1378
+ }
1379
+ }
1380
+
1381
+ // Run the test
1382
+ example().catch(console.error);
1383
+ ```
1384
+
1385
+ ### Parameters
1386
+
1387
+
1388
+ | Name | Type | Description | Notes |
1389
+ |------------- | ------------- | ------------- | -------------|
1390
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
1391
+ | **removeCollectionAssetsRequest** | [RemoveCollectionAssetsRequest](RemoveCollectionAssetsRequest.md) | | [Optional] |
1392
+
1393
+ ### Return type
1394
+
1395
+ [**RemoveCollectionAssetsResponse**](RemoveCollectionAssetsResponse.md)
1396
+
1397
+ ### Authorization
1398
+
1399
+ [bearerAuth](../README.md#bearerAuth)
1400
+
1401
+ ### HTTP request headers
1402
+
1403
+ - **Content-Type**: `application/json`
1404
+ - **Accept**: `application/json`
1405
+
1406
+
1407
+ ### HTTP response details
1408
+ | Status code | Description | Response headers |
1409
+ |-------------|-------------|------------------|
1410
+ | **200** | Successful operation | - |
1411
+ | **403** | Forbidden | - |
1412
+
1413
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1414
+
1415
+
1416
+ ## searchAssets
1417
+
1418
+ > AssetSearchResponse searchAssets(expression, maxResults, nextCursor, sortBy, backend, aggregate)
1419
+
1420
+ Search assets using Cloudinary expression language
1421
+
1422
+ Full-text and field-scoped search over all assets in the cloud. Supports pagination via next_cursor, sort ordering, backend selection (relational, elastic, CLIP), and field aggregations.
1423
+
1424
+ ### Example
1425
+
1426
+ ```ts
1427
+ import {
1428
+ Configuration,
1429
+ AssetManagementApi,
1430
+ } from '@cloudinary/apps-api';
1431
+ import type { SearchAssetsRequest } from '@cloudinary/apps-api';
1432
+
1433
+ async function example() {
1434
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1435
+ const config = new Configuration({
1436
+ // Configure HTTP bearer authorization: bearerAuth
1437
+ accessToken: "YOUR BEARER TOKEN",
1438
+ });
1439
+ const api = new AssetManagementApi(config);
1440
+
1441
+ const body = {
1442
+ // string
1443
+ expression: expression_example,
1444
+ // number (optional)
1445
+ maxResults: 56,
1446
+ // string (optional)
1447
+ nextCursor: nextCursor_example,
1448
+ // string (optional)
1449
+ sortBy: sortBy_example,
1450
+ // 'relational' | 'elastic' | 'clip' | 'clip_text' | 'clip_url' (optional)
1451
+ backend: backend_example,
1452
+ // string (optional)
1453
+ aggregate: aggregate_example,
1454
+ } satisfies SearchAssetsRequest;
1455
+
1456
+ try {
1457
+ const data = await api.searchAssets(body);
1458
+ console.log(data);
1459
+ } catch (error) {
1460
+ console.error(error);
1461
+ }
1462
+ }
1463
+
1464
+ // Run the test
1465
+ example().catch(console.error);
1466
+ ```
1467
+
1468
+ ### Parameters
1469
+
1470
+
1471
+ | Name | Type | Description | Notes |
1472
+ |------------- | ------------- | ------------- | -------------|
1473
+ | **expression** | `string` | | [Defaults to `undefined`] |
1474
+ | **maxResults** | `number` | | [Optional] [Defaults to `undefined`] |
1475
+ | **nextCursor** | `string` | | [Optional] [Defaults to `undefined`] |
1476
+ | **sortBy** | `string` | | [Optional] [Defaults to `undefined`] |
1477
+ | **backend** | `relational`, `elastic`, `clip`, `clip_text`, `clip_url` | | [Optional] [Defaults to `undefined`] [Enum: relational, elastic, clip, clip_text, clip_url] |
1478
+ | **aggregate** | `string` | | [Optional] [Defaults to `undefined`] |
1479
+
1480
+ ### Return type
1481
+
1482
+ [**AssetSearchResponse**](AssetSearchResponse.md)
1483
+
1484
+ ### Authorization
1485
+
1486
+ [bearerAuth](../README.md#bearerAuth)
1487
+
1488
+ ### HTTP request headers
1489
+
1490
+ - **Content-Type**: Not defined
1491
+ - **Accept**: `application/json`
1492
+
1493
+
1494
+ ### HTTP response details
1495
+ | Status code | Description | Response headers |
1496
+ |-------------|-------------|------------------|
1497
+ | **200** | Successful operation | - |
1498
+
1499
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1500
+
1501
+
1502
+ ## searchCollections
1503
+
1504
+ > SearchCollectionsResponse searchCollections(searchCollectionsRequest)
1505
+
1506
+ Search collections
1507
+
1508
+ Search collections by term with configurable sort order, pagination, and owner_type filtering. Query is sent in the request body.
1509
+
1510
+ ### Example
1511
+
1512
+ ```ts
1513
+ import {
1514
+ Configuration,
1515
+ AssetManagementApi,
1516
+ } from '@cloudinary/apps-api';
1517
+ import type { SearchCollectionsOperationRequest } from '@cloudinary/apps-api';
1518
+
1519
+ async function example() {
1520
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1521
+ const config = new Configuration({
1522
+ // Configure HTTP bearer authorization: bearerAuth
1523
+ accessToken: "YOUR BEARER TOKEN",
1524
+ });
1525
+ const api = new AssetManagementApi(config);
1526
+
1527
+ const body = {
1528
+ // SearchCollectionsRequest (optional)
1529
+ searchCollectionsRequest: ...,
1530
+ } satisfies SearchCollectionsOperationRequest;
1531
+
1532
+ try {
1533
+ const data = await api.searchCollections(body);
1534
+ console.log(data);
1535
+ } catch (error) {
1536
+ console.error(error);
1537
+ }
1538
+ }
1539
+
1540
+ // Run the test
1541
+ example().catch(console.error);
1542
+ ```
1543
+
1544
+ ### Parameters
1545
+
1546
+
1547
+ | Name | Type | Description | Notes |
1548
+ |------------- | ------------- | ------------- | -------------|
1549
+ | **searchCollectionsRequest** | [SearchCollectionsRequest](SearchCollectionsRequest.md) | | [Optional] |
1550
+
1551
+ ### Return type
1552
+
1553
+ [**SearchCollectionsResponse**](SearchCollectionsResponse.md)
1554
+
1555
+ ### Authorization
1556
+
1557
+ [bearerAuth](../README.md#bearerAuth)
1558
+
1559
+ ### HTTP request headers
1560
+
1561
+ - **Content-Type**: `application/json`
1562
+ - **Accept**: `application/json`
1563
+
1564
+
1565
+ ### HTTP response details
1566
+ | Status code | Description | Response headers |
1567
+ |-------------|-------------|------------------|
1568
+ | **200** | Successful operation | - |
1569
+ | **403** | Forbidden | - |
1570
+
1571
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1572
+
1573
+
1574
+ ## searchTemplates
1575
+
1576
+ > TemplateSearchResponse searchTemplates(publicId, folder, maxResults, nextCursor)
1577
+
1578
+ Search creative automation templates
1579
+
1580
+ List templates in your Cloudinary account. A template combines transformations, variables, and supporting assets (images, fonts, and related resources) into a single reusable creative unit. Templates are typically exported from design tools such as Figma or Photoshop, uploaded to Cloudinary, and consumed by downstream platforms like Braze and Klaviyo for creative automation workflows. Optionally filter by id, folder, or page through results.
1581
+
1582
+ ### Example
1583
+
1584
+ ```ts
1585
+ import {
1586
+ Configuration,
1587
+ AssetManagementApi,
1588
+ } from '@cloudinary/apps-api';
1589
+ import type { SearchTemplatesRequest } from '@cloudinary/apps-api';
1590
+
1591
+ async function example() {
1592
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1593
+ const config = new Configuration({
1594
+ // Configure HTTP bearer authorization: bearerAuth
1595
+ accessToken: "YOUR BEARER TOKEN",
1596
+ });
1597
+ const api = new AssetManagementApi(config);
1598
+
1599
+ const body = {
1600
+ // string | Limit results to a specific template id (optional)
1601
+ publicId: publicId_example,
1602
+ // string | Limit results to assets under this folder path (optional)
1603
+ folder: folder_example,
1604
+ // number | Maximum number of results per page (optional)
1605
+ maxResults: 56,
1606
+ // string | Cursor for the next page of results (optional)
1607
+ nextCursor: nextCursor_example,
1608
+ } satisfies SearchTemplatesRequest;
1609
+
1610
+ try {
1611
+ const data = await api.searchTemplates(body);
1612
+ console.log(data);
1613
+ } catch (error) {
1614
+ console.error(error);
1615
+ }
1616
+ }
1617
+
1618
+ // Run the test
1619
+ example().catch(console.error);
1620
+ ```
1621
+
1622
+ ### Parameters
1623
+
1624
+
1625
+ | Name | Type | Description | Notes |
1626
+ |------------- | ------------- | ------------- | -------------|
1627
+ | **publicId** | `string` | Limit results to a specific template id | [Optional] [Defaults to `undefined`] |
1628
+ | **folder** | `string` | Limit results to assets under this folder path | [Optional] [Defaults to `undefined`] |
1629
+ | **maxResults** | `number` | Maximum number of results per page | [Optional] [Defaults to `undefined`] |
1630
+ | **nextCursor** | `string` | Cursor for the next page of results | [Optional] [Defaults to `undefined`] |
1631
+
1632
+ ### Return type
1633
+
1634
+ [**TemplateSearchResponse**](TemplateSearchResponse.md)
1635
+
1636
+ ### Authorization
1637
+
1638
+ [bearerAuth](../README.md#bearerAuth)
1639
+
1640
+ ### HTTP request headers
1641
+
1642
+ - **Content-Type**: Not defined
1643
+ - **Accept**: `application/json`
1644
+
1645
+
1646
+ ### HTTP response details
1647
+ | Status code | Description | Response headers |
1648
+ |-------------|-------------|------------------|
1649
+ | **200** | Successful operation | - |
1650
+
1651
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1652
+
1653
+
1654
+ ## showCollection
1655
+
1656
+ > Collection showCollection(collectionId, sortBy, maxResults, nextCursor, withMetadata)
1657
+
1658
+ Get a single collection with its assets
1659
+
1660
+ Returns collection details and its contained assets. Supports asset pagination (max_results/next_cursor), sorting, and optional metadata inclusion.
1661
+
1662
+ ### Example
1663
+
1664
+ ```ts
1665
+ import {
1666
+ Configuration,
1667
+ AssetManagementApi,
1668
+ } from '@cloudinary/apps-api';
1669
+ import type { ShowCollectionRequest } from '@cloudinary/apps-api';
1670
+
1671
+ async function example() {
1672
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1673
+ const config = new Configuration({
1674
+ // Configure HTTP bearer authorization: bearerAuth
1675
+ accessToken: "YOUR BEARER TOKEN",
1676
+ });
1677
+ const api = new AssetManagementApi(config);
1678
+
1679
+ const body = {
1680
+ // string | Collection external ID
1681
+ collectionId: collectionId_example,
1682
+ // string | Sort field (optional)
1683
+ sortBy: sortBy_example,
1684
+ // number | Maximum number of assets to return (optional)
1685
+ maxResults: 8.14,
1686
+ // string | Pagination cursor (optional)
1687
+ nextCursor: nextCursor_example,
1688
+ // boolean | Include metadata (optional)
1689
+ withMetadata: true,
1690
+ } satisfies ShowCollectionRequest;
1691
+
1692
+ try {
1693
+ const data = await api.showCollection(body);
1694
+ console.log(data);
1695
+ } catch (error) {
1696
+ console.error(error);
1697
+ }
1698
+ }
1699
+
1700
+ // Run the test
1701
+ example().catch(console.error);
1702
+ ```
1703
+
1704
+ ### Parameters
1705
+
1706
+
1707
+ | Name | Type | Description | Notes |
1708
+ |------------- | ------------- | ------------- | -------------|
1709
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
1710
+ | **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
1711
+ | **maxResults** | `number` | Maximum number of assets to return | [Optional] [Defaults to `undefined`] |
1712
+ | **nextCursor** | `string` | Pagination cursor | [Optional] [Defaults to `undefined`] |
1713
+ | **withMetadata** | `boolean` | Include metadata | [Optional] [Defaults to `undefined`] |
1714
+
1715
+ ### Return type
1716
+
1717
+ [**Collection**](Collection.md)
1718
+
1719
+ ### Authorization
1720
+
1721
+ [bearerAuth](../README.md#bearerAuth)
1722
+
1723
+ ### HTTP request headers
1724
+
1725
+ - **Content-Type**: Not defined
1726
+ - **Accept**: `application/json`
1727
+
1728
+
1729
+ ### HTTP response details
1730
+ | Status code | Description | Response headers |
1731
+ |-------------|-------------|------------------|
1732
+ | **200** | Successful operation | - |
1733
+ | **403** | Forbidden | - |
1734
+
1735
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1736
+
1737
+
1738
+ ## updateAssetBackreferences
1739
+
1740
+ > UpdateBackreferencesResponse updateAssetBackreferences(updateAssetBackreferencesRequest)
1741
+
1742
+ Create, update, or remove asset backreferences
1743
+
1744
+ Links or unlinks one or more assets to/from a location in an external system (e.g. a CMS page or design file). Each backreference is stored as versioned history in the asset\'s cld_backreference context.
1745
+
1746
+ ### Example
1747
+
1748
+ ```ts
1749
+ import {
1750
+ Configuration,
1751
+ AssetManagementApi,
1752
+ } from '@cloudinary/apps-api';
1753
+ import type { UpdateAssetBackreferencesOperationRequest } from '@cloudinary/apps-api';
1754
+
1755
+ async function example() {
1756
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1757
+ const config = new Configuration({
1758
+ // Configure HTTP bearer authorization: bearerAuth
1759
+ accessToken: "YOUR BEARER TOKEN",
1760
+ });
1761
+ const api = new AssetManagementApi(config);
1762
+
1763
+ const body = {
1764
+ // UpdateAssetBackreferencesRequest (optional)
1765
+ updateAssetBackreferencesRequest: ...,
1766
+ } satisfies UpdateAssetBackreferencesOperationRequest;
1767
+
1768
+ try {
1769
+ const data = await api.updateAssetBackreferences(body);
1770
+ console.log(data);
1771
+ } catch (error) {
1772
+ console.error(error);
1773
+ }
1774
+ }
1775
+
1776
+ // Run the test
1777
+ example().catch(console.error);
1778
+ ```
1779
+
1780
+ ### Parameters
1781
+
1782
+
1783
+ | Name | Type | Description | Notes |
1784
+ |------------- | ------------- | ------------- | -------------|
1785
+ | **updateAssetBackreferencesRequest** | [UpdateAssetBackreferencesRequest](UpdateAssetBackreferencesRequest.md) | | [Optional] |
1786
+
1787
+ ### Return type
1788
+
1789
+ [**UpdateBackreferencesResponse**](UpdateBackreferencesResponse.md)
1790
+
1791
+ ### Authorization
1792
+
1793
+ [bearerAuth](../README.md#bearerAuth)
1794
+
1795
+ ### HTTP request headers
1796
+
1797
+ - **Content-Type**: `application/json`
1798
+ - **Accept**: `application/json`
1799
+
1800
+
1801
+ ### HTTP response details
1802
+ | Status code | Description | Response headers |
1803
+ |-------------|-------------|------------------|
1804
+ | **200** | Successful operation | - |
1805
+ | **400** | Bad request - invalid location or parameters | - |
1806
+ | **404** | Asset not found | - |
1807
+
1808
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1809
+
1810
+
1811
+ ## updateAssetMetadata
1812
+
1813
+ > UpdateAssetMetadataResponse updateAssetMetadata(updateAssetMetadataRequest)
1814
+
1815
+ Update asset contextual and structured metadata
1816
+
1817
+ Patches contextual key-value metadata and/or structured metadata fields on an asset identified by its external ID. Context fields are merged with existing values; structured metadata fields are set directly.
1818
+
1819
+ ### Example
1820
+
1821
+ ```ts
1822
+ import {
1823
+ Configuration,
1824
+ AssetManagementApi,
1825
+ } from '@cloudinary/apps-api';
1826
+ import type { UpdateAssetMetadataOperationRequest } from '@cloudinary/apps-api';
1827
+
1828
+ async function example() {
1829
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1830
+ const config = new Configuration({
1831
+ // Configure HTTP bearer authorization: bearerAuth
1832
+ accessToken: "YOUR BEARER TOKEN",
1833
+ });
1834
+ const api = new AssetManagementApi(config);
1835
+
1836
+ const body = {
1837
+ // UpdateAssetMetadataRequest (optional)
1838
+ updateAssetMetadataRequest: ...,
1839
+ } satisfies UpdateAssetMetadataOperationRequest;
1840
+
1841
+ try {
1842
+ const data = await api.updateAssetMetadata(body);
1843
+ console.log(data);
1844
+ } catch (error) {
1845
+ console.error(error);
1846
+ }
1847
+ }
1848
+
1849
+ // Run the test
1850
+ example().catch(console.error);
1851
+ ```
1852
+
1853
+ ### Parameters
1854
+
1855
+
1856
+ | Name | Type | Description | Notes |
1857
+ |------------- | ------------- | ------------- | -------------|
1858
+ | **updateAssetMetadataRequest** | [UpdateAssetMetadataRequest](UpdateAssetMetadataRequest.md) | | [Optional] |
1859
+
1860
+ ### Return type
1861
+
1862
+ [**UpdateAssetMetadataResponse**](UpdateAssetMetadataResponse.md)
1863
+
1864
+ ### Authorization
1865
+
1866
+ [bearerAuth](../README.md#bearerAuth)
1867
+
1868
+ ### HTTP request headers
1869
+
1870
+ - **Content-Type**: `application/json`
1871
+ - **Accept**: `application/json`
1872
+
1873
+
1874
+ ### HTTP response details
1875
+ | Status code | Description | Response headers |
1876
+ |-------------|-------------|------------------|
1877
+ | **200** | Successful operation | - |
1878
+
1879
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1880
+
1881
+
1882
+ ## updateAssetTags
1883
+
1884
+ > UpdateAssetTagsResponse updateAssetTags(resourceType, updateAssetTagsRequest)
1885
+
1886
+ Add or remove a tag on assets
1887
+
1888
+ Adds or removes a single tag from one or more assets identified by public_id. The command field controls whether the tag is added or removed. Requires OAuth authentication.
1889
+
1890
+ ### Example
1891
+
1892
+ ```ts
1893
+ import {
1894
+ Configuration,
1895
+ AssetManagementApi,
1896
+ } from '@cloudinary/apps-api';
1897
+ import type { UpdateAssetTagsOperationRequest } from '@cloudinary/apps-api';
1898
+
1899
+ async function example() {
1900
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1901
+ const config = new Configuration({
1902
+ // Configure HTTP bearer authorization: bearerAuth
1903
+ accessToken: "YOUR BEARER TOKEN",
1904
+ });
1905
+ const api = new AssetManagementApi(config);
1906
+
1907
+ const body = {
1908
+ // string | The resource type (e.g., image, video, raw)
1909
+ resourceType: resourceType_example,
1910
+ // UpdateAssetTagsRequest (optional)
1911
+ updateAssetTagsRequest: ...,
1912
+ } satisfies UpdateAssetTagsOperationRequest;
1913
+
1914
+ try {
1915
+ const data = await api.updateAssetTags(body);
1916
+ console.log(data);
1917
+ } catch (error) {
1918
+ console.error(error);
1919
+ }
1920
+ }
1921
+
1922
+ // Run the test
1923
+ example().catch(console.error);
1924
+ ```
1925
+
1926
+ ### Parameters
1927
+
1928
+
1929
+ | Name | Type | Description | Notes |
1930
+ |------------- | ------------- | ------------- | -------------|
1931
+ | **resourceType** | `string` | The resource type (e.g., image, video, raw) | [Defaults to `undefined`] |
1932
+ | **updateAssetTagsRequest** | [UpdateAssetTagsRequest](UpdateAssetTagsRequest.md) | | [Optional] |
1933
+
1934
+ ### Return type
1935
+
1936
+ [**UpdateAssetTagsResponse**](UpdateAssetTagsResponse.md)
1937
+
1938
+ ### Authorization
1939
+
1940
+ [bearerAuth](../README.md#bearerAuth)
1941
+
1942
+ ### HTTP request headers
1943
+
1944
+ - **Content-Type**: `application/json`
1945
+ - **Accept**: `application/json`
1946
+
1947
+
1948
+ ### HTTP response details
1949
+ | Status code | Description | Response headers |
1950
+ |-------------|-------------|------------------|
1951
+ | **200** | Tag added successfully | - |
1952
+
1953
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1954
+
1955
+
1956
+ ## updateCollection
1957
+
1958
+ > UpdateCollectionResponse updateCollection(collectionId, updateCollectionRequest)
1959
+
1960
+ Update a collection
1961
+
1962
+ Updates collection properties such as name, description, or dynamic_filters. Caller must have write access.
1963
+
1964
+ ### Example
1965
+
1966
+ ```ts
1967
+ import {
1968
+ Configuration,
1969
+ AssetManagementApi,
1970
+ } from '@cloudinary/apps-api';
1971
+ import type { UpdateCollectionOperationRequest } from '@cloudinary/apps-api';
1972
+
1973
+ async function example() {
1974
+ console.log("🚀 Testing @cloudinary/apps-api SDK...");
1975
+ const config = new Configuration({
1976
+ // Configure HTTP bearer authorization: bearerAuth
1977
+ accessToken: "YOUR BEARER TOKEN",
1978
+ });
1979
+ const api = new AssetManagementApi(config);
1980
+
1981
+ const body = {
1982
+ // string | Collection external ID
1983
+ collectionId: collectionId_example,
1984
+ // UpdateCollectionRequest (optional)
1985
+ updateCollectionRequest: ...,
1986
+ } satisfies UpdateCollectionOperationRequest;
1987
+
1988
+ try {
1989
+ const data = await api.updateCollection(body);
1990
+ console.log(data);
1991
+ } catch (error) {
1992
+ console.error(error);
1993
+ }
1994
+ }
1995
+
1996
+ // Run the test
1997
+ example().catch(console.error);
1998
+ ```
1999
+
2000
+ ### Parameters
2001
+
2002
+
2003
+ | Name | Type | Description | Notes |
2004
+ |------------- | ------------- | ------------- | -------------|
2005
+ | **collectionId** | `string` | Collection external ID | [Defaults to `undefined`] |
2006
+ | **updateCollectionRequest** | [UpdateCollectionRequest](UpdateCollectionRequest.md) | | [Optional] |
2007
+
2008
+ ### Return type
2009
+
2010
+ [**UpdateCollectionResponse**](UpdateCollectionResponse.md)
2011
+
2012
+ ### Authorization
2013
+
2014
+ [bearerAuth](../README.md#bearerAuth)
2015
+
2016
+ ### HTTP request headers
2017
+
2018
+ - **Content-Type**: `application/json`
2019
+ - **Accept**: `application/json`
2020
+
2021
+
2022
+ ### HTTP response details
2023
+ | Status code | Description | Response headers |
2024
+ |-------------|-------------|------------------|
2025
+ | **200** | Successful operation | - |
2026
+ | **403** | Forbidden | - |
2027
+
2028
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2029
+