@emilgroup/translation-sdk 1.0.1-beta.4 → 1.1.0

package/.openapi-generator/FILES

@@ -3,7 +3,6 @@
 .openapi-generator-ignore
 README.md
 api.ts
-api/default-api.ts
 api/translation-api.ts
 base.ts
 common.ts
@@ -14,8 +13,6 @@ models/create-product-language-request-dto.ts
 models/create-product-language-response-class.ts
 models/get-product-language-response-class.ts
 models/index.ts
-models/inline-response200.ts
-models/inline-response503.ts
 models/list-product-languages-response-class.ts
 models/list-translations-response-class.ts
 models/product-language-class.ts

package/README.md

@@ -1,6 +1,6 @@
 # Emil Translation SDK
 
-This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
+This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated Node module can be used with Nodejs based applications.
 
 Language level
 * ES5 - you must have a Promises/A+ library installed
@@ -17,11 +17,11 @@ 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/translation-sdk@1.0.1-beta.4 --save
+npm install @emilgroup/translation-sdk@1.1.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/translation-sdk@1.0.1-beta.4
+yarn add @emilgroup/translation-sdk@1.1.0
 ```
 
 And then you can import `TranslationApi`.
@@ -29,19 +29,36 @@ And then you can import `TranslationApi`.
 ```ts
 import { TranslationApi } from '@emilgroup/translation-sdk'
 
-const translationApi = new TranslationApi();
+const tranlationApi = new TranslationApi();
 ```
+## Credentials
 
-To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `TranslationApi`:
+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 listTranslations(): Promise<Void> {
+async function listProductLanguages(): Promise<Void> {
     try {
-        const translationApi = new TranslationApi();
+        const tranlationApi = new TranslationApi();
 
-        await translationApi.authorize('username', 'password');
+        await tranlationApi.initialize(); // should be called only once per Api.
 
-        const { data: { items } } = await translationApi.listTranslations();
+        const { data: { items } } = await tranlationApi.listProductLanguages();
 
         console.log(items);
     } catch(error) {