@agravity/private 11.0.3 → 11.1.0

package/README.md

@@ -1,8 +1,8 @@
-# @agravity/private@11.0.3
+# @agravity/private@11.1.0
 
   <p>Agravity is a powerful, enterprise-grade Headless Digital Asset Management (DAM) system designed for organizations that need complete control over how they manage, organize, and distribute their digital assets.</p>    <h2>Key Features</h2>  <ul>  <li>Asset Management - Upload, organize, and manage all types of digital assets (images, videos, documents, etc.)</li>  <li>Collections &amp; Hierarchies - Create flexible folder structures and collection types with customizable metadata</li>  <li>Advanced Search - Powered by Azure Cognitive Search with AI-enhanced capabilities for intelligent discovery</li>  <li>AI Integration - Leverage AI to automatically generate metadata, tags, and descriptions for your assets</li>  <li>Versioning - Track and restore previous versions of your assets with complete version history</li>  <li>Publishing &amp; Distribution - Publish assets to various channels including Vimeo, CDN, and custom portals</li>  <li>Portal System - Create public-facing portals with granular permission controls and custom branding</li>  <li>Download Formats - Define custom download formats with image transformations and optimizations</li>  <li>Collaboration Features - Share collections, create quick shares, and manage team access with role-based permissions</li>  <li>Multi-Language Support - Full translation capabilities for all metadata and UI elements</li>  <li>API-First Architecture - Complete REST API for seamless integration with your applications</li>  </ul>    <h2>Headless DAM Benefits</h2>  <p>As a headless DAM solution, Agravity separates content management from presentation. This means:</p>  <ul>  <li>Flexibility - Use the same assets across multiple channels and applications without duplication</li>  <li>API-Driven - Access all functionality through powerful REST APIs for custom integrations</li>  <li>Framework Agnostic - Integrate with any frontend framework or technology stack</li>  <li>Scalability - Built on cloud-native architecture with Azure infrastructure for unlimited growth</li>  <li>Multi-Channel Distribution - Publish to web, mobile, social media, and custom portals from a single source</li>  </ul>    <h2>Core Entities</h2>  <p><strong>Assets</strong> - Your digital content (images, videos, documents). Each asset can have multiple versions, metadata, and be published to various targets.</p>  <p><strong>Collections</strong> - Logical groupings of assets organized hierarchically. Support custom metadata through collection types.</p>  <p><strong>Collection Types</strong> - Define the structure and metadata fields for collections, similar to database schemas.</p>  <p><strong>Workspaces</strong> - Organize collection types into workspaces for multi-project management.</p>  <p><strong>Download Formats</strong> - Define transformations and optimizations for assets when downloaded.</p>  <p><strong>Portals</strong> - Public-facing interfaces for sharing collections with external stakeholders.</p>    <h2>API Endpoints Overview</h2>  <p><strong>Asset Management</strong> - Create, read, update, delete, and search assets with full metadata support</p>  <p><strong>Collection Management</strong> - Organize assets into collections with hierarchical structures</p>  <p><strong>AI Operations</strong> - Automatically generate asset metadata using AI-powered field generation</p>  <p><strong>Publishing</strong> - Publish assets to Vimeo, CDN, or custom publishing targets</p>  <p><strong>Search &amp; Discovery</strong> - Full-text search with advanced filtering and AI-enhanced similarity search</p>  <p><strong>User &amp; Portal Management</strong> - Control access through roles, profiles, and custom portals</p>  <p><strong>Content Distribution</strong> - Share collections, create download packages, and generate secure links</p>    <h2>Security &amp; Permissions</h2>  <ul>  <li>OAuth 2.0 authentication with Azure AD integration</li>  <li>Role-based access control (RBAC) with custom profiles</li>  <li>Entity-level permissions for granular control</li>  <li>API key authentication for service-to-service communication</li>  <li>Secure sharing with password-protected links and expiration dates</li>  </ul>    <h2>Use Cases</h2>  <ul>  <li>E-commerce product image management and distribution</li>  <li>Marketing asset management across multiple channels</li>  <li>Brand asset library and governance</li>  <li>Video content management and publishing</li>  <li>Enterprise document management with searchability</li>  <li>Multi-tenant content management for agencies</li>  <li>AI-powered metadata generation at scale</li>  </ul>    <h2>Support</h2>  <p>For questions or support, contact <a href=\"mailto:support@agravity.io\">support@agravity.io</a> or visit <a href=\"https://agravity.io\">https://agravity.io</a>.</p>    < p>Agravity © 2026 - Enterprise Headless Digital Asset Management</p>      
 
