@emilgroup/public-api-sdk-node 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,30 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+api/documents-api.ts
+api/payment-setup-api.ts
+api/products-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/complete-braintree-payment-setup-request-dto.ts
+models/complete-payment-setup-request-dto.ts
+models/complete-stripe-payment-setup-request-dto.ts
+models/create-account-request-dto.ts
+models/create-bank-account-request-dto.ts
+models/create-custom-application-request-dto.ts
+models/create-document-request-dto.ts
+models/create-estimated-invoice-request-dto.ts
+models/create-lead-request-dto.ts
+models/index.ts
+models/initiate-braintree-payment-setup-request-dto.ts
+models/initiate-payment-setup-request-dto.ts
+models/initiate-stripe-payment-setup-request-dto.ts
+models/policy-object-request-dto.ts
+models/uploaded-document-dto.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,51 @@
+# Emil Public Api SDK for Nodejs
+
+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
+* 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/public-api-sdk-node@1.0.0 --save
+```
+or 
+```
+yarn add @emilgroup/public-api-sdk-node@1.0.0
+```
+
+And then you can import `PublicApi`.
+
+```ts
+import { PublicApi } from '@emilgroup/public-api-sdk-node'
+
+const publicApi = new PublicApi();
+```
+
+To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `PublicApi`:
+
+```ts
+async function listDocuments(): Promise<Void> {
+    try {
+        const publicApi = new PublicApi();
+
+        await publicApi.authorize('username', 'password');
+
+        const { data: { items } } = await publicApi.listDocuments();
+
+        console.log(items);
+    } catch(error) {
+      // process error
+  }
+}
+```

package/api/documents-api.ts

@@ -0,0 +1,424 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PublicAPI
+ * The EMIL Public API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * 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 { CreateDocumentRequestDto } from '../models';
+/**
+ * DocumentsApi - axios parameter creator
+ * @export
+ */
+export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createTemporaryDocument: async (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createDocumentRequestDto' is not null or undefined
+            assertParamExists('createTemporaryDocument', 'createDocumentRequestDto', createDocumentRequestDto)
+            const localVarPath = `/publicapi/v1/documents`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createDocumentRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadDocument: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('downloadDocument', 'code', code)
+            const localVarPath = `/publicapi/v1/documents/download/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // 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 (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,
+            };
+        },
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.      It functions similarly to an SQL ORDER BY.      Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in      addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDocuments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/publicapi/v1/documents`;
+            // 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 (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * DocumentsApi - functional programming interface
+ * @export
+ */
+export const DocumentsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createTemporaryDocument(createDocumentRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async downloadDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadDocument(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.      It functions similarly to an SQL ORDER BY.      Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in      addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * DocumentsApi - factory interface
+ * @export
+ */
+export const DocumentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DocumentsApiFp(configuration)
+    return {
+        /**
+         * 
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadDocument(code: string, authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.downloadDocument(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.      It functions similarly to an SQL ORDER BY.      Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in      addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<void> {
+            return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createTemporaryDocument operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiCreateTemporaryDocumentRequest
+ */
+export interface DocumentsApiCreateTemporaryDocumentRequest {
+    /**
+     * 
+     * @type {CreateDocumentRequestDto}
+     * @memberof DocumentsApiCreateTemporaryDocument
+     */
+    readonly createDocumentRequestDto: CreateDocumentRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiCreateTemporaryDocument
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for downloadDocument operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiDownloadDocumentRequest
+ */
+export interface DocumentsApiDownloadDocumentRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentsApiDownloadDocument
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiDownloadDocument
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listDocuments operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiListDocumentsRequest
+ */
+export interface DocumentsApiListDocumentsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly pageSize?: any
+
+    /**
+     * A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly pageToken?: any
+
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly filter?: any
+
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly search?: any
+
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.      It functions similarly to an SQL ORDER BY.      Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly order?: any
+
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in      addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof DocumentsApiListDocuments
+     */
+    readonly expand?: any
+}
+
+/**
+ * DocumentsApi - object-oriented interface
+ * @export
+ * @class DocumentsApi
+ * @extends {BaseAPI}
+ */
+export class DocumentsApi extends BaseAPI {
+    /**
+     * 
+     * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    public createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig) {
+        return DocumentsApiFp(this.configuration).createTemporaryDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @param {DocumentsApiDownloadDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    public downloadDocument(requestParameters: DocumentsApiDownloadDocumentRequest, options?: AxiosRequestConfig) {
+        return DocumentsApiFp(this.configuration).downloadDocument(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    public listDocuments(requestParameters: DocumentsApiListDocumentsRequest = {}, options?: AxiosRequestConfig) {
+        return DocumentsApiFp(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+}