@indigina/wms-api 0.0.36 → 0.0.38

package/README.md

@@ -1,32 +1,35 @@
-## @indigina/wms-api@0.0.36
+# @indigina/wms-api@0.0.38
+
+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.36 --save
+```console
+npm install @indigina/wms-api@0.0.38 --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/api.d.ts

@@ -1,13 +1,21 @@
 export * from './analytics.service';
 import { AnalyticsService } from './analytics.service';
+export * from './companies.service';
+import { CompaniesService } from './companies.service';
 export * from './dcs.service';
 import { DcsService } from './dcs.service';
+export * from './deliveries.service';
+import { DeliveriesService } from './deliveries.service';
+export * from './deliveryItems.service';
+import { DeliveryItemsService } from './deliveryItems.service';
 export * from './health.service';
 import { HealthService } from './health.service';
+export * from './notes.service';
+import { NotesService } from './notes.service';
 export * from './permissions.service';
 import { PermissionsService } from './permissions.service';
 export * from './summary.service';
 import { SummaryService } from './summary.service';
 export * from './user.service';
 import { UserService } from './user.service';
-export declare const APIS: (typeof AnalyticsService | typeof DcsService | typeof HealthService | typeof PermissionsService | typeof SummaryService | typeof UserService)[];
+export declare const APIS: (typeof AnalyticsService | typeof CompaniesService | typeof DcsService | typeof DeliveriesService | typeof DeliveryItemsService | typeof HealthService | typeof NotesService | typeof PermissionsService | typeof SummaryService | typeof UserService)[];

package/api/companies.service.d.ts

@@ -0,0 +1,63 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Companies } from '../model/companies';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export declare class CompaniesService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Getting  clients
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getClients($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Companies>;
+    getClients($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Companies>>;
+    getClients($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Companies>>;
+    /**
+     * Getting  suppliers
+     * @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.
+     */
+    getSuppliers(id: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Companies>;
+    getSuppliers(id: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Companies>>;
+    getSuppliers(id: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Companies>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CompaniesService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CompaniesService>;
+}

package/api/deliveries.service.d.ts

@@ -0,0 +1,69 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Deliveries } from '../model/deliveries';
+import { OrderStatus } from '../model/orderStatus';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export declare class DeliveriesService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Getting  deliveries
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getDeliveries($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Deliveries>;
+    getDeliveries($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Deliveries>>;
+    getDeliveries($skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Deliveries>>;
+    /**
+     * Getting  deliveries
+     * @param deliveryStatus
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getDeliveriesByOrderStatus(deliveryStatus: OrderStatus, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Deliveries>;
+    getDeliveriesByOrderStatus(deliveryStatus: OrderStatus, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Deliveries>>;
+    getDeliveriesByOrderStatus(deliveryStatus: OrderStatus, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Deliveries>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DeliveriesService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DeliveriesService>;
+}

package/api/deliveryItems.service.d.ts

@@ -0,0 +1,43 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { DeliveryItems } from '../model/deliveryItems';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export declare class DeliveryItemsService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Getting  delivery items
+     * @param id
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getDeliveryItems(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<DeliveryItems>;
+    getDeliveryItems(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<DeliveryItems>>;
+    getDeliveryItems(id: string, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<DeliveryItems>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DeliveryItemsService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DeliveryItemsService>;
+}

package/api/notes.service.d.ts

@@ -0,0 +1,96 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Note } from '../model/note';
+import { NoteCategory } from '../model/noteCategory';
+import { NoteSourceType } from '../model/noteSourceType';
+import { Notes } from '../model/notes';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export declare class NotesService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Create new note
+     * @param note
+     * @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.
+     */
+    createNote(note?: Note, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Note>;
+    createNote(note?: Note, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Note>>;
+    createNote(note?: Note, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Note>>;
+    /**
+     * Getting  notes
+     * @param sourceId
+     * @param type
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getNotes(sourceId: string, type: NoteSourceType, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Notes>;
+    getNotes(sourceId: string, type: NoteSourceType, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Notes>>;
+    getNotes(sourceId: string, type: NoteSourceType, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Notes>>;
+    /**
+     * Getting notes by category
+     * @param sourceId
+     * @param type
+     * @param category
+     * @param $skip
+     * @param $top
+     * @param $orderby
+     * @param $filter
+     * @param $search
+     * @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.
+     */
+    getNotesByCategory(sourceId: string, type: NoteSourceType, category: NoteCategory, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Notes>;
+    getNotesByCategory(sourceId: string, type: NoteSourceType, category: NoteCategory, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Notes>>;
+    getNotesByCategory(sourceId: string, type: NoteSourceType, category: NoteCategory, $skip?: number, $top?: number, $orderby?: string, $filter?: string, $search?: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Notes>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NotesService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NotesService>;
+}