@invoicetronic/ts-sdk 1.0.0

package/dist/esm/src/api/receive-api.js

@@ -0,0 +1,403 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Invoicetronic API
+ * The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools.  For more information, see  [Invoicetronic website][2]  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@invoicetronic.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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());
+    });
+};
+import globalAxios from 'axios';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL } from 'url';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setBasicAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
+/**
+ * ReceiveApi - axios parameter creator
+ * @export
+ */
+export const ReceiveApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary List incoming invoices
+         * @param {number} [companyId] Company id
+         * @param {string} [identifier] SDI identifier.
+         * @param {boolean} [unread] Unread items only.
+         * @param {string} [committente] Vat number or fiscal code.
+         * @param {string} [prestatore] Vat number or fiscal code.
+         * @param {string} [fileName] File name.
+         * @param {string} [lastUpdateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [lastUpdateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentNumber] Document number.
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {number} [page] Page number.
+         * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+         * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveGet: (companyId_1, identifier_1, unread_1, committente_1, prestatore_1, fileName_1, lastUpdateFrom_1, lastUpdateTo_1, dateSentFrom_1, dateSentTo_1, documentDateFrom_1, documentDateTo_1, documentNumber_1, includePayload_1, page_1, pageSize_1, sort_1, ...args_1) => __awaiter(this, [companyId_1, identifier_1, unread_1, committente_1, prestatore_1, fileName_1, lastUpdateFrom_1, lastUpdateTo_1, dateSentFrom_1, dateSentTo_1, documentDateFrom_1, documentDateTo_1, documentNumber_1, includePayload_1, page_1, pageSize_1, sort_1, ...args_1], void 0, function* (companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options = {}) {
+            const localVarPath = `/receive`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Basic required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration);
+            if (companyId !== undefined) {
+                localVarQueryParameter['company_id'] = companyId;
+            }
+            if (identifier !== undefined) {
+                localVarQueryParameter['identifier'] = identifier;
+            }
+            if (unread !== undefined) {
+                localVarQueryParameter['unread'] = unread;
+            }
+            if (committente !== undefined) {
+                localVarQueryParameter['committente'] = committente;
+            }
+            if (prestatore !== undefined) {
+                localVarQueryParameter['prestatore'] = prestatore;
+            }
+            if (fileName !== undefined) {
+                localVarQueryParameter['file_name'] = fileName;
+            }
+            if (lastUpdateFrom !== undefined) {
+                localVarQueryParameter['last_update_from'] = (lastUpdateFrom instanceof Date) ?
+                    lastUpdateFrom.toISOString() :
+                    lastUpdateFrom;
+            }
+            if (lastUpdateTo !== undefined) {
+                localVarQueryParameter['last_update_to'] = (lastUpdateTo instanceof Date) ?
+                    lastUpdateTo.toISOString() :
+                    lastUpdateTo;
+            }
+            if (dateSentFrom !== undefined) {
+                localVarQueryParameter['date_sent_from'] = (dateSentFrom instanceof Date) ?
+                    dateSentFrom.toISOString() :
+                    dateSentFrom;
+            }
+            if (dateSentTo !== undefined) {
+                localVarQueryParameter['date_sent_to'] = (dateSentTo instanceof Date) ?
+                    dateSentTo.toISOString() :
+                    dateSentTo;
+            }
+            if (documentDateFrom !== undefined) {
+                localVarQueryParameter['document_date_from'] = (documentDateFrom instanceof Date) ?
+                    documentDateFrom.toISOString() :
+                    documentDateFrom;
+            }
+            if (documentDateTo !== undefined) {
+                localVarQueryParameter['document_date_to'] = (documentDateTo instanceof Date) ?
+                    documentDateTo.toISOString() :
+                    documentDateTo;
+            }
+            if (documentNumber !== undefined) {
+                localVarQueryParameter['document_number'] = documentNumber;
+            }
+            if (includePayload !== undefined) {
+                localVarQueryParameter['include_payload'] = includePayload;
+            }
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page_size'] = pageSize;
+            }
+            if (sort !== undefined) {
+                localVarQueryParameter['sort'] = sort;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Delete an incoming invoice by id
+         * @param {number} id Item id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdDelete: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('receiveIdDelete', 'id', id);
+            const localVarPath = `/receive/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Basic required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Get an incoming invoice by id
+         * @param {number} id Item id
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdGet: (id_1, includePayload_1, ...args_1) => __awaiter(this, [id_1, includePayload_1, ...args_1], void 0, function* (id, includePayload, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('receiveIdGet', 'id', id);
+            const localVarPath = `/receive/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Basic required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration);
+            if (includePayload !== undefined) {
+                localVarQueryParameter['include_payload'] = includePayload;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ReceiveApi - functional programming interface
+ * @export
+ */
+export const ReceiveApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ReceiveApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary List incoming invoices
+         * @param {number} [companyId] Company id
+         * @param {string} [identifier] SDI identifier.
+         * @param {boolean} [unread] Unread items only.
+         * @param {string} [committente] Vat number or fiscal code.
+         * @param {string} [prestatore] Vat number or fiscal code.
+         * @param {string} [fileName] File name.
+         * @param {string} [lastUpdateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [lastUpdateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentNumber] Document number.
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {number} [page] Page number.
+         * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+         * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReceiveApi.receiveGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Delete an incoming invoice by id
+         * @param {number} id Item id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdDelete(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.receiveIdDelete(id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReceiveApi.receiveIdDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Get an incoming invoice by id
+         * @param {number} id Item id
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdGet(id, includePayload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.receiveIdGet(id, includePayload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReceiveApi.receiveIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ReceiveApi - factory interface
+ * @export
+ */
+export const ReceiveApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ReceiveApiFp(configuration);
+    return {
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary List incoming invoices
+         * @param {number} [companyId] Company id
+         * @param {string} [identifier] SDI identifier.
+         * @param {boolean} [unread] Unread items only.
+         * @param {string} [committente] Vat number or fiscal code.
+         * @param {string} [prestatore] Vat number or fiscal code.
+         * @param {string} [fileName] File name.
+         * @param {string} [lastUpdateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [lastUpdateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [dateSentTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentNumber] Document number.
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {number} [page] Page number.
+         * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+         * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
+            return localVarFp.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Delete an incoming invoice by id
+         * @param {number} id Item id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdDelete(id, options) {
+            return localVarFp.receiveIdDelete(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+         * @summary Get an incoming invoice by id
+         * @param {number} id Item id
+         * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        receiveIdGet(id, includePayload, options) {
+            return localVarFp.receiveIdGet(id, includePayload, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ReceiveApi - object-oriented interface
+ * @export
+ * @class ReceiveApi
+ * @extends {BaseAPI}
+ */
+export class ReceiveApi extends BaseAPI {
+    /**
+     * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+     * @summary List incoming invoices
+     * @param {number} [companyId] Company id
+     * @param {string} [identifier] SDI identifier.
+     * @param {boolean} [unread] Unread items only.
+     * @param {string} [committente] Vat number or fiscal code.
+     * @param {string} [prestatore] Vat number or fiscal code.
+     * @param {string} [fileName] File name.
+     * @param {string} [lastUpdateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [lastUpdateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [dateSentFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [dateSentTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentNumber] Document number.
+     * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReceiveApi
+     */
+    receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
+        return ReceiveApiFp(this.configuration).receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+     * @summary Delete an incoming invoice by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReceiveApi
+     */
+    receiveIdDelete(id, options) {
+        return ReceiveApiFp(this.configuration).receiveIdDelete(id, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+     * @summary Get an incoming invoice by id
+     * @param {number} id Item id
+     * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReceiveApi
+     */
+    receiveIdGet(id, includePayload, options) {
+        return ReceiveApiFp(this.configuration).receiveIdGet(id, includePayload, options).then((request) => request(this.axios, this.basePath));
+    }
+}