@emilgroup/translation-sdk 1.1.0 → 1.1.1-beta.10

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 .openapi-generator-ignore
 README.md
 api.ts
+api/default-api.ts
 api/translation-api.ts
 base.ts
 common.ts
@@ -13,6 +14,8 @@ 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 Node module can be used with Nodejs based applications.
+This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
 
 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.1.0 --save
+npm install @emilgroup/translation-sdk@1.1.1-beta.10 --save
 ```
 or 
 ```
-yarn add @emilgroup/translation-sdk@1.1.0
+yarn add @emilgroup/translation-sdk@1.1.1-beta.10
 ```
 
 And then you can import `TranslationApi`.
@@ -29,36 +29,19 @@ And then you can import `TranslationApi`.
 ```ts
 import { TranslationApi } from '@emilgroup/translation-sdk'
 
-const tranlationApi = new TranslationApi();
+const translationApi = new TranslationApi();
 ```
-## Credentials
 
-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:
+To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `TranslationApi`:
 
 ```ts
-async function listProductLanguages(): Promise<Void> {
+async function listTranslations(): Promise<Void> {
     try {
-        const tranlationApi = new TranslationApi();
+        const translationApi = new TranslationApi();
 
-        await tranlationApi.initialize(); // should be called only once per Api.
+        await translationApi.authorize('username', 'password');
 
-        const { data: { items } } = await tranlationApi.listProductLanguages();
+        const { data: { items } } = await translationApi.listTranslations();
 
         console.log(items);
     } catch(error) {

package/api/default-api.ts

@@ -0,0 +1,124 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL TranslationService
+ * The EMIL TranslationService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { InlineResponse200 } from '../models';
+// @ts-ignore
+import { InlineResponse503 } from '../models';
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns the health status of the translation service.        This endpoint is used to monitor the operational status of the translation service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/translationservice/health`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Returns the health status of the translation service.        This endpoint is used to monitor the operational status of the translation service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DefaultApiFp(configuration)
+    return {
+        /**
+         * Returns the health status of the translation service.        This endpoint is used to monitor the operational status of the translation service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check(options?: any): AxiosPromise<InlineResponse200> {
+            return localVarFp.check(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     * Returns the health status of the translation service.        This endpoint is used to monitor the operational status of the translation service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public check(options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
+    }
+}