-The version of the OpenAPI document: 11.0.3
+The version of the OpenAPI document: 11.1.0
 
 ## Building
 
@@ -24,7 +24,7 @@ Navigate to the folder of your consuming project and run one of next commands.
 _published:_
 
 ```console
-npm install @agravity/private@11.0.3 --save
+npm install @agravity/private@11.1.0 --save
 ```
 
 _without publishing (not recommended):_

package/api/helperTools.agravity.ts

@@ -51,6 +51,10 @@ export interface HttpGetAllUserDefinedListsRequestParams {
 	translations?: boolean;
 	/** The requested language of the response. If not matching it falls back to default language. */
 	acceptLanguage?: string;
+	/** A portal ID ignores permissions but the param coll_ids. */
+	portalId?: string;
+	/** A comma separated list of parent IDs of UDLs which should be fetched. */
+	collIds?: string;
 }
 
 export interface HttpGetAllowedFilterableItemsRequestParams {
@@ -398,11 +402,17 @@ export class HelperToolsService extends BaseService {
 	): Observable<any> {
 		const translations = requestParameters?.translations;
 		const acceptLanguage = requestParameters?.acceptLanguage;
+		const portalId = requestParameters?.portalId;
+		const collIds = requestParameters?.collIds;
 
 		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
 
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
 
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'portal_id', <any>portalId, QueryParamStyle.Form, true);
+
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'coll_ids', <any>collIds, QueryParamStyle.Form, true);
+
 		let localVarHeaders = this.defaultHeaders;
 		if (acceptLanguage !== undefined && acceptLanguage !== null) {
 			localVarHeaders = localVarHeaders.set('Accept-Language', String(acceptLanguage));

package/api/searchManagement.agravity.ts

@@ -19,6 +19,8 @@ import { AgravityErrorResponse } from '../model/agravityErrorResponse.agravity';
 // @ts-ignore
 import { AgravityInfoResponse } from '../model/agravityInfoResponse.agravity';
 // @ts-ignore
+import { AzSearchOptions } from '../model/azSearchOptions.agravity';
+// @ts-ignore
 import { SearchAdminStatus } from '../model/searchAdminStatus.agravity';
 // @ts-ignore
 import { SearchFacet } from '../model/searchFacet.agravity';
@@ -96,6 +98,17 @@ export interface HttpGlobalSearchRequestParams {
 	acceptLanguage?: string;
 }
 
+export interface HttpGlobalSearchPostRequestParams {
+	/** Search options for the request body. */
+	azSearchOptions: AzSearchOptions;
+	/** When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) */
+	translations?: boolean;
+	/** The requested language of the response. If not matching it falls back to default language. */
+	acceptLanguage?: string;
+	/** This will expose the thumbnail asset blob incl. URL with SAS Token. */
+	expose?: boolean;
+}
+
 export interface HttpPatchCleanSearchFromDeletedAssetsRequestParams {
 	/** If the search should be redirected to a specific portal. */
 	portalId?: string;
@@ -392,7 +405,7 @@ export class SearchManagementService extends BaseService {
 	}
 
 	/**
-	 * This endpoint returns a configured max amount of results for search terms.
+	 * This endpoint returns a configured max amount of results for search terms using query parameters.
 	 * @endpoint get /search
 	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -517,6 +530,102 @@ export class SearchManagementService extends BaseService {
 		});
 	}
 
+	/**
+	 * This endpoint returns a configured max amount of results for search options in the request body.
+	 * @endpoint post /search
+	 * @param requestParameters
+	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+	 * @param reportProgress flag to report request and response progress.
+	 * @param options additional options
+	 */
+	public httpGlobalSearchPost(
+		requestParameters: HttpGlobalSearchPostRequestParams,
+		observe?: 'body',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<SearchResult>;
+	public httpGlobalSearchPost(
+		requestParameters: HttpGlobalSearchPostRequestParams,
+		observe?: 'response',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<HttpResponse<SearchResult>>;
+	public httpGlobalSearchPost(
+		requestParameters: HttpGlobalSearchPostRequestParams,
+		observe?: 'events',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<HttpEvent<SearchResult>>;
+	public httpGlobalSearchPost(
+		requestParameters: HttpGlobalSearchPostRequestParams,
+		observe: any = 'body',
+		reportProgress: boolean = false,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<any> {
+		const azSearchOptions = requestParameters?.azSearchOptions;
+		if (azSearchOptions === null || azSearchOptions === undefined) {
+			throw new Error('Required parameter azSearchOptions was null or undefined when calling httpGlobalSearchPost.');
+		}
+		const translations = requestParameters?.translations;
+		const acceptLanguage = requestParameters?.acceptLanguage;
+		const expose = requestParameters?.expose;
+
+		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
+
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
+
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'expose', <any>expose, QueryParamStyle.Form, true);
+
+		let localVarHeaders = this.defaultHeaders;
+		if (acceptLanguage !== undefined && acceptLanguage !== null) {
+			localVarHeaders = localVarHeaders.set('Accept-Language', String(acceptLanguage));
+		}
+
+		// authentication (msal_auth) required
+		localVarHeaders = this.configuration.addCredentialToHeaders('msal_auth', 'Authorization', localVarHeaders, 'Bearer ');
+
+		const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
+		if (localVarHttpHeaderAcceptSelected !== undefined) {
+			localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
+		}
+
+		const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
+
+		const localVarTransferCache: boolean = options?.transferCache ?? true;
+
+		// to determine the Content-Type header
+		const consumes: string[] = ['application/json'];
+		const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes);
+		if (httpContentTypeSelected !== undefined) {
+			localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected);
+		}
+
+		let responseType_: 'text' | 'json' | 'blob' = 'json';
+		if (localVarHttpHeaderAcceptSelected) {
+			if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+				responseType_ = 'text';
+			} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+				responseType_ = 'json';
+			} else {
+				responseType_ = 'blob';
+			}
+		}
+
+		let localVarPath = `/search`;
+		const { basePath, withCredentials } = this.configuration;
+		return this.httpClient.request<SearchResult>('post', `${basePath}${localVarPath}`, {
+			context: localVarHttpContext,
+			body: azSearchOptions,
+			params: localVarQueryParameters.toHttpParams(),
+			responseType: <any>responseType_,
+			...(withCredentials ? { withCredentials } : {}),
+			headers: localVarHeaders,
+			observe: observe,
+			...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
+			reportProgress: reportProgress
+		});
+	}
+
 	/**
 	 * This endpoint removes all assets which are not longer available in the database from the search index.
 	 * @endpoint patch /searchadmin/clean

package/model/notificationSettingsEntry.agravity.ts

@@ -14,4 +14,5 @@ export interface NotificationSettingsEntry {
 	event_types?: Array<string> | null;
 	frequency?: string | null;
 	include_sub_collections?: boolean | null;
+	email_addresses?: Array<string> | null;
 }

package/model/portalFields.agravity.ts

@@ -13,6 +13,7 @@ export interface PortalFields {
 	name?: string | null;
 	detail_order?: number | null;
 	facet_order?: number | null;
+	orfilterable?: boolean | null;
 	labels?: { [key: string]: string } | null;
 	user_context?: PortalUserContext | null;
 	format?: string | null;

package/model/searchResult.agravity.ts

@@ -13,7 +13,7 @@ import { AzSearchOptions } from './azSearchOptions.agravity';
 
 export interface SearchResult {
 	data_result?: DataResult | null;
-	options?: AzSearchOptions | null;
+	options?: AzSearchOptions;
 	facets?: Array<SearchFacet> | null;
 	count?: number | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@agravity/private",
-	"version": "11.0.3",
+	"version": "11.1.0",
 	"description": "The Agravity GlobalDAM API which allowes authenticated user to access the Agravity GlobalDAM Backend",
 	"author": "Philipp Losbichler",
 	"repository": {