@emilgroup/translation-sdk-node 1.1.0 → 1.1.1-beta.5

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

@@ -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-node@1.1.0 --save
+npm install @emilgroup/translation-sdk-node@1.1.1-beta.5 --save
 ```
 or 
 ```
-yarn add @emilgroup/translation-sdk-node@1.1.0
+yarn add @emilgroup/translation-sdk-node@1.1.1-beta.5
 ```
 
 And then you can import `TranslationApi`.
@@ -47,18 +47,34 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
 export EMIL_PASSWORD=XXXXXXXXXXXXXX
 ```
 
+## Base path
+
+To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
+
+```ts
+import { TranslationApi, Environment } from '@emilgroup/translation-sdk-node'
+
+const translationApi = new TranslationApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+translationApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+translationApi.selectBasePath('https://my-custom-domain.com');
+```
+
 ## Example
 
 Here is a basic functionning example:
 
 ```ts
-async function listProductLanguages(): Promise<Void> {
+async function listTranslations(): Promise<Void> {
     try {
         const translationApi = new TranslationApi();
 
         await translationApi.initialize(); // should be called only once per Api.
 
-        const { data: { items } } = await translationApi.listProductLanguages();
+        const { data: { items } } = await translationApi.listTranslations();
 
         console.log(items);
     } catch(error) {

package/api/default-api.ts

@@ -0,0 +1,128 @@
+/* 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';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * 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));
+    }
+}