@agravity/private 9.4.0 → 10.0.1

package/.openapi-generator/FILES

@@ -1,8 +1,9 @@
 .gitignore
 .openapi-generator-ignore
 README.md
+api.base.service.ts
 api.module.ts
-api/aISettingsManagement.agravity.ts
+api/aIOperations.agravity.ts
 api/api.ts
 api/assetIconRuleManagement.agravity.ts
 api/assetManagement.agravity.ts
@@ -29,6 +30,7 @@ api/iccProfileManagement.agravity.ts
 api/listBlobs.agravity.ts
 api/listQueues.agravity.ts
 api/listTables.agravity.ts
+api/notificationManagement.agravity.ts
 api/permissionsManagement.agravity.ts
 api/portalManagement.agravity.ts
 api/portalsUsersManagement.agravity.ts
@@ -36,6 +38,7 @@ api/publishing.agravity.ts
 api/quickshareManagement.agravity.ts
 api/savedSearchManagement.agravity.ts
 api/searchManagement.agravity.ts
+api/searchSettingsOperations.agravity.ts
 api/secureUpload.agravity.ts
 api/signalRConnectionManagement.agravity.ts
 api/staticDefinedListManagement.agravity.ts
@@ -57,10 +60,11 @@ model/agravityUser.agravity.ts
 model/agravityUserDto.agravity.ts
 model/agravityUserOnlineStatus.agravity.ts
 model/agravityVersion.agravity.ts
+model/aiAsset.agravity.ts
 model/aiFieldGeneration.agravity.ts
-model/aiGroup.agravity.ts
-model/aiGroupEntity.agravity.ts
+model/aiModelDeployment.agravity.ts
 model/aiSettings.agravity.ts
+model/aiTypeSettings.agravity.ts
 model/allWebAppData.agravity.ts
 model/apiKeyResponse.agravity.ts
 model/appConfigTableEntity.agravity.ts
@@ -109,6 +113,7 @@ model/infoEntitySkillEnhanced.agravity.ts
 model/metadata.agravity.ts
 model/models.ts
 model/moveCollectionBody.agravity.ts
+model/notificationSettingDto.agravity.ts
 model/permissionChange.agravity.ts
 model/permissionEntity.agravity.ts
 model/permissionSetting.agravity.ts
@@ -135,6 +140,7 @@ model/searchAdminStatus.agravity.ts
 model/searchFacet.agravity.ts
 model/searchFacetEntity.agravity.ts
 model/searchResult.agravity.ts
+model/searchSettings.agravity.ts
 model/searchableItem.agravity.ts
 model/secureUploadEntity.agravity.ts
 model/sharedAllowedFormat.agravity.ts
@@ -155,5 +161,7 @@ model/workspace.agravity.ts
 ng-package.json
 package.json
 param.ts
+provide-api.ts
 tsconfig.json
 variables.ts
+

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.9.0
+7.15.0

package/README.md

@@ -1,34 +1,35 @@
-## @agravity/private@9.4.0
+# @agravity/private@10.0.1
 
 <h1>Agravity API Reference</h1>This is the full API description of Agravity GmbH.<br/><h2>Resources</h2><ul> <li>Collection type management</li> <li>Collections management</li> <li>Assets management</li> <li>Assets operations</li> <li>Assets publishing</li> <li>Assets versioning</li> <li>Sharing collection</li> <li>Secure upload to collection</li> <li>Download ZIP</li> <li>Search</li> <li>General management</li> <li>Authentication management</li> <li>Blob management</li> <li>Queue management</li> <li>Structure management</li> <li>Bulk get all data from collection / collection type</li></ul><h2> Operations</h2>Agravity API performs the following operations:<ul> <li>Create / update / list / delete collection types</li> <li>Create / update / list / delete collections</li> <li>Create / update / list / delete assets</li> <li>Operations on assets like: move to collection, renew asset(through queue pipe), rotate, resize, etc.</li> <li>Publish / de-publish an asset or specific variants of an asset</li> <li>Create / delete version of asset</li> <li>Bulk download of Assets</li> <li>Search for assets or collections</li> <li>Authenticated access like e.g. getting access to blobs directly (for upload on folder or generate SAS token)</li> <li>List / delete blobs</li> <li>Create structures based on blob storage input</li></ul><br/>Copyright © Agravity GmbH 2025. All Rights Reserved
 
-The version of the OpenAPI document: 9.4.0
+The version of the OpenAPI document: 10.0.1
 
-### Building
+## Building
 
 To install the required dependencies and to build the typescript sources run:
-```
+
+```console
 npm install
 npm run build
 ```
 
-### publishing
+## Publishing
 
-First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!)
+First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!)
 
-### consuming
+## Consuming
 
 Navigate to the folder of your consuming project and run one of next commands.
 
 _published:_
 
-```
-npm install @agravity/private@9.4.0 --save
+```console
+npm install @agravity/private@10.0.1 --save
 ```
 
 _without publishing (not recommended):_
 
-```
+```console
 npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
 ```
 
@@ -37,173 +38,126 @@ _It's important to take the tgz file, otherwise you'll get trouble with links on
 _using `npm link`:_
 
 In PATH_TO_GENERATED_PACKAGE/dist:
-```
+
+```console
 npm link
 ```
 
 In your project:
