@emilgroup/task-sdk-node 1.0.3 → 1.2.0

package/.openapi-generator/FILES

@@ -0,0 +1,49 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+api/assignees-api.ts
+api/categories-api.ts
+api/default-api.ts
+api/hub-spot-api.ts
+api/statuses-api.ts
+api/tasks-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/assignee-class.ts
+models/category-class.ts
+models/create-category-request-dto.ts
+models/create-category-response-class.ts
+models/create-hub-spot-ticket-request-dto.ts
+models/create-hub-spot-ticket-response-class.ts
+models/create-status-request-dto.ts
+models/create-status-response-class.ts
+models/create-task-request-dto.ts
+models/create-task-response-class.ts
+models/get-category-response-class.ts
+models/get-status-response-class.ts
+models/get-task-response-class.ts
+models/hub-spot-ticket-class.ts
+models/hub-spot-ticket-error-class.ts
+models/hub-spot-ticket-name-value-dto.ts
+models/index.ts
+models/inline-response200.ts
+models/inline-response503.ts
+models/list-assignees-response-class.ts
+models/list-categories-response-class.ts
+models/list-statuses-response-class.ts
+models/list-tasks-response-class.ts
+models/patch-category-request-dto.ts
+models/patch-category-response-class.ts
+models/patch-status-request-dto.ts
+models/patch-status-response-class.ts
+models/patch-task-request-dto.ts
+models/patch-task-response-class.ts
+models/status-class.ts
+models/task-class.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+5.4.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

@@ -1 +1,84 @@
-# npm-kit
+# Emil Task SDK for Nodejs
+
+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
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)). For more information, you can go to [Emil Api documentation](https://emil.stoplight.io/docs/emil-api/).
+
+## Consuming
+
+Navigate to the folder of your consuming project and run one of the following commands:
+
+```
+npm install @emilgroup/task-sdk-node@1.2.0 --save
+```
+or 
+```
+yarn add @emilgroup/task-sdk-node@1.2.0
+```
+
+And then you can import `TasksApi`.
+
+```ts
+import { TasksApi } from '@emilgroup/task-sdk-node'
+
+const tasksApi = new TasksApi();
+```
+## 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
+```
+
+## 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 { TasksApi, Environment } from '@emilgroup/task-sdk-node'
+
+const tasksApi = new TasksApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+tasksApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+tasksApi.selectBasePath('https://my-custom-domain.com');
+```
+
+## Example
+
+Here is a basic functionning example:
+
+```ts
+async function listTasks(): Promise<Void> {
+    try {
+        const tasksApi = new TasksApi();
+
+        await tasksApi.initialize(); // should be called only once per Api.
+
+        const { data: { items } } = await tasksApi.listTasks();
+
+        console.log(items);
+    } catch(error) {
+      // process error
+  }
+}
+```

package/api/assignees-api.ts

@@ -0,0 +1,166 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL TaskService
+ * The EMIL Task 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 { ListAssigneesResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * AssigneesApi - axios parameter creator
+ * @export
+ */
+export const AssigneesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves a list of distinct assignees from tasks.  **Required Permissions**  \"task-management.tasks.view\"
+         * @summary List assignees
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAssignees: async (authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/taskservice/v1/assignees`;
+            // 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;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AssigneesApi - functional programming interface
+ * @export
+ */
+export const AssigneesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AssigneesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves a list of distinct assignees from tasks.  **Required Permissions**  \"task-management.tasks.view\"
+         * @summary List assignees
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignees(authorization, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * AssigneesApi - factory interface
+ * @export
+ */
+export const AssigneesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AssigneesApiFp(configuration)
+    return {
+        /**
+         * Retrieves a list of distinct assignees from tasks.  **Required Permissions**  \"task-management.tasks.view\"
+         * @summary List assignees
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass> {
+            return localVarFp.listAssignees(authorization, expand, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for listAssignees operation in AssigneesApi.
+ * @export
+ * @interface AssigneesApiListAssigneesRequest
+ */
+export interface AssigneesApiListAssigneesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AssigneesApiListAssignees
+     */
+    readonly authorization?: string
+
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       
+     * @type {string}
+     * @memberof AssigneesApiListAssignees
+     */
+    readonly expand?: string
+}
+
+/**
+ * AssigneesApi - object-oriented interface
+ * @export
+ * @class AssigneesApi
+ * @extends {BaseAPI}
+ */
+export class AssigneesApi extends BaseAPI {
+    /**
+     * Retrieves a list of distinct assignees from tasks.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List assignees
+     * @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssigneesApi
+     */
+    public listAssignees(requestParameters: AssigneesApiListAssigneesRequest = {}, options?: AxiosRequestConfig) {
+        return AssigneesApiFp(this.configuration).listAssignees(requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+}