@veeroute/lss-account-angular 7.21.2852 → 7.22.2904

package/README.md

@@ -1,162 +1,163 @@
-# @veeroute/lss-account-angular@7.21.2852
+# @veeroute/lss-account-angular@7.22.2904
 
-## General usage
+# Description  Veeroute Account Panel.  ## Entity relationship diagram  ![erd](../uml/account.svg) 
 
-In your Angular project:
+The version of the OpenAPI document: 7.22.2904
 
+## Building
 
-```
-// without configuring providers
-import { LssAccountApiModule } from '@veeroute/lss-account-angular';
-import { HttpClientModule } from '@angular/common/http';
+To install the required dependencies and to build the typescript sources run:
 
-@NgModule({
-    imports: [
-        LssAccountApiModule,
-        // 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 {}
+```console
+npm install
+npm run build
 ```
 
-```typescript
-// configuring providers
-import { LssAccountApiModule, Configuration, ConfigurationParameters } from '@veeroute/lss-account-angular';
-
-export function apiConfigFactory (): Configuration {
-  const params: ConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new Configuration(params);
-}
-
-@NgModule({
-    imports: [ LssAccountApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
+## Publishing
 
-```typescript
-// configuring providers with an authentication service that manages your access tokens
-import { LssAccountApiModule, Configuration } from '@veeroute/lss-account-angular';
+First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!)
 
-@NgModule({
-    imports: [ LssAccountApiModule ],
-    declarations: [ AppComponent ],
-    providers: [
-      {
-        provide: Configuration,
-        useFactory: (authService: AuthService) => new Configuration(
-          {
-            basePath: environment.apiUrl,
-            accessToken: authService.getAccessToken.bind(authService)
-          }
-        ),
-        deps: [AuthService],
-        multi: false
-      }
-    ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+## Consuming
+
+Navigate to the folder of your consuming project and run one of next commands.
+
+_published:_
+
+```console
+npm install @veeroute/lss-account-angular@7.22.2904 --save
 ```
 
-```typescript
-import { DefaultApi } from '@veeroute/lss-account-angular';
+_without publishing (not recommended):_
 
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
+```console
+npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
 ```
 
-Note: The LssAccountApiModule is restricted to being instantiated once app wide.
-This is to ensure that all services are treated as singletons.
+_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
 
-### Using multiple OpenAPI files / APIs / LssAccountApiModules
+_using `npm link`:_
 
-In order to use multiple `LssAccountApiModules` generated from different OpenAPI files,
-you can create an alias name when importing the modules
-in order to avoid naming conflicts:
+In PATH_TO_GENERATED_PACKAGE/dist:
 
-```typescript
-import { LssAccountApiModule } from 'my-api-path';
-import { LssAccountApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
+```console
+npm link
+```
 
-@NgModule({
-  imports: [
-    LssAccountApiModule,
-    OtherApiModule,
-    // make sure to import the HttpClientModule in the AppModule only,
-    // see https://github.com/angular/angular/issues/20575
-    HttpClientModule
-  ]
-})
-export class AppModule {
+In your project:
 
-}
+```console
+npm link @veeroute/lss-account-angular
 ```
 
-### Set service base path
+__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.
+Published packages are not effected by this issue.
+
+### General usage
 
-If different than the generated base path, during app bootstrap, you can provide the base path to your service.
+In your Angular project:
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-account-angular';
 
-bootstrap(AppComponent, [
-    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
-]);
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-account-angular';
+
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi()
+    ],
+};
 ```
 
-or
+**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 { LssAccountApiModule } from '@veeroute/lss-account-angular';
+```
+
+If different from the generated base path, during app bootstrap, you can provide the base path to your service.
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-account-angular';
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-account-angular';
 
-@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(),
+        provideApi('http://localhost:9999')
+    ],
+};
 ```
 
-### Using @angular/cli
+```typescript
+// with a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-account-angular';
 
-First extend your `src/environments/*.ts` files by adding the corresponding base path:
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi({
+            withCredentials: true,
+            username: 'user',
+            password: 'password'
+        })
+    ],
+};
+```
 
 ```typescript
-export const environment = {
-  production: false,
-  API_BASE_PATH: 'http://127.0.0.1:8080'
+// with factory building a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi, Configuration } from '@veeroute/lss-account-angular';
+
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        {
+            provide: Configuration,
+            useFactory: (authService: AuthService) => new Configuration({
+                    basePath: 'http://localhost:9999',
+                    withCredentials: true,
+                    username: authService.getUsername(),
+                    password: authService.getPassword(),
+            }),
+            deps: [AuthService],
+            multi: false
+        }
+    ],
 };
 ```
 
-In the src/app/app.module.ts:
+### Using multiple OpenAPI files / APIs
+
+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:
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-account-angular';
+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

package/api/auditService.d.ts

@@ -1,18 +1,13 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { AccountAuditResultAccount } from '../model/accountAuditResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { AuditServiceInterface, ReadAuditRequestParams } from './auditServiceInterface';
 import * as i0 from "@angular/core";
-export declare class AuditService implements AuditServiceInterface {
+export declare class AuditService extends BaseService implements AuditServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Actions for the period
      * User actions for the period.  If the period is not specified, data for the current day is returned - from the beginning of the day to the current time inclusive. If the beginning of the time period is not specified, data from the beginning of the current day is returned. If the end of the time period is not specified, data up to the current time is returned.

package/api/auditServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/authService.d.ts

@@ -1,18 +1,13 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { TokenValidationResultAccount } from '../model/tokenValidationResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { AuthServiceInterface, ChangePasswordRequestParams, RunTokenGenerationRequestParams, RunTokenValidationRequestParams } from './authServiceInterface';
 import * as i0 from "@angular/core";
-export declare class AuthService implements AuthServiceInterface {
+export declare class AuthService extends BaseService implements AuthServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Change password
      * Change password and get new token.

package/api/authServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/dataService.d.ts

@@ -1,17 +1,12 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { DataServiceInterface, ReadDataRequestParams } from './dataServiceInterface';
 import * as i0 from "@angular/core";
-export declare class DataService implements DataServiceInterface {
+export declare class DataService extends BaseService implements DataServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Reading input data
      * Receiving an incoming request by `tracedata.process_code`.

package/api/dataServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/infoService.d.ts

@@ -1,18 +1,13 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { UserAccount } from '../model/user';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { InfoServiceInterface, UpdateInfoRequestParams } from './infoServiceInterface';
 import * as i0 from "@angular/core";
-export declare class InfoService implements InfoServiceInterface {
+export declare class InfoService extends BaseService implements InfoServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Account information
      * Getting a account information.

package/api/infoServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/quotaService.d.ts

@@ -1,18 +1,13 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { QuotasResultAccount } from '../model/quotasResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { QuotaServiceInterface } from './quotaServiceInterface';
 import * as i0 from "@angular/core";
-export declare class QuotaService implements QuotaServiceInterface {
+export declare class QuotaService extends BaseService implements QuotaServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Obtaining the quotas
      * Obtaining the quotas for the user.

package/api/quotaServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/statisticsService.d.ts

@@ -1,18 +1,13 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { UserStatisticsAccount } from '../model/userStatistics';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { StatisticsServiceInterface, GenerateReportRequestParams, GenerateStatisticsRequestParams } from './statisticsServiceInterface';
 import * as i0 from "@angular/core";
-export declare class StatisticsService implements StatisticsServiceInterface {
+export declare class StatisticsService extends BaseService implements StatisticsServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Report creating
      * Creating report with usage statistics. If the period is not specified, records are returned from the beginning of the month to the present day (excluding). If no `from` datetime is specified, data are returned from the beginning of the month. If no `to` datetime is specified, data are returned be the the present day (excluding). Empty service and process type fields mean returning statistics for all services and process types.

package/api/statisticsServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/systemService.d.ts

@@ -1,19 +1,14 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { CheckResultAccount } from '../model/checkResult';
 import { VersionResultAccount } from '../model/versionResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { SystemServiceInterface, FileRequestParams } from './systemServiceInterface';
 import * as i0 from "@angular/core";
-export declare class SystemService implements SystemServiceInterface {
+export declare class SystemService extends BaseService implements SystemServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Checking the availability
      * Checking the service availability.

package/api/systemServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Account [AC]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api.base.service.d.ts

@@ -0,0 +1,21 @@
+/**
+ * VRt.Account [AC]
+ *
+ * The version of the OpenAPI document: 7.22.2904
+ * Contact: servicedesk@veeroute.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * Do not edit the class manually.
+ */
+import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { Configuration } from './configuration';
+export declare class BaseService {
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(basePath?: string | string[], configuration?: Configuration);
+    protected canConsumeForm(consumes: string[]): boolean;
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep?: boolean): HttpParams;
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep?: boolean): HttpParams;
+}

package/configuration.d.ts

@@ -1,4 +1,4 @@
-import { HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
 export interface ConfigurationParameters {
     /**
@@ -71,7 +71,7 @@ export declare class Configuration {
     credentials: {
         [key: string]: string | (() => string | undefined);
     };
-    constructor(configurationParameters?: ConfigurationParameters);
+    constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder, password, username, withCredentials }?: ConfigurationParameters);
     /**
      * Select the correct content-type to use for a request.
      * Uses {@link Configuration#isJsonMime} to determine the correct content-type.
@@ -100,5 +100,7 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
     lookupCredential(key: string): string | undefined;
+    addCredentialToHeaders(credentialKey: string, headerName: string, headers: HttpHeaders, prefix?: string): HttpHeaders;
+    addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams;
     private defaultEncodeParam;
 }