@agravity/private 11.1.2 → 12.0.0

package/api/collectionTypeManagement.agravity.ts

@@ -19,8 +19,6 @@ import { AgravityErrorResponse } from '../model/agravityErrorResponse.agravity';
 // @ts-ignore
 import { AgravityInfoResponse } from '../model/agravityInfoResponse.agravity';
 // @ts-ignore
-import { CollTypeItem } from '../model/collTypeItem.agravity';
-// @ts-ignore
 import { CollectionType } from '../model/collectionType.agravity';
 // @ts-ignore
 import { PermissionChange } from '../model/permissionChange.agravity';
@@ -31,10 +29,12 @@ import { AgravityConfiguration } from '../configuration';
 import { BaseService } from '../api.base.service';
 
 export interface HttpCollectionTypesCreateRequestParams {
-	/** This endpoint creates a unique collection type ID and adds the information to the database. */
+	/** This endpoint creates a unique collection type ID and adds the information to the database. \'items\' is deprecated on create and update, use \'item_refs\': requests with \'items\' will be rejected in a future version. */
 	collectionType: CollectionType;
 	/** (optional) The ID of the workspace where this collection type should be assigned. */
 	workspaceid?: string;
+	/** When true, returns the resolved collection type items alongside the item refs. */
+	items?: boolean;
 	/** 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. */
@@ -47,6 +47,8 @@ export interface HttpCollectionTypesDeleteRequestParams {
 }
 
 export interface HttpCollectionTypesGetRequestParams {
+	/** When true, returns the resolved collection type items alongside the item refs. */
+	items?: boolean;
 	/** 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. */
@@ -56,6 +58,8 @@ export interface HttpCollectionTypesGetRequestParams {
 export interface HttpCollectionTypesGetByIdRequestParams {
 	/** The ID of the collection type. */
 	id: string;
+	/** When true, returns the resolved collection type items alongside the item refs. */
+	items?: boolean;
 	/** 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. */
@@ -65,8 +69,10 @@ export interface HttpCollectionTypesGetByIdRequestParams {
 export interface HttpCollectionTypesUpdateRequestParams {
 	/** The ID of the collection type. */
 	id: string;
-	/** The body has to be a valid collection type json. Not fitting properties are ignored. */
+	/** The body has to be a valid collection type json. Not fitting properties are ignored. \'items\' is deprecated on create and update, use \'item_refs\': requests with \'items\' will be rejected in a future version. */
 	collectionType: CollectionType;
+	/** When true, returns the resolved collection type items alongside the item refs. */
+	items?: boolean;
 	/** 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. */
@@ -80,20 +86,6 @@ export interface HttpCollectionTypesUpdatePermissionsByIdRequestParams {
 	permissionChange: PermissionChange;
 }
 
-export interface HttpGetCollectionTypeItemsRequestParams {
-	/** True if the blueprint items should be included. */
-	includeblueprint?: boolean;
-	/** 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;
-}
-
-export interface HttpUpdateCollectionTypeItemsRequestParams {
-	/** Items which should be updated. */
-	collTypeItem: Array<CollTypeItem>;
-}
-
 @Injectable({
 	providedIn: 'root'
 })
@@ -107,7 +99,7 @@ export class CollectionTypeManagementService extends BaseService {
 	}
 
 	/**
-	 * This endpoint creates a unique collection type ID and adds the information to the database.
+	 * This endpoint creates a unique collection type ID and adds the information to the database. There is no negative order: a missing, 0 or negative order means no order (9999). \&#39;items\&#39; is deprecated on create and update, use \&#39;item_refs\&#39;: requests with \&#39;items\&#39; will be rejected in a future version.
 	 * @endpoint post /collectiontypes
 	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -143,6 +135,7 @@ export class CollectionTypeManagementService extends BaseService {
 			throw new Error('Required parameter collectionType was null or undefined when calling httpCollectionTypesCreate.');
 		}
 		const workspaceid = requestParameters?.workspaceid;
+		const items = requestParameters?.items;
 		const translations = requestParameters?.translations;
 		const acceptLanguage = requestParameters?.acceptLanguage;
 
@@ -150,6 +143,8 @@ export class CollectionTypeManagementService extends BaseService {
 
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'workspaceid', <any>workspaceid, QueryParamStyle.Form, true);
 
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
+
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
 
 		let localVarHeaders = this.defaultHeaders;
@@ -309,11 +304,14 @@ export class CollectionTypeManagementService extends BaseService {
 		reportProgress: boolean = false,
 		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<any> {
+		const items = requestParameters?.items;
 		const translations = requestParameters?.translations;
 		const acceptLanguage = requestParameters?.acceptLanguage;
 
 		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
 
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
+
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
 
 		let localVarHeaders = this.defaultHeaders;
@@ -394,11 +392,14 @@ export class CollectionTypeManagementService extends BaseService {
 		if (id === null || id === undefined) {
 			throw new Error('Required parameter id was null or undefined when calling httpCollectionTypesGetById.');
 		}
+		const items = requestParameters?.items;
 		const translations = requestParameters?.translations;
 		const acceptLanguage = requestParameters?.acceptLanguage;
 
 		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
 
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
+
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
 
 		let localVarHeaders = this.defaultHeaders;
@@ -444,7 +445,7 @@ export class CollectionTypeManagementService extends BaseService {
 	}
 
 	/**
-	 * This endpoint updates the collection type. Null fields will be ignored. If \&#39;items\&#39; are set they are fully reset (like PUT).
+	 * This endpoint updates the collection type. Null fields will be ignored: a missing order keeps the order, a missing permissionless keeps permissionless and the permissions. \&#39;permissions\&#39; are only applied when permissionless is switched off, otherwise they are ignored (use the /permissions endpoint to change them). There is no negative order: a negative order (e.g. -1) resets the order. Without \&#39;items\&#39; and \&#39;item_refs\&#39; the item assignment (incl. groups) is kept. If \&#39;items\&#39; are set the assignment is fully reset (like PUT): missing items are created, existing items (same id) are only referenced - changes to existing items are ignored (use the colltypeitems endpoints). Items which are no longer referenced are kept. An item keeps the group of its existing item ref unless \&#39;group\&#39; is set: a group name is mapped to its item group, an empty string removes the group; group-only item refs are kept. If \&#39;item_refs\&#39; are set as well, group and order are taken from the item ref with the same item_id and the other item refs are appended. Empty \&#39;items\&#39; together with \&#39;item_refs\&#39; are ignored. An item_id may be referenced only once. On new list items (UDL, SDL) the default_value has to be an entry of the referenced list (ref_id). \&#39;items\&#39; is deprecated on create and update, use \&#39;item_refs\&#39;: requests with \&#39;items\&#39; will be rejected in a future version.
 	 * @endpoint post /collectiontypes/{id}
 	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -483,11 +484,14 @@ export class CollectionTypeManagementService extends BaseService {
 		if (collectionType === null || collectionType === undefined) {
 			throw new Error('Required parameter collectionType was null or undefined when calling httpCollectionTypesUpdate.');
 		}
+		const items = requestParameters?.items;
 		const translations = requestParameters?.translations;
 		const acceptLanguage = requestParameters?.acceptLanguage;
 
 		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
 
+		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
+
 		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
 
 		let localVarHeaders = this.defaultHeaders;
@@ -626,171 +630,4 @@ export class CollectionTypeManagementService extends BaseService {
 			reportProgress: reportProgress
 		});
 	}
-
-	/**
-	 * This method returns a list of all collection types items. (Regardless of the permissions)
-	 * @endpoint get /collectiontypesitems
-	 * @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 httpGetCollectionTypeItems(
-		requestParameters?: HttpGetCollectionTypeItemsRequestParams,
-		observe?: 'body',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<Array<CollTypeItem>>;
-	public httpGetCollectionTypeItems(
-		requestParameters?: HttpGetCollectionTypeItemsRequestParams,
-		observe?: 'response',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<HttpResponse<Array<CollTypeItem>>>;
-	public httpGetCollectionTypeItems(
-		requestParameters?: HttpGetCollectionTypeItemsRequestParams,
-		observe?: 'events',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<HttpEvent<Array<CollTypeItem>>>;
-	public httpGetCollectionTypeItems(
-		requestParameters?: HttpGetCollectionTypeItemsRequestParams,
-		observe: any = 'body',
-		reportProgress: boolean = false,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<any> {
-		const includeblueprint = requestParameters?.includeblueprint;
-		const translations = requestParameters?.translations;
-		const acceptLanguage = requestParameters?.acceptLanguage;
-
-		let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
-
-		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'includeblueprint', <any>includeblueprint, QueryParamStyle.Form, true);
-
-		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, 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;
-
-		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 = `/collectiontypesitems`;
-		const { basePath, withCredentials } = this.configuration;
-		return this.httpClient.request<Array<CollTypeItem>>('get', `${basePath}${localVarPath}`, {
-			context: localVarHttpContext,
-			params: localVarQueryParameters.toHttpParams(),
-			responseType: <any>responseType_,
-			...(withCredentials ? { withCredentials } : {}),
-			headers: localVarHeaders,
-			observe: observe,
-			...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
-			reportProgress: reportProgress
-		});
-	}
-
-	/**
-	 * This endpoint updates all collection type items in all collection types regarding: Label, Order, Translations and Group
-	 * @endpoint post /collectiontypesitems
-	 * @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 httpUpdateCollectionTypeItems(
-		requestParameters: HttpUpdateCollectionTypeItemsRequestParams,
-		observe?: 'body',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<Array<CollectionType>>;
-	public httpUpdateCollectionTypeItems(
-		requestParameters: HttpUpdateCollectionTypeItemsRequestParams,
-		observe?: 'response',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<HttpResponse<Array<CollectionType>>>;
-	public httpUpdateCollectionTypeItems(
-		requestParameters: HttpUpdateCollectionTypeItemsRequestParams,
-		observe?: 'events',
-		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<HttpEvent<Array<CollectionType>>>;
-	public httpUpdateCollectionTypeItems(
-		requestParameters: HttpUpdateCollectionTypeItemsRequestParams,
-		observe: any = 'body',
-		reportProgress: boolean = false,
-		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
-	): Observable<any> {
-		const collTypeItem = requestParameters?.collTypeItem;
-		if (collTypeItem === null || collTypeItem === undefined) {
-			throw new Error('Required parameter collTypeItem was null or undefined when calling httpUpdateCollectionTypeItems.');
-		}
-
-		let localVarHeaders = this.defaultHeaders;
-
-		// 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 = `/collectiontypesitems`;
-		const { basePath, withCredentials } = this.configuration;
-		return this.httpClient.request<Array<CollectionType>>('post', `${basePath}${localVarPath}`, {
-			context: localVarHttpContext,
-			body: collTypeItem,
-			responseType: <any>responseType_,
-			...(withCredentials ? { withCredentials } : {}),
-			headers: localVarHeaders,
-			observe: observe,
-			...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
-			reportProgress: reportProgress
-		});
-	}
 }

package/api/generalManagement.agravity.ts

@@ -421,6 +421,71 @@ export class GeneralManagementService extends BaseService {
 		});
 	}
 
+	/**
+	 * Queues the one-off, durable migration from embedded collection type items to standalone items, groups, and item refs. Runs as a durable orchestration (AgravityQueueFunctions) so it scales to large (100k+) data sets: collection types/blueprints are migrated in series first, then collections and assets are migrated in parallel, paged batches.
+	 * @endpoint post /migration/colltypeitems/itemrefs
+	 * @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 httpMigrateCollectionTypeItemsToRefs(
+		observe?: 'body',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<AgravityInfoResponse>;
+	public httpMigrateCollectionTypeItemsToRefs(
+		observe?: 'response',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<HttpResponse<AgravityInfoResponse>>;
+	public httpMigrateCollectionTypeItemsToRefs(
+		observe?: 'events',
+		reportProgress?: boolean,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<HttpEvent<AgravityInfoResponse>>;
+	public httpMigrateCollectionTypeItemsToRefs(
+		observe: any = 'body',
+		reportProgress: boolean = false,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<any> {
+		let localVarHeaders = this.defaultHeaders;
+
+		// 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;
+
+		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 = `/migration/colltypeitems/itemrefs`;
+		const { basePath, withCredentials } = this.configuration;
+		return this.httpClient.request<AgravityInfoResponse>('post', `${basePath}${localVarPath}`, {
+			context: localVarHttpContext,
+			responseType: <any>responseType_,
+			...(withCredentials ? { withCredentials } : {}),
+			headers: localVarHeaders,
+			observe: observe,
+			...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
+			reportProgress: reportProgress
+		});
+	}
+
 	/**
 	 * This endpoint runs the initial setup of an environment.
 	 * @endpoint post /setup