@prowodo/angular-client 1.0.2 → 1.1.0

package/README.md

@@ -1,185 +1,49 @@
-# @prowodo/angular-client@1.0.2
+# @prowodo/angular-client
 
-PROject WOrk DOne
+Typed Angular client for [ProWoDo](https://prowodo.com).
 
-The version of the OpenAPI document: 1.0.0
+## Install
 
-## Building
-
-To install the required dependencies and to build the typescript sources run:
-
-```console
-npm install
-npm run build
-```
-
-## Publishing
-
-First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!)
-
-## Consuming
-
-Navigate to the folder of your consuming project and run one of next commands.
-
-_published:_
-
-```console
-npm install @prowodo/angular-client@1.0.2 --save
-```
-
-_without publishing (not recommended):_
-
-```console
-npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
-```
-
-_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
-
-_using `npm link`:_
-
-In PATH_TO_GENERATED_PACKAGE/dist:
-
-```console
-npm link
-```
-
-In your project:
-
-```console
-npm link @prowodo/angular-client
-```
-
-__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
-
-In your Angular project:
-
-```typescript
-
-import { ApplicationConfig } from '@angular/core';
-import { provideHttpClient } from '@angular/common/http';
-import { provideApi } from '@prowodo/angular-client';
-
-export const appConfig: ApplicationConfig = {
-    providers: [
-        // ...
-        provideHttpClient(),
-        provideApi()
-    ],
-};
-```
-
-**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 { ApiModule } from '@prowodo/angular-client';
-```
-
-If different from the generated base path, during app bootstrap, you can provide the base path to your service.
-
-```typescript
-import { ApplicationConfig } from '@angular/core';
-import { provideHttpClient } from '@angular/common/http';
-import { provideApi } from '@prowodo/angular-client';
-
-export const appConfig: ApplicationConfig = {
-    providers: [
-        // ...
-        provideHttpClient(),
-        provideApi('http://localhost:9999')
-    ],
-};
+```bash
+npm install @prowodo/angular-client
 ```
 
-```typescript
-// with a custom configuration
-import { ApplicationConfig } from '@angular/core';
-import { provideHttpClient } from '@angular/common/http';
-import { provideApi } from '@prowodo/angular-client';
-
-export const appConfig: ApplicationConfig = {
-    providers: [
-        // ...
-        provideHttpClient(),
-        provideApi({
-            withCredentials: true,
-            username: 'user',
-            password: 'password'
-        })
-    ],
-};
-```
+## Quick start
 
 ```typescript
-// with factory building a custom configuration
-import { ApplicationConfig } from '@angular/core';
-import { provideHttpClient } from '@angular/common/http';
-import { provideApi, Configuration } from '@prowodo/angular-client';
-
-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
-        }
-    ],
-};
-```
-
-### 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:
+import { ApiModule, Configuration, TasksService } from '@prowodo/angular-client';
+
+@NgModule({
+  imports: [
+    ApiModule.forRoot(() => new Configuration({
+      basePath: 'https://backend.prowodo.com',
+      credentials: {
+        firebaseAuth: () => localStorage.getItem('FToken') ?? '',
+      },
+    })),
+  ],
+})
+export class AppModule {}
 
-```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';
+// In a component:
+constructor(private tasks: TasksService) {}
 
-export const appConfig: ApplicationConfig = {
-    providers: [
-        // ...
-        provideHttpClient(),
-        provideUserApi(environment.basePath),
-        provideAdminApi(environment.basePath),
-    ],
-};
+ngOnInit() {
+  this.tasks.tasksList().subscribe(tasks => console.log(tasks));
+}
 ```
 
-### Customizing path parameter encoding
+## API reference
 
-Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
-and Dates for format 'date-time' are encoded correctly.
+The client is generated from the ProWoDo OpenAPI schema. Browse the runtime schema at `https://backend.prowodo.com/api/schema/swagger-ui/`.
 
-Other styles (e.g. "matrix") are not that easy to encode
-and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).
+## Versioning
 
-To implement your own parameter encoding (or call another library),
-pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object
-(see [General Usage](#general-usage) above).
+- **Patch** (1.0.x): additive non-breaking — new endpoint, new optional field/param
+- **Major** (x.0.0): breaking — removed/renamed endpoint, removed field, changed type
 
-Example value for use in your Configuration-Provider:
+See [CHANGELOG.md](https://github.com/i3idea/prowodo-api-clients/blob/main/CHANGELOG.md) in the repo for release notes.
 
-```typescript
-new Configuration({
-    encodeParam: (param: Param) => myFancyParamEncoder(param),
-})
-```
+## License
 
-[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
-[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
-[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander
+MIT

package/fesm2022/prowodo-angular-client.mjs

@@ -3509,6 +3509,82 @@ class ApiService extends BaseService {
             reportProgress: reportProgress
         });
     }
+    ticketsStatus(requestParameters, observe = 'body', reportProgress = false, options) {
+        const ticketUuid = requestParameters?.ticketUuid;
+        if (ticketUuid === null || ticketUuid === undefined) {
+            throw new Error('Required parameter ticketUuid was null or undefined when calling ticketsStatus.');
+        }
+        let localVarHeaders = this.defaultHeaders;
+        const localVarHttpHeaderAcceptSelected = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept([
+            'application/json'
+        ]);
+        if (localVarHttpHeaderAcceptSelected !== undefined) {
+            localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
+        }
+        const localVarHttpContext = options?.context ?? new HttpContext();
+        const localVarTransferCache = options?.transferCache ?? true;
+        let responseType_ = 'json';
+        if (localVarHttpHeaderAcceptSelected) {
+            if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+                responseType_ = 'text';
+            }
+            else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+                responseType_ = 'json';
+            }
+            else {
+                responseType_ = 'blob';
+            }
+        }
+        let localVarPath = `/api/tickets/status/${this.configuration.encodeParam({ name: "ticketUuid", value: ticketUuid, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: "uuid" })}/`;
+        const { basePath, withCredentials } = this.configuration;
+        return this.httpClient.request('get', `${basePath}${localVarPath}`, {
+            context: localVarHttpContext,
+            responseType: responseType_,
+            ...(withCredentials ? { withCredentials } : {}),
+            headers: localVarHeaders,
+            observe: observe,
+            ...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
+            reportProgress: reportProgress
+        });
+    }
+    ticketsStatus2(requestParameters, observe = 'body', reportProgress = false, options) {
+        const ticketUuid = requestParameters?.ticketUuid;
+        if (ticketUuid === null || ticketUuid === undefined) {
+            throw new Error('Required parameter ticketUuid was null or undefined when calling ticketsStatus2.');
+        }
+        let localVarHeaders = this.defaultHeaders;
+        const localVarHttpHeaderAcceptSelected = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept([
+            'application/json'
+        ]);
+        if (localVarHttpHeaderAcceptSelected !== undefined) {
+            localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
+        }
+        const localVarHttpContext = options?.context ?? new HttpContext();
+        const localVarTransferCache = options?.transferCache ?? true;
+        let responseType_ = 'json';
+        if (localVarHttpHeaderAcceptSelected) {
+            if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+                responseType_ = 'text';
+            }
+            else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+                responseType_ = 'json';
+            }
+            else {
+                responseType_ = 'blob';
+            }
+        }
+        let localVarPath = `/api/ticketsstatus/${this.configuration.encodeParam({ name: "ticketUuid", value: ticketUuid, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: "uuid" })}/`;
+        const { basePath, withCredentials } = this.configuration;
+        return this.httpClient.request('get', `${basePath}${localVarPath}`, {
+            context: localVarHttpContext,
+            responseType: responseType_,
+            ...(withCredentials ? { withCredentials } : {}),
+            headers: localVarHeaders,
+            observe: observe,
+            ...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
+            reportProgress: reportProgress
+        });
+    }
     ticketsSubmit(requestParameters, observe = 'body', reportProgress = false, options) {
         const ticketSubmit = requestParameters?.ticketSubmit;
         if (ticketSubmit === null || ticketSubmit === undefined) {
@@ -10621,6 +10697,16 @@ const StatusEnum = {
  * Do not edit the class manually.
  */
 
+/**
+ * ProWoDo API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
 /**
  * ProWoDo API
  *