@emilgroup/document-sdk-node 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,45 @@
+.gitignore
+.npmignore
+README.md
+api.ts
+api/document-templates-api.ts
+api/documents-api.ts
+api/layouts-api.ts
+api/searchable-document-owners-api.ts
+api/searchable-documents-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/create-doc-template-request-dto.ts
+models/create-document-request-dto.ts
+models/create-html-template-dto.ts
+models/create-layout-request-dto.ts
+models/delete-layout-request-dto.ts
+models/delete-request-dto.ts
+models/doc-template-class.ts
+models/document-class.ts
+models/download-document-request-dto.ts
+models/get-doc-template-request-dto.ts
+models/get-doc-template-response-class.ts
+models/get-document-download-url-response-class.ts
+models/get-layout-request-dto.ts
+models/get-layout-response-class.ts
+models/html-template-class.ts
+models/index.ts
+models/layout-class.ts
+models/list-doc-templates-response-class.ts
+models/list-documents-response-class.ts
+models/list-layouts-response-class.ts
+models/list-request-dto.ts
+models/list-searchable-document-owners-response-class.ts
+models/list-searchable-documents-request-dto.ts
+models/list-searchable-documents-response-class.ts
+models/update-doc-template-request-dto.ts
+models/update-doc-template-response-class.ts
+models/update-document-request-dto.ts
+models/update-layout-request-dto.ts
+models/update-layout-response-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

@@ -0,0 +1,68 @@
+# Emil Documents SDK
+
+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/document-sdk-node@1.0.0 --save
+```
+or 
+```
+yarn add @emilgroup/document-sdk-node@1.0.0
+```
+
+And then you can import `DocumentsApi`.
+
+```ts
+import { DocumentsApi } from '@emilgroup/document-sdk-node'
+
+const documentsApi = new DocumentsApi();
+```
+## 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:
+
+```ts
+async function listDocuments(): Promise<Void> {
+    try {
+        const documentsApi = new DocumentsApi();
+
+        await documentsApi.initialize(); // should be called only once per Api.
+
+        const { data: { items } } = await documentsApi.listDocuments();
+
+        console.log(items);
+    } catch(error) {
+      // process error
+  }
+}
+```