-```
+
+```console
 npm link @agravity/private
 ```
 
 __Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
-Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.
+Please refer to this issue <https://github.com/angular/angular-cli/issues/8284> for a solution / workaround.
 Published packages are not effected by this issue.
 
-
-#### General usage
+### General usage
 
 In your Angular project:
 
+```typescript
 
-```
-// without configuring providers
-import { AgravityApiModule } from '@agravity/private';
-import { HttpClientModule } from '@angular/common/http';
-
-@NgModule({
-    imports: [
-        AgravityApiModule,
-        // make sure to import the HttpClientModule in the AppModule only,
-        // see https://github.com/angular/angular/issues/20575
-        HttpClientModule
-    ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers
-import { AgravityApiModule, AgravityConfiguration, AgravityConfigurationParameters } from '@agravity/private';
-
-export function apiConfigFactory (): AgravityConfiguration {
-  const params: AgravityConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new AgravityConfiguration(params);
-}
-
-@NgModule({
-    imports: [ AgravityApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers with an authentication service that manages your access tokens
-import { AgravityApiModule, AgravityConfiguration } from '@agravity/private';
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@agravity/private';
 
-@NgModule({
-    imports: [ AgravityApiModule ],
-    declarations: [ AppComponent ],
+export const appConfig: ApplicationConfig = {
     providers: [
-      {
-        provide: AgravityConfiguration,
-        useFactory: (authService: AuthService) => new AgravityConfiguration(
-          {
-            basePath: environment.apiUrl,
-            accessToken: authService.getAccessToken.bind(authService)
-          }
-        ),
-        deps: [AuthService],
-        multi: false
-      }
+        // ...
+        provideHttpClient(),
+        provideApi()
     ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
+};
 ```
-import { DefaultApi } from '@agravity/private';
 
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
+**NOTE**
+If you're still using `AppModule` and haven't [migrated](https://angular.dev/reference/migrations/standalone) yet, you can still import an Angular module:
+```typescript
+import { AgravityApiModule } from '@agravity/private';
 ```
 
-Note: The AgravityApiModule is restricted to being instantiated once app wide.
-This is to ensure that all services are treated as singletons.
-
-#### Using multiple OpenAPI files / APIs / AgravityApiModules
-In order to use multiple `AgravityApiModules` generated from different OpenAPI files,
-you can create an alias name when importing the modules
-in order to avoid naming conflicts:
-```
-import { AgravityApiModule } from 'my-api-path';
-import { AgravityApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
+If different from the generated base path, during app bootstrap, you can provide the base path to your service.
 
-@NgModule({
-  imports: [
-    AgravityApiModule,
-    OtherApiModule,
-    // make sure to import the HttpClientModule in the AppModule only,
-    // see https://github.com/angular/angular/issues/20575
-    HttpClientModule
-  ]
-})
-export class AppModule {
+```typescript
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@agravity/private';
 
-}
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi('http://localhost:9999')
+    ],
+};
 ```
 
+```typescript
+// with a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@agravity/private';
 
-### Set service base path
-If different than the generated base path, during app bootstrap, you can provide the base path to your service.
-
-```
-import { BASE_PATH } from '@agravity/private';
-
-bootstrap(AppComponent, [
-    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
-]);
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi({
+            withCredentials: true,
+            username: 'user',
+            password: 'password'
+        })
+    ],
+};
 ```
-or
 
-```
-import { BASE_PATH } from '@agravity/private';
+```typescript
+// with factory building a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi, AgravityConfiguration } from '@agravity/private';
 
-@NgModule({
-    imports: [],
-    declarations: [ AppComponent ],
-    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        {
+            provide: AgravityConfiguration,
+            useFactory: (authService: AuthService) => new AgravityConfiguration({
+                    basePath: 'http://localhost:9999',
+                    withCredentials: true,
+                    username: authService.getUsername(),
+                    password: authService.getPassword(),
+            }),
+            deps: [AuthService],
+            multi: false
+        }
+    ],
+};
 ```
 
+### Using multiple OpenAPI files / APIs
 
-#### Using @angular/cli
-First extend your `src/environments/*.ts` files by adding the corresponding base path:
-
-```
-export const environment = {
-  production: false,
-  API_BASE_PATH: 'http://127.0.0.1:8080'
-};
-```
+In order to use multiple APIs generated from different OpenAPI files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
 
-In the src/app/app.module.ts:
-```
-import { BASE_PATH } from '@agravity/private';
+```typescript
+import { provideApi as provideUserApi } from 'my-user-api-path';
+import { provideApi as provideAdminApi } from 'my-admin-api-path';
+import { HttpClientModule } from '@angular/common/http';
 import { environment } from '../environments/environment';
 
-@NgModule({
-  declarations: [
-    AppComponent
-  ],
-  imports: [ ],
-  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
-  bootstrap: [ AppComponent ]
-})
-export class AppModule { }
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideUserApi(environment.basePath),
+        provideAdminApi(environment.basePath),
+    ],
+};
 ```
 
 ### Customizing path parameter encoding
@@ -219,6 +173,7 @@ pass an arrow-function or method-reference to the `encodeParam` property of the
 (see [General Usage](#general-usage) above).
 
 Example value for use in your Configuration-Provider:
+
 ```typescript
 new Configuration({
     encodeParam: (param: Param) => myFancyParamEncoder(param),