@indigina/wms-api 0.0.35 → 0.0.37

package/README.md

@@ -1,32 +1,35 @@
-## @indigina/wms-api@0.0.35
+# @indigina/wms-api@0.0.37
+
+WMS API Client for Angular applications
 
 The version of the OpenAPI document: v1
 
-### 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 @indigina/wms-api@0.0.35 --save
+```console
+npm install @indigina/wms-api@0.0.37 --save
 ```
 
 _without publishing (not recommended):_
 
-```
+```console
 npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
 ```
 
@@ -35,26 +38,26 @@ _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 @indigina/wms-api
 ```
 
 __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 { ApiModule } from '@indigina/wms-api';
 import { HttpClientModule } from '@angular/common/http';
@@ -73,7 +76,7 @@ import { HttpClientModule } from '@angular/common/http';
 export class AppModule {}
 ```
 
-```
+```typescript
 // configuring providers
 import { ApiModule, Configuration, ConfigurationParameters } from '@indigina/wms-api';
 
@@ -93,7 +96,7 @@ export function apiConfigFactory (): Configuration {
 export class AppModule {}
 ```
 
-```
+```typescript
 // configuring providers with an authentication service that manages your access tokens
 import { ApiModule, Configuration } from '@indigina/wms-api';
 
@@ -118,7 +121,7 @@ import { ApiModule, Configuration } from '@indigina/wms-api';
 export class AppModule {}
 ```
 
-```
+```typescript
 import { DefaultApi } from '@indigina/wms-api';
 
 export class AppComponent {
@@ -129,11 +132,13 @@ export class AppComponent {
 Note: The ApiModule is restricted to being instantiated once app wide.
 This is to ensure that all services are treated as singletons.
 
-#### Using multiple OpenAPI files / APIs / ApiModules
+### Using multiple OpenAPI files / APIs / ApiModules
+
 In order to use multiple `ApiModules` generated from different OpenAPI files,
 you can create an alias name when importing the modules
 in order to avoid naming conflicts:
-```
+
+```typescript
 import { ApiModule } from 'my-api-path';
 import { ApiModule as OtherApiModule } from 'my-other-api-path';
 import { HttpClientModule } from '@angular/common/http';
@@ -152,20 +157,21 @@ export class AppModule {
 }
 ```
 
-
 ### Set service base path
+
 If different than the generated base path, during app bootstrap, you can provide the base path to your service.
 
