@emilgroup/customer-sdk-node 1.1.1 → 1.4.0

package/.openapi-generator/FILES

@@ -14,6 +14,7 @@ models/create-account-request-dto.ts
 models/create-customer-request-dto.ts
 models/create-customer-response-class.ts
 models/forgot-password-request-dto.ts
+models/get-customer-response-class.ts
 models/get-policy-response-class.ts
 models/index.ts
 models/initiate-auth-request-dto.ts
@@ -22,6 +23,7 @@ models/invite-by-customer-request-dto.ts
 models/invite-by-customer-response-class.ts
 models/invite-by-tenant-response-class.ts
 models/invite-class.ts
+models/list-documents-response-class.ts
 models/list-invoices-response-class.ts
 models/list-policies-response-class.ts
 models/policy-class.ts
@@ -30,10 +32,15 @@ models/policy-premium-class.ts
 models/policy-premium-item-class.ts
 models/policy-version-class.ts
 models/refresh-token-dto.ts
+models/request-policy-update-request-dto.ts
+models/request-policy-update-response-class.ts
 models/reset-password-by-customer-request-dto.ts
 models/respond-to-auth-challenge-class.ts
 models/respond-to-auth-challenge-request-dto.ts
 models/timeslice-class.ts
+models/update-account-request-dto.ts
+models/update-customer-request-dto.ts
+models/update-customer-response-class.ts
 models/verify-customer-invite-response-class.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,29 +17,46 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/customer-sdk-node@1.1.1 --save
+npm install @emilgroup/customer-sdk-node@1.4.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/customer-sdk-node@1.1.1
+yarn add @emilgroup/customer-sdk-node@1.4.0
 ```
 
 And then you can import `CustomersApi`.
 
 ```ts
-import { CustomersApi } from '@emilgroup/customer-sdk'
+import { CustomersApi } from '@emilgroup/customer-sdk-node'
 
 const customersApi = new CustomersApi();
 ```
+## Credentials
 
-To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `CustomersApi`:
+To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under `~/.emil/credentials` with the following content:
+
+```shell
+emil_username=XXXXX@XXXX.XXX
+emil_password=XXXXXXXXXXXXXX
+```
+
+It is also possible to provide environment variables instead:
+
+```shell
+export EMIL_USERNAME=XXXXX@XXXX.XXX
+export EMIL_PASSWORD=XXXXXXXXXXXXXX
+```
+
+## Example
+
+Here is a basic functionning example:
 
 ```ts
 async function listCustomers(): Promise<Void> {
     try {
         const customersApi = new CustomersApi();
 
-        await customersApi.authorize('username', 'password');
+        await customersApi.initialize(); // should be called only once per Api.
 
         const { data: { items } } = await customersApi.listCustomers();