@agravity/public 10.2.0 → 10.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/api/publicAIOperations.pub.agravity.ts +1 -1
- package/api/publicAssetManagement.pub.agravity.ts +1 -1
- package/api/publicAssetOperations.pub.agravity.ts +1 -1
- package/api/publicAssetPublishing.pub.agravity.ts +1 -1
- package/api/publicAssetRelationManagement.pub.agravity.ts +1 -1
- package/api/publicAssetVersioning.pub.agravity.ts +1 -1
- package/api/publicAuthenticationManagement.pub.agravity.ts +1 -1
- package/api/publicCollectionManagement.pub.agravity.ts +1 -1
- package/api/publicCollectionSecureUpload.pub.agravity.ts +1 -1
- package/api/publicCollectionTypeManagement.pub.agravity.ts +1 -1
- package/api/publicConfigurationManagement.pub.agravity.ts +1 -1
- package/api/publicDownloadFormatManagement.pub.agravity.ts +1 -1
- package/api/publicEndpoints.pub.agravity.ts +1 -1
- package/api/publicGeneralManagement.pub.agravity.ts +1 -1
- package/api/publicHelperTools.pub.agravity.ts +1 -1
- package/api/publicPortalManagement.pub.agravity.ts +1 -1
- package/api/publicPublishing.pub.agravity.ts +1 -1
- package/api/publicSavedSearch.pub.agravity.ts +1 -1
- package/api/publicSearchManagement.pub.agravity.ts +1 -1
- package/api/publicSharingManagement.pub.agravity.ts +1 -1
- package/api/publicSignalRConnectionManagement.pub.agravity.ts +1 -1
- package/api/publicStaticDefinedListManagement.pub.agravity.ts +1 -1
- package/api/publicTranslationManagement.pub.agravity.ts +1 -1
- package/api/publicWebAppData.pub.agravity.ts +1 -1
- package/api/publicWorkspaceManagement.pub.agravity.ts +1 -1
- package/api.base.service.ts +1 -1
- package/model/agravityErrorResponse.pub.agravity.ts +1 -1
- package/model/agravityInfoResponse.pub.agravity.ts +1 -1
- package/model/agravityUser.pub.agravity.ts +1 -1
- package/model/agravityUserOnlineStatus.pub.agravity.ts +1 -1
- package/model/agravityVersion.pub.agravity.ts +1 -1
- package/model/allWebAppData.pub.agravity.ts +1 -1
- package/model/asset.pub.agravity.ts +1 -1
- package/model/assetAvailability.pub.agravity.ts +1 -1
- package/model/assetBlob.pub.agravity.ts +1 -1
- package/model/assetIconRule.pub.agravity.ts +1 -1
- package/model/assetIdFormat.pub.agravity.ts +1 -1
- package/model/assetPageResult.pub.agravity.ts +1 -1
- package/model/assetRelation.pub.agravity.ts +1 -1
- package/model/azSearchOptions.pub.agravity.ts +1 -1
- package/model/collTypeItem.pub.agravity.ts +1 -1
- package/model/collection.pub.agravity.ts +1 -1
- package/model/collectionType.pub.agravity.ts +1 -1
- package/model/collectionUDL.pub.agravity.ts +1 -1
- package/model/collectionUDLListEntity.pub.agravity.ts +1 -1
- package/model/collectionUDLReference.pub.agravity.ts +1 -1
- package/model/createSftpUserResult.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseActionAttributeCollectionSubmit.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseActionTokenIssuanceStart.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseClaims.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseContentAttributeCollectionSubmit.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseContentTokenIssuanceStart.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseDataAttributeCollectionSubmit.pub.agravity.ts +1 -1
- package/model/customClaimsProviderResponseDataTokenIssuanceStart.pub.agravity.ts +1 -1
- package/model/dataResult.pub.agravity.ts +1 -1
- package/model/deletedEntities.pub.agravity.ts +1 -1
- package/model/distZipResponse.pub.agravity.ts +1 -1
- package/model/downloadFormat.pub.agravity.ts +1 -1
- package/model/downloadZipRequest.pub.agravity.ts +1 -1
- package/model/downloadZipStatus.pub.agravity.ts +1 -1
- package/model/dynamicImageOperation.pub.agravity.ts +1 -1
- package/model/entityId.pub.agravity.ts +1 -1
- package/model/entityIdName.pub.agravity.ts +1 -1
- package/model/entityListResult.pub.agravity.ts +1 -1
- package/model/entityNamesRequest.pub.agravity.ts +1 -1
- package/model/frontendAppConfig.pub.agravity.ts +1 -1
- package/model/groupAllAppData.pub.agravity.ts +1 -1
- package/model/moveCollectionBody.pub.agravity.ts +1 -1
- package/model/permissionEntity.pub.agravity.ts +1 -1
- package/model/portal.pub.agravity.ts +1 -1
- package/model/portalAuthentication.pub.agravity.ts +1 -1
- package/model/portalConfiguration.pub.agravity.ts +1 -1
- package/model/portalFields.pub.agravity.ts +1 -1
- package/model/portalLinks.pub.agravity.ts +1 -1
- package/model/portalTheme.pub.agravity.ts +1 -1
- package/model/portalUserContext.pub.agravity.ts +1 -1
- package/model/publishEntity.pub.agravity.ts +1 -1
- package/model/publishedAsset.pub.agravity.ts +1 -1
- package/model/quickShareFull.pub.agravity.ts +1 -1
- package/model/relatedAsset.pub.agravity.ts +1 -1
- package/model/sasToken.pub.agravity.ts +1 -1
- package/model/savedSearch.pub.agravity.ts +1 -1
- package/model/searchAdminDataSourceStatus.pub.agravity.ts +1 -1
- package/model/searchAdminIndexStatus.pub.agravity.ts +1 -1
- package/model/searchAdminIndexerLastRun.pub.agravity.ts +1 -1
- package/model/searchAdminIndexerStatus.pub.agravity.ts +1 -1
- package/model/searchAdminSkillStatus.pub.agravity.ts +1 -1
- package/model/searchAdminStatistics.pub.agravity.ts +1 -1
- package/model/searchAdminStatus.pub.agravity.ts +1 -1
- package/model/searchFacet.pub.agravity.ts +1 -1
- package/model/searchFacetEntity.pub.agravity.ts +1 -1
- package/model/searchResult.pub.agravity.ts +1 -1
- package/model/searchableItem.pub.agravity.ts +1 -1
- package/model/secureUploadEntity.pub.agravity.ts +1 -1
- package/model/sharedAllowedFormat.pub.agravity.ts +1 -1
- package/model/sharedAsset.pub.agravity.ts +1 -1
- package/model/sharedCollectionFull.pub.agravity.ts +1 -1
- package/model/signalRConnectionInfo.pub.agravity.ts +1 -1
- package/model/staticDefinedList.pub.agravity.ts +1 -1
- package/model/versionEntity.pub.agravity.ts +1 -1
- package/model/versionedAsset.pub.agravity.ts +1 -1
- package/model/whereParam.pub.agravity.ts +1 -1
- package/model/workspace.pub.agravity.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# @agravity/public@10.2.
|
|
1
|
+
# @agravity/public@10.2.2
|
|
2
2
|
|
|
3
|
-
<
|
|
3
|
+
<p>The Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.</p><br/><h2>Access & Security</h2><br/><b>API key is required to access these endpoints.</b><br/><ul><li>API Key Authentication - Each request requires a valid API key in headers or parameters</li><li>Portal-Aware - Many endpoints support portal context for multi-tenant scenarios</li><li>Service-to-Service Communication - Designed for backend-to-backend integrations</li><li>Stable & Versioned - Public API versioning ensures backward compatibility</li></ul><h2>Core Features & Operations</h2><ul><li><strong>Asset Management</strong> - Create, retrieve, update assets with full metadata support; manage versions and publish assets</li><li><strong>Collection Management</strong> - Create and organize collections hierarchically; retrieve collection type definitions and structures</li><li><strong>Asset Operations</strong> - Retrieve asset blobs (thumbnails, optimized, original); rotate and resize images; find similar assets using AI reverse search</li><li><strong>Image Editing</strong> - Apply transformations to images with advanced parameters (resize, crop, filter, color space, DPI, quality, depth)</li><li><strong>Asset Publishing</strong> - Publish assets to various targets (Vimeo, CDN); manage published asset information</li><li><strong>Asset Versioning</strong> - Create, restore, and manage asset versions; track version history with descriptions</li><li><strong>Asset Relations</strong> - Create and manage relationships between assets with hierarchical or standard relations</li><li><strong>Full-Text Search</strong> - Search assets and collections with advanced filtering, facets, and sorting capabilities</li><li><strong>Collection Sharing</strong> - Create shared collections with expiration dates, password protection, and download limits</li><li><strong>Quick Shares</strong> - Create quick share links for rapid asset sharing with expiration management</li><li><strong>Portals</strong> - Full portal management with authentication, custom theming, and asset filtering</li><li><strong>Secure Upload</strong> - Secure file upload endpoints with validation and SAS token generation</li><li><strong>Download Management</strong> - Create ZIP packages of assets with format specifications; track download progress</li><li><strong>Download Formats</strong> - Define and apply custom image transformations and optimizations for downloads</li><li><strong>Authentication</strong> - Generate SAS tokens for container write access; retrieve user information</li><li><strong>Configuration</strong> - Access frontend configuration values and system settings</li><li><strong>Helper Tools</strong> - Get searchable items, filterable items, user-defined lists, and static defined lists</li><li><strong>Translations</strong> - Retrieve translations for all entities in multiple languages</li><li><strong>Deleted Entities Tracking</strong> - Track deleted assets, collections, and other entities by date</li></ul><h2>Available Endpoints by Category</h2><ul><li><strong>Asset Management</strong> - /assets, /assets/{id}, /assetsupload, /assetrelations</li><li><strong>Asset Operations</strong> - /assets/{id}/blobs, /assets/{id}/collections, /assets/{id}/tocollection, /assets/{id}/download, /assets/{id}/resize, /assets/{id}/imageedit, /assets/{id}/availability</li><li><strong>Asset Publishing</strong> - /assets/{id}/publish, /assets/{id}/publish/{pid}</li><li><strong>Asset Versioning</strong> - /assets/{id}/versions, /assets/{id}/versionsupload, /assets/{id}/versions/{vNr}/restore</li><li><strong>AI Operations</strong> - /ai/reverseassetsearch (find similar assets using image)</li><li><strong>Collection Management</strong> - /collections, /collections/{id}, /collections/{id}/ancestors, /collections/{id}/descendants, /collections/{id}/previews, /collectionsbynames</li><li><strong>Collection Types</strong> - /collectiontypes, /collectiontypes/{id}, /collectiontypesitems</li><li><strong>Search</strong> - /search, /search/facette, /searchadmin/status</li><li><strong>Saved Searches</strong> - /savedsearches</li><li><strong>Collection Sharing</strong> - /shared/{id}, /shared/{id}/zip, /quickshares/{id}</li><li><strong>Secure Upload</strong> - /secureupload/{id}, /secureupload/{id}/upload</li><li><strong>Portal Management</strong> - /portals/{id}, /portals/{id}/config, /portals/{id}/zip, /portals/{id}/assetids, /portalsenhancetoken, /portalssaveuserattributes</li><li><strong>Authentication</strong> - /auth/containerwrite/{containerName}, /auth/inbox, /auth/users/{id}</li><li><strong>Download Formats</strong> - /downloadformats, /downloadformats-shared</li><li><strong>Configuration</strong> - /config/frontend</li><li><strong>Static Defined Lists</strong> - /staticdefinedlists, /staticdefinedlists/{id}</li><li><strong>User-Defined Lists</strong> - /helper/userdefinedlists</li><li><strong>Helper Tools</strong> - /helper/searchableitemnames, /helper/searchableitems, /helper/filterableitems</li><li><strong>Translations</strong> - /translations/{id}, /translations/{id}/{property}, /translations/{id}/custom/{customField}</li><li><strong>Web App Data</strong> - /webappdata/{id}, /data/collectiontype/{id}</li><li><strong>Workspace Management</strong> - /workspaces, /workspaces/{id}</li><li><strong>General</strong> - /version, /deleted, /durable/{instanceId}, /public/view, /signalr/negotiate</li></ul><h2>Typical Use Cases</h2><ul><li>E-commerce platforms - Product image management and dynamic optimization</li><li>Marketing automation - Asset distribution across channels with version control</li><li>Portal systems - Multi-tenant asset galleries with custom theming and permissions</li><li>Headless CMS integration - Content delivery with dynamic transformations</li><li>Mobile applications - Asset retrieval with mobile-optimized formats</li><li>AI-powered workflows - Reverse image search and automatic metadata generation</li><li>Asset sharing platforms - Secure sharing with expiration and password protection</li><li>Digital distribution - ZIP creation and bulk download management</li><li>Multi-language content - Translation management across all assets and collections</li><li>Real-time monitoring - Deletion tracking and version history auditing</li></ul><h2>Key Capabilities</h2><ul><li>Full CRUD operations on assets, collections, and related entities</li><li>Advanced image transformation with ImageMagick integration</li><li>AI-powered reverse image search for asset discovery</li><li>Multi-language support with translation dictionaries</li><li>Granular permission control and role-based access</li><li>Portal creation with custom authentication and theming</li><li>Hierarchical collection organization with dynamic filtering</li><li>Real-time search with faceted navigation and advanced filtering</li><li>Secure sharing with expiration and password protection</li><li>Blob storage integration with SAS token generation</li><li>Comprehensive asset versioning and restoration</li><li>SignalR support for real-time notifications</li></ul><h2>Authentication & Authorization</h2><p>All endpoints (except public share endpoints) require API key authentication. The API key can be provided:</p><ul><li>As query parameter: ?code=YOUR_API_KEY</li><li>As header: x-functions-key: YOUR_API_KEY</li></ul><p>Portal endpoints may have additional authentication methods (OAuth, Azure AD, Auth0, password) depending on portal configuration.</p><h2>Support</h2><p>For technical support or integration questions, contact <a href=\"mailto:support@agravity.io\">support@agravity.io</a> or visit <a href=\"https://agravity.io\">https://agravity.io</a>.</p><br/><p>Copyright © Agravity GmbH 2026. All Rights Reserved</p>
|
|
4
4
|
|
|
5
|
-
The version of the OpenAPI document: 10.2.
|
|
5
|
+
The version of the OpenAPI document: 10.2.2
|
|
6
6
|
|
|
7
7
|
## Building
|
|
8
8
|
|
|
@@ -24,7 +24,7 @@ Navigate to the folder of your consuming project and run one of next commands.
|
|
|
24
24
|
_published:_
|
|
25
25
|
|
|
26
26
|
```console
|
|
27
|
-
npm install @agravity/public@10.2.
|
|
27
|
+
npm install @agravity/public@10.2.2 --save
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
_without publishing (not recommended):_
|
package/api.base.service.ts
CHANGED