@emilgroup/public-api-sdk 1.0.0

package/dist/api/documents-api.js

@@ -0,0 +1,439 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = void 0;
+var axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+var common_1 = require("../common");
+// @ts-ignore
+var base_1 = require("../base");
+/**
+ * DocumentsApi - axios parameter creator
+ * @export
+ */
+var DocumentsApiAxiosParamCreator = function (configuration) {
+    var _this = this;
+    return {
+        /**
+         * This will create a temporary document.
+         * @summary Create the temporary document
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            // verify required parameter 'createDocumentRequestDto' is not null or undefined
+                            (0, common_1.assertParamExists)('createTemporaryDocument', 'createDocumentRequestDto', createDocumentRequestDto);
+                            localVarPath = "/publicapi/v1/documents";
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+                            }
+                            localVarHeaderParameter['Content-Type'] = 'application/json';
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDocumentRequestDto, localVarRequestOptions, configuration);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
+        /**
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
+         * @param {string} code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadDocument: function (code, authorization, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            // verify required parameter 'code' is not null or undefined
+                            (0, common_1.assertParamExists)('downloadDocument', 'code', code);
+                            localVarPath = "/publicapi/v1/documents/download/{code}"
+                                .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
+        /**
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
+         * @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: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            localVarPath = "/publicapi/v1/documents";
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            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);
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
+    };
+};
+exports.DocumentsApiAxiosParamCreator = DocumentsApiAxiosParamCreator;
+/**
+ * DocumentsApi - functional programming interface
+ * @export
+ */
+var DocumentsApiFp = function (configuration) {
+    var localVarAxiosParamCreator = (0, exports.DocumentsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * This will create a temporary document.
+         * @summary Create the temporary document
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.createTemporaryDocument(createDocumentRequestDto, authorization, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+        /**
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
+         * @param {string} code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadDocument: function (code, authorization, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadDocument(code, authorization, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+        /**
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
+         * @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: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+    };
+};
+exports.DocumentsApiFp = DocumentsApiFp;
+/**
+ * DocumentsApi - factory interface
+ * @export
+ */
+var DocumentsApiFactory = function (configuration, basePath, axios) {
+    var localVarFp = (0, exports.DocumentsApiFp)(configuration);
+    return {
+        /**
+         * This will create a temporary document.
+         * @summary Create the temporary document
+         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
+            return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
+        },
+        /**
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
+         * @param {string} code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadDocument: function (code, authorization, options) {
+            return localVarFp.downloadDocument(code, authorization, options).then(function (request) { return request(axios, basePath); });
+        },
+        /**
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
+         * @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: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+            return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
+        },
+    };
+};
+exports.DocumentsApiFactory = DocumentsApiFactory;
+/**
+ * DocumentsApi - object-oriented interface
+ * @export
+ * @class DocumentsApi
+ * @extends {BaseAPI}
+ */
+var DocumentsApi = /** @class */ (function (_super) {
+    __extends(DocumentsApi, _super);
+    function DocumentsApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * This will create a temporary document.
+     * @summary Create the temporary document
+     * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    DocumentsApi.prototype.createTemporaryDocument = function (requestParameters, options) {
+        var _this = this;
+        return (0, exports.DocumentsApiFp)(this.configuration).createTemporaryDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    /**
+     * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+     * @summary Download a document
+     * @param {DocumentsApiDownloadDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    DocumentsApi.prototype.downloadDocument = function (requestParameters, options) {
+        var _this = this;
+        return (0, exports.DocumentsApiFp)(this.configuration).downloadDocument(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    /**
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
+     * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    DocumentsApi.prototype.listDocuments = function (requestParameters, options) {
+        var _this = this;
+        if (requestParameters === void 0) { requestParameters = {}; }
+        return (0, exports.DocumentsApiFp)(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    return DocumentsApi;
+}(base_1.BaseAPI));
+exports.DocumentsApi = DocumentsApi;