-```
+```typescript
 import { BASE_PATH } from '@indigina/wms-api';
 
 bootstrap(AppComponent, [
     { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
 ]);
 ```
+
 or
 
-```
+```typescript
 import { BASE_PATH } from '@indigina/wms-api';
 
 @NgModule({
@@ -177,11 +183,11 @@ import { BASE_PATH } from '@indigina/wms-api';
 export class AppModule {}
 ```
 
+### Using @angular/cli
 
-#### Using @angular/cli
 First extend your `src/environments/*.ts` files by adding the corresponding base path:
 
-```
+```typescript
 export const environment = {
   production: false,
   API_BASE_PATH: 'http://127.0.0.1:8080'
@@ -189,7 +195,8 @@ export const environment = {
 ```
 
 In the src/app/app.module.ts:
-```
+
+```typescript
 import { BASE_PATH } from '@indigina/wms-api';
 import { environment } from '../environments/environment';
 
@@ -217,6 +224,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),

package/api/{reports.service.d.ts → analytics.service.d.ts}

@@ -1,11 +1,11 @@
 import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { EmbedReport } from '../model/embedReport';
-import { ReportResponse } from '../model/reportResponse';
-import { SummaryDashboardReports } from '../model/summaryDashboardReports';
+import { Group } from '../model/group';
+import { Report } from '../model/report';
 import { Configuration } from '../configuration';
 import * as i0 from "@angular/core";
-export declare class ReportsService {
+export declare class AnalyticsService {
     protected httpClient: HttpClient;
     protected basePath: string;
     defaultHeaders: HttpHeaders;
@@ -14,6 +14,48 @@ export declare class ReportsService {
     constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
     private addToHttpParams;
     private addToHttpParamsRecursive;
+    /**
+     * Create a new report
+     * @param report
+     * @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.
+     */
+    createReport(report: Report, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Report>;
+    createReport(report: Report, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Report>>;
+    createReport(report: Report, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Report>>;
+    /**
+     * Delete a report
+     * @param id
+     * @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.
+     */
+    deleteReport(id: number, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<any>;
+    deleteReport(id: number, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<any>>;
+    deleteReport(id: number, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<any>>;
     /**
      * Get Castore Weekly Reports
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -35,68 +77,70 @@ export declare class ReportsService {
         transferCache?: boolean;
     }): Observable<HttpEvent<EmbedReport>>;
     /**
-     * Request WMS Client Reports
+     * Get Embedded Report Info Model
+     * @param id
+     * @param workspaceId
+     * @param powerBiTenant
      * @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.
      */
-    getClientReports(observe?: 'body', reportProgress?: boolean, options?: {
+    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<ReportResponse>;
-    getClientReports(observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<EmbedReport>;
+    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<ReportResponse>>;
-    getClientReports(observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<EmbedReport>>;
+    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<ReportResponse>>;
+    }): Observable<HttpEvent<EmbedReport>>;
     /**
-     * Request WMS DC Reports
+     * Request WMS Group Reports
+     * @param reportName
      * @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.
      */
-    getDcReports(observe?: 'body', reportProgress?: boolean, options?: {
+    getGroupReports(reportName: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<ReportResponse>;
-    getDcReports(observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<Array<Group>>;
+    getGroupReports(reportName: string, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<ReportResponse>>;
-    getDcReports(observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<Array<Group>>>;
+    getGroupReports(reportName: string, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<ReportResponse>>;
+    }): Observable<HttpEvent<Array<Group>>>;
     /**
-     * Get Embedded Report Info Model
+     * Retrieve a report by ID
      * @param id
-     * @param workspaceId
-     * @param powerBiTenant
      * @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.
      */
-    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'body', reportProgress?: boolean, options?: {
+    getReportById(id: number, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<EmbedReport>;
-    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<Report>;
+    getReportById(id: number, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<EmbedReport>>;
-    getEmbedded(id: string, workspaceId: string, powerBiTenant?: string, observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<Report>>;
+    getReportById(id: number, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<EmbedReport>>;
+    }): Observable<HttpEvent<Report>>;
     /**
      * Get Soho Manifest Reports
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -118,25 +162,49 @@ export declare class ReportsService {
         transferCache?: boolean;
     }): Observable<HttpEvent<EmbedReport>>;
     /**
-     * Request WMS summary dashboard report embedding links
+     * Update WMS Group Reports
+     * @param reportName
+     * @param group
+     * @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.
+     */
+    updateGroupReports(reportName: string, group: Array<Group>, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Array<Group>>;
+    updateGroupReports(reportName: string, group: Array<Group>, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Array<Group>>>;
+    updateGroupReports(reportName: string, group: Array<Group>, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Array<Group>>>;
+    /**
+     * Update an existing report
+     * @param id
+     * @param report
      * @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.
      */
-    getSummaryDashboardReports(observe?: 'body', reportProgress?: boolean, options?: {
+    updateReport(id: number, report: Report, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<SummaryDashboardReports>;
-    getSummaryDashboardReports(observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<Report>;
+    updateReport(id: number, report: Report, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<SummaryDashboardReports>>;
-    getSummaryDashboardReports(observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<Report>>;
+    updateReport(id: number, report: Report, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<SummaryDashboardReports>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ReportsService, [null, { optional: true; }, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ReportsService>;
+    }): Observable<HttpEvent<Report>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AnalyticsService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AnalyticsService>;
 }

package/api/api.d.ts

@@ -1,11 +1,13 @@
+export * from './analytics.service';
+import { AnalyticsService } from './analytics.service';
 export * from './dcs.service';
 import { DcsService } from './dcs.service';
 export * from './health.service';
 import { HealthService } from './health.service';
 export * from './permissions.service';
 import { PermissionsService } from './permissions.service';
-export * from './reports.service';
-import { ReportsService } from './reports.service';
+export * from './summary.service';
+import { SummaryService } from './summary.service';
 export * from './user.service';
 import { UserService } from './user.service';
-export declare const APIS: (typeof DcsService | typeof HealthService | typeof PermissionsService | typeof ReportsService | typeof UserService)[];
+export declare const APIS: (typeof AnalyticsService | typeof DcsService | typeof HealthService | typeof PermissionsService | typeof SummaryService | typeof UserService)[];

package/api/summary.service.d.ts

@@ -0,0 +1,37 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { SummaryDashboardReports } from '../model/summaryDashboardReports';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export declare class SummaryService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Request WMS summary dashboard report embedding links
+     * @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.
+     */
+    getSummaryDashboardReports(observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<SummaryDashboardReports>;
+    getSummaryDashboardReports(observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<SummaryDashboardReports>>;
+    getSummaryDashboardReports(observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<SummaryDashboardReports>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SummaryService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SummaryService>;
+}