@monfilon/api-client 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,322 @@
+.gitignore
+.openapi-generator-ignore
+README.md
+api.module.ts
+api/api.ts
+api/assetAccounts.service.ts
+api/assetAccounts.serviceInterface.ts
+api/assets.service.ts
+api/assets.serviceInterface.ts
+api/averageBaskets.service.ts
+api/averageBaskets.serviceInterface.ts
+api/bfrSettings.service.ts
+api/bfrSettings.serviceInterface.ts
+api/budgetFinancings.service.ts
+api/budgetFinancings.serviceInterface.ts
+api/budgets.service.ts
+api/budgets.serviceInterface.ts
+api/businessPlanSections.service.ts
+api/businessPlanSections.serviceInterface.ts
+api/charges.service.ts
+api/charges.serviceInterface.ts
+api/compositeBaskets.service.ts
+api/compositeBaskets.serviceInterface.ts
+api/configSlots.service.ts
+api/configSlots.serviceInterface.ts
+api/convertibles.service.ts
+api/convertibles.serviceInterface.ts
+api/currentAccounts.service.ts
+api/currentAccounts.serviceInterface.ts
+api/default.service.ts
+api/default.serviceInterface.ts
+api/employees.service.ts
+api/employees.serviceInterface.ts
+api/financingSources.service.ts
+api/financingSources.serviceInterface.ts
+api/fiscalYears.service.ts
+api/fiscalYears.serviceInterface.ts
+api/generatorEntities.service.ts
+api/generatorEntities.serviceInterface.ts
+api/laborInputs.service.ts
+api/laborInputs.serviceInterface.ts
+api/memberships.service.ts
+api/memberships.serviceInterface.ts
+api/notifications.service.ts
+api/notifications.serviceInterface.ts
+api/optionPools.service.ts
+api/optionPools.serviceInterface.ts
+api/persons.service.ts
+api/persons.serviceInterface.ts
+api/priceLists.service.ts
+api/priceLists.serviceInterface.ts
+api/prices.service.ts
+api/prices.serviceInterface.ts
+api/products.service.ts
+api/products.serviceInterface.ts
+api/projects.service.ts
+api/projects.serviceInterface.ts
+api/rawMaterials.service.ts
+api/rawMaterials.serviceInterface.ts
+api/reports.service.ts
+api/reports.serviceInterface.ts
+api/rounds.service.ts
+api/rounds.serviceInterface.ts
+api/salesInputs.service.ts
+api/salesInputs.serviceInterface.ts
+api/salesItems.service.ts
+api/salesItems.serviceInterface.ts
+api/salesModels.service.ts
+api/salesModels.serviceInterface.ts
+api/salesScenarios.service.ts
+api/salesScenarios.serviceInterface.ts
+api/salesStages.service.ts
+api/salesStages.serviceInterface.ts
+api/salesVolumes.service.ts
+api/salesVolumes.serviceInterface.ts
+api/segments.service.ts
+api/segments.serviceInterface.ts
+api/services.service.ts
+api/services.serviceInterface.ts
+api/shareLots.service.ts
+api/shareLots.serviceInterface.ts
+api/shareholderGroups.service.ts
+api/shareholderGroups.serviceInterface.ts
+api/shareholders.service.ts
+api/shareholders.serviceInterface.ts
+api/slotOptions.service.ts
+api/slotOptions.serviceInterface.ts
+api/targets.service.ts
+api/targets.serviceInterface.ts
+configuration.ts
+encoder.ts
+git_push.sh
+index.ts
+model/assetAccountsGet200ResponseInner.ts
+model/models.ts
+model/notificationsGet200ResponseInner.ts
+model/notificationsUnreadCountGet200Response.ts
+model/projectsGet200ResponseInner.ts
+model/projectsIdGet200Response.ts
+model/projectsIdPatch200Response.ts
+model/projectsIdPatchRequest.ts
+model/projectsPost201Response.ts
+model/projectsPostRequest.ts
+model/projectsProjectIdAssetsGet200ResponseInner.ts
+model/projectsProjectIdAssetsIdGet200Response.ts
+model/projectsProjectIdAssetsIdPatchRequest.ts
+model/projectsProjectIdAssetsPost201Response.ts
+model/projectsProjectIdAssetsPost422Response.ts
+model/projectsProjectIdAssetsPostRequest.ts
+model/projectsProjectIdBfrSettingGet200Response.ts
+model/projectsProjectIdBfrSettingPatch200Response.ts
+model/projectsProjectIdBfrSettingPatchRequest.ts
+model/projectsProjectIdBfrSettingPost201Response.ts
+model/projectsProjectIdBfrSettingPostRequest.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsGet200ResponseInner.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsIdPatch200Response.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsIdPatchRequest.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsPost201Response.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsPost422Response.ts
+model/projectsProjectIdBudgetsBudgetIdBudgetFinancingsPostRequest.ts
+model/projectsProjectIdBudgetsGet200ResponseInner.ts
+model/projectsProjectIdBudgetsIdGet200Response.ts
+model/projectsProjectIdBudgetsIdPatch200Response.ts
+model/projectsProjectIdBudgetsIdPatchRequest.ts
+model/projectsProjectIdBudgetsPost201Response.ts
+model/projectsProjectIdBudgetsPostRequest.ts
+model/projectsProjectIdBusinessPlanSectionsGet200ResponseInner.ts
+model/projectsProjectIdBusinessPlanSectionsIdGet200Response.ts
+model/projectsProjectIdBusinessPlanSectionsIdPatch200Response.ts
+model/projectsProjectIdBusinessPlanSectionsIdPatchRequest.ts
+model/projectsProjectIdBusinessPlanSectionsPost201Response.ts
+model/projectsProjectIdBusinessPlanSectionsPostRequest.ts
+model/projectsProjectIdChargesGet200ResponseInner.ts
+model/projectsProjectIdChargesIdGet200Response.ts
+model/projectsProjectIdChargesIdPatch200Response.ts
+model/projectsProjectIdChargesIdPatchRequest.ts
+model/projectsProjectIdChargesPost201Response.ts
+model/projectsProjectIdChargesPost422Response.ts
+model/projectsProjectIdChargesPostRequest.ts
+model/projectsProjectIdConvertiblesGet200ResponseInner.ts
+model/projectsProjectIdConvertiblesIdConvertPost200Response.ts
+model/projectsProjectIdConvertiblesIdGet200Response.ts
+model/projectsProjectIdConvertiblesIdPatchRequest.ts
+model/projectsProjectIdConvertiblesPost201Response.ts
+model/projectsProjectIdConvertiblesPostRequest.ts
+model/projectsProjectIdEmployeesGet200ResponseInner.ts
+model/projectsProjectIdEmployeesIdGet200Response.ts
+model/projectsProjectIdEmployeesIdPatch200Response.ts
+model/projectsProjectIdEmployeesIdPatchRequest.ts
+model/projectsProjectIdEmployeesPost201Response.ts
+model/projectsProjectIdEmployeesPostRequest.ts
+model/projectsProjectIdFinancingSourcesGet200ResponseInner.ts
+model/projectsProjectIdFinancingSourcesIdGet200Response.ts
+model/projectsProjectIdFinancingSourcesPost201Response.ts
+model/projectsProjectIdFinancingSourcesPostRequest.ts
+model/projectsProjectIdFiscalYearsGet200ResponseInner.ts
+model/projectsProjectIdFiscalYearsPostRequest.ts
+model/projectsProjectIdMembershipsGet200ResponseInner.ts
+model/projectsProjectIdMembershipsPost201Response.ts
+model/projectsProjectIdMembershipsPost422Response.ts
+model/projectsProjectIdMembershipsPostRequest.ts
+model/projectsProjectIdOptionPoolsGet200ResponseInner.ts
+model/projectsProjectIdOptionPoolsIdPatch200Response.ts
+model/projectsProjectIdOptionPoolsIdPatchRequest.ts
+model/projectsProjectIdOptionPoolsPostRequest.ts
+model/projectsProjectIdPersonsGet200ResponseInner.ts
+model/projectsProjectIdPersonsIdGet200Response.ts
+model/projectsProjectIdPersonsIdPatchRequest.ts
+model/projectsProjectIdPersonsPostRequest.ts
+model/projectsProjectIdPriceListsGet200ResponseInner.ts
+model/projectsProjectIdPriceListsPostRequest.ts
+model/projectsProjectIdPriceListsPriceListIdPricesGet200ResponseInner.ts
+model/projectsProjectIdPriceListsPriceListIdPricesIdGet200Response.ts
+model/projectsProjectIdPriceListsPriceListIdPricesIdPatchRequest.ts
+model/projectsProjectIdPriceListsPriceListIdPricesPost201Response.ts
+model/projectsProjectIdPriceListsPriceListIdPricesPostRequest.ts
+model/projectsProjectIdProductsGet200ResponseInner.ts
+model/projectsProjectIdProductsGet200ResponseInnerUnit.ts
+model/projectsProjectIdProductsIdGet200Response.ts
+model/projectsProjectIdProductsIdPatch200Response.ts
+model/projectsProjectIdProductsIdPatchRequest.ts
+model/projectsProjectIdProductsPost201Response.ts
+model/projectsProjectIdProductsPostRequest.ts
+model/projectsProjectIdProductsProductIdLaborInputsGet200ResponseInner.ts
+model/projectsProjectIdProductsProductIdLaborInputsIdPatchRequest.ts
+model/projectsProjectIdProductsProductIdLaborInputsPostRequest.ts
+model/projectsProjectIdProductsProductIdRawMaterialsGet200ResponseInner.ts
+model/projectsProjectIdProductsProductIdRawMaterialsIdPatchRequest.ts
+model/projectsProjectIdProductsProductIdRawMaterialsPost201Response.ts
+model/projectsProjectIdProductsProductIdRawMaterialsPostRequest.ts
+model/projectsProjectIdReportsBfrGet200ResponseInner.ts
+model/projectsProjectIdReportsBreakEvenGet200Response.ts
+model/projectsProjectIdReportsBreakEvenGet200ResponseByFiscalYearInner.ts
+model/projectsProjectIdReportsBudgetGet200Response.ts
+model/projectsProjectIdReportsBudgetGet200ResponseByBudgetInner.ts
+model/projectsProjectIdReportsBudgetGet200ResponseByFinancingSourceInner.ts
+model/projectsProjectIdReportsCapTableGet200Response.ts
+model/projectsProjectIdReportsCapTableGet200ResponseCurrentInner.ts
+model/projectsProjectIdReportsCapTableGet200ResponseRoundsInner.ts
+model/projectsProjectIdReportsCapTableMatrixGet200Response.ts
+model/projectsProjectIdReportsCapTableMatrixGet200ResponseRoundsInner.ts
+model/projectsProjectIdReportsCapTableMatrixGet200ResponseShareholdersInner.ts
+model/projectsProjectIdReportsCapTablePlanGet200ResponseInner.ts
+model/projectsProjectIdReportsCapacityGet200ResponseInner.ts
+model/projectsProjectIdReportsCapacityGet200ResponseInnerRolesInner.ts
+model/projectsProjectIdReportsDashboardGet200Response.ts
+model/projectsProjectIdReportsDashboardGet200ResponseCashflowMonthlyInner.ts
+model/projectsProjectIdReportsDashboardGet200ResponseChargesByQuarterInner.ts
+model/projectsProjectIdReportsDashboardGet200ResponseRevenueByQuarterInner.ts
+model/projectsProjectIdReportsDashboardGet200ResponseTreasuryMonthlyInner.ts
+model/projectsProjectIdReportsDerivedChargesGet200Response.ts
+model/projectsProjectIdReportsDerivedChargesGet200ResponseDerivedChargesInner.ts
+model/projectsProjectIdReportsEquityGet200ResponseInner.ts
+model/projectsProjectIdReportsFinancingDetailGet200Response.ts
+model/projectsProjectIdReportsFinancingDetailGet200ResponseComputedCapitalInner.ts
+model/projectsProjectIdReportsFinancingDetailGet200ResponseComputedCcaInner.ts
+model/projectsProjectIdReportsFinancingDetailGet200ResponseSourcesInner.ts
+model/projectsProjectIdReportsFinancingPlanGet200ResponseInner.ts
+model/projectsProjectIdReportsIncomeStatementGet200ResponseInner.ts
+model/projectsProjectIdReportsPayrollGet200Response.ts
+model/projectsProjectIdReportsPayrollGet200ResponseCdiDurablesByFiscalYearInner.ts
+model/projectsProjectIdReportsPayrollGet200ResponseFteByFiscalYearInner.ts
+model/projectsProjectIdReportsPersonIncomeGet200Response.ts
+model/projectsProjectIdReportsPersonIncomeGet200ResponsePersonsInner.ts
+model/projectsProjectIdReportsPersonIncomeGet200ResponsePersonsInnerMonthlyInner.ts
+model/projectsProjectIdReportsPersonalLeverageGet200Response.ts
+model/projectsProjectIdReportsPersonalLeverageGet200ResponsePersonsInner.ts
+model/projectsProjectIdReportsPersonalLeverageGet200ResponsePersonsInnerMonthlyInner.ts
+model/projectsProjectIdReportsRevenueByChannelGet200ResponseInner.ts
+model/projectsProjectIdReportsRevenueGet200Response.ts
+model/projectsProjectIdReportsRevenueGet200ResponseRevenueWarningsInner.ts
+model/projectsProjectIdReportsRevenueGet200ResponseRowsInner.ts
+model/projectsProjectIdReportsRoundSolvePost200Response.ts
+model/projectsProjectIdReportsRoundSolvePostRequest.ts
+model/projectsProjectIdReportsRoundSolvePostRequestTargetsInner.ts
+model/projectsProjectIdReportsRoundValuationsGet200ResponseInner.ts
+model/projectsProjectIdReportsRoundValuationsGet200ResponseInnerHoldersInner.ts
+model/projectsProjectIdReportsSegmentsGet200ResponseInner.ts
+model/projectsProjectIdReportsSegmentsGet200ResponseInnerByProductInner.ts
+model/projectsProjectIdReportsTaxCreditsGet200ResponseInner.ts
+model/projectsProjectIdReportsTreasuryMonthlyGet200ResponseInner.ts
+model/projectsProjectIdRoundsGet200ResponseInner.ts
+model/projectsProjectIdRoundsIdPatch200Response.ts
+model/projectsProjectIdRoundsIdPatchRequest.ts
+model/projectsProjectIdRoundsPostRequest.ts
+model/projectsProjectIdSalesScenariosGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosIdSetDefaultPatch200Response.ts
+model/projectsProjectIdSalesScenariosPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsIdPatch200Response.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsIdPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsPost201Response.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelGeneratorEntitiesGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelGeneratorEntitiesIdPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelGeneratorEntitiesPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelGet200Response.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesInputsGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesInputsIdPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesInputsPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesStagesGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesStagesIdPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesModelSalesStagesPostRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesVolumesGet200ResponseInner.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesVolumesIdPatchRequest.ts
+model/projectsProjectIdSalesScenariosSalesScenarioIdSalesItemsSalesItemIdSalesVolumesPostRequest.ts
+model/projectsProjectIdSellablesSellableIdCompositeBasketGet200Response.ts
+model/projectsProjectIdSellablesSellableIdCompositeBasketGet200ResponseBreakdownInner.ts
+model/projectsProjectIdSellablesSellableIdCompositeBasketGet200ResponseBreakdownInnerOptionsInner.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsGet200ResponseInner.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsIdPatch200Response.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsIdPatchRequest.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsPost201Response.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsPostRequest.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsGet200ResponseInner.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsIdGet200Response.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsIdPatch200Response.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsIdPatchRequest.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsPost201Response.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsConfigSlotIdSlotOptionsSlotOptionIdAverageBasketsPostRequest.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsGet200ResponseInner.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsIdPatchRequest.ts
+model/projectsProjectIdSellablesSellableIdConfigSlotsPostRequest.ts
+model/projectsProjectIdServicesGet200ResponseInner.ts
+model/projectsProjectIdServicesGet200ResponseInnerUnit.ts
+model/projectsProjectIdShareholderGroupsGet200ResponseInner.ts
+model/projectsProjectIdShareholderGroupsIdPatch200Response.ts
+model/projectsProjectIdShareholderGroupsIdPatchRequest.ts
+model/projectsProjectIdShareholderGroupsPost201Response.ts
+model/projectsProjectIdShareholderGroupsPostRequest.ts
+model/projectsProjectIdShareholdersGet200ResponseInner.ts
+model/projectsProjectIdShareholdersIdPatchRequest.ts
+model/projectsProjectIdShareholdersPost201Response.ts
+model/projectsProjectIdShareholdersPostRequest.ts
+model/projectsProjectIdShareholdersShareholderIdCurrentAccountsGet200ResponseInner.ts
+model/projectsProjectIdShareholdersShareholderIdCurrentAccountsIdPatchRequest.ts
+model/projectsProjectIdShareholdersShareholderIdCurrentAccountsPost201Response.ts
+model/projectsProjectIdShareholdersShareholderIdCurrentAccountsPostRequest.ts
+model/projectsProjectIdShareholdersShareholderIdShareLotsGet200ResponseInner.ts
+model/projectsProjectIdShareholdersShareholderIdShareLotsIdGet200Response.ts
+model/projectsProjectIdShareholdersShareholderIdShareLotsIdPatchRequest.ts
+model/projectsProjectIdShareholdersShareholderIdShareLotsPost201Response.ts
+model/projectsProjectIdShareholdersShareholderIdShareLotsPostRequest.ts
+model/projectsProjectIdTargetsGet200ResponseInner.ts
+model/projectsProjectIdTargetsPostRequest.ts
+model/projectsProjectIdTargetsTargetIdSegmentsGet200ResponseInner.ts
+model/projectsProjectIdTargetsTargetIdSegmentsPostRequest.ts
+model/unitsGet200ResponseInner.ts
+model/unitsIdDelete403Response.ts
+model/unitsIdDelete403ResponseUnit.ts
+model/unitsIdGet200Response.ts
+model/unitsIdPatch403Response.ts
+model/unitsIdPatchRequest.ts
+model/unitsPost201Response.ts
+model/unitsPostRequest.ts
+ng-package.json
+package.json
+param.ts
+tsconfig.json
+variables.ts

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.10.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,236 @@
+# @monfilon/api-client@1.0.0
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+## 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 @monfilon/api-client@1.0.0 --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 @monfilon/api-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
+// without configuring providers
+import { ApiModule } from '@monfilon/api-client';
+import { HttpClientModule } from '@angular/common/http';
+
+@NgModule({
+    imports: [
+        ApiModule,
+        // 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 {}
+```
+
+```typescript
+// configuring providers
+import { ApiModule, Configuration, ConfigurationParameters } from '@monfilon/api-client';
+
+export function apiConfigFactory (): Configuration {
+  const params: ConfigurationParameters = {
+    // set configuration parameters here.
+  }
+  return new Configuration(params);
+}
+
+@NgModule({
+    imports: [ ApiModule.forRoot(apiConfigFactory) ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```typescript
+// configuring providers with an authentication service that manages your access tokens
+import { ApiModule, Configuration } from '@monfilon/api-client';
+
+@NgModule({
+    imports: [ ApiModule ],
+    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 {}
+```
+
+```typescript
+import { DefaultApi } from '@monfilon/api-client';
+
+export class AppComponent {
+    constructor(private apiGateway: DefaultApi) { }
+}
+```
+
+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
+
+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';
+
+@NgModule({
+  imports: [
+    ApiModule,
+    OtherApiModule,
+    // make sure to import the HttpClientModule in the AppModule only,
+    // see https://github.com/angular/angular/issues/20575
+    HttpClientModule
+  ]
+})
+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 '@monfilon/api-client';
+
+bootstrap(AppComponent, [
+    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
+]);
+```
+
+or
+
+```typescript
+import { BASE_PATH } from '@monfilon/api-client';
+
+@NgModule({
+    imports: [],
+    declarations: [ AppComponent ],
+    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+### 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'
+};
+```
+
+In the src/app/app.module.ts:
+
+```typescript
+import { BASE_PATH } from '@monfilon/api-client';
+import { environment } from '../environments/environment';
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [ ],
+  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
+  bootstrap: [ AppComponent ]
+})
+export class AppModule { }
+```
+
+### Customizing path parameter encoding
+
+Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
+and Dates for format 'date-time' are encoded correctly.
+
+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]).
+
+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).
+
+Example value for use in your Configuration-Provider:
+
+```typescript
+new Configuration({
+    encodeParam: (param: Param) => myFancyParamEncoder(param),
+})
+```
+
+[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