@invoicetronic/ts-sdk 1.1.7 → 1.3.0

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

@@ -35,7 +35,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
 export const CompanyApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a paginated list of companies.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary List companies
          * @param {number} [page] Page number.
          * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -76,13 +76,14 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Delete a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.  **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks.  If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
          * @summary Delete a company
          * @param {number} id Item id
+         * @param {boolean} [force] Force delete including all related data.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        companyIdDelete: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+        companyIdDelete: (id_1, force_1, ...args_1) => __awaiter(this, [id_1, force_1, ...args_1], void 0, function* (id, force, options = {}) {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('companyIdDelete', 'id', id);
             const localVarPath = `/company/{id}`
@@ -99,6 +100,9 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
             // authentication Basic required
             // http basic authentication required
             setBasicAuthToObject(localVarRequestOptions, configuration);
+            if (force !== undefined) {
+                localVarQueryParameter['force'] = force;
+            }
             localVarHeaderParameter['Accept'] = 'application/json';
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -109,7 +113,7 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Get a company by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -142,7 +146,7 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Add a new company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Add a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -176,7 +180,7 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Update an existing company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Update a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -218,7 +222,7 @@ export const CompanyApiFp = function (configuration) {
     const localVarAxiosParamCreator = CompanyApiAxiosParamCreator(configuration);
     return {
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a paginated list of companies.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary List companies
          * @param {number} [page] Page number.
          * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -236,23 +240,24 @@ export const CompanyApiFp = function (configuration) {
             });
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Delete a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.  **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks.  If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
          * @summary Delete a company
          * @param {number} id Item id
+         * @param {boolean} [force] Force delete including all related data.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        companyIdDelete(id, options) {
+        companyIdDelete(id, force, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.companyIdDelete(id, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.companyIdDelete(id, force, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CompanyApi.companyIdDelete']) === 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);
             });
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Get a company by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -268,7 +273,7 @@ export const CompanyApiFp = function (configuration) {
             });
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Add a new company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Add a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -284,7 +289,7 @@ export const CompanyApiFp = function (configuration) {
             });
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Update an existing company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Update a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -308,7 +313,7 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
     const localVarFp = CompanyApiFp(configuration);
     return {
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a paginated list of companies.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary List companies
          * @param {number} [page] Page number.
          * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -320,17 +325,18 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
             return localVarFp.companyGet(page, pageSize, sort, options).then((request) => request(axios, basePath));
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Delete a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.  **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks.  If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
          * @summary Delete a company
          * @param {number} id Item id
+         * @param {boolean} [force] Force delete including all related data.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        companyIdDelete(id, options) {
-            return localVarFp.companyIdDelete(id, options).then((request) => request(axios, basePath));
+        companyIdDelete(id, force, options) {
+            return localVarFp.companyIdDelete(id, force, options).then((request) => request(axios, basePath));
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Retrieve a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Get a company by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -340,7 +346,7 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
             return localVarFp.companyIdGet(id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Add a new company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Add a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -350,7 +356,7 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
             return localVarFp.companyPost(company, options).then((request) => request(axios, basePath));
         },
         /**
-         * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+         * Update an existing company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
          * @summary Update a company
          * @param {Company} company
          * @param {*} [options] Override http request option.
@@ -366,7 +372,7 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
  */
 export class CompanyApi extends BaseAPI {
     /**
-     * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+     * Retrieve a paginated list of companies.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
      * @summary List companies
      * @param {number} [page] Page number.
      * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -378,17 +384,18 @@ export class CompanyApi extends BaseAPI {
         return CompanyApiFp(this.configuration).companyGet(page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+     * Delete a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.  **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks.  If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
      * @summary Delete a company
      * @param {number} id Item id
+     * @param {boolean} [force] Force delete including all related data.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    companyIdDelete(id, options) {
-        return CompanyApiFp(this.configuration).companyIdDelete(id, options).then((request) => request(this.axios, this.basePath));
+    companyIdDelete(id, force, options) {
+        return CompanyApiFp(this.configuration).companyIdDelete(id, force, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+     * Retrieve a company by its internal id.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
      * @summary Get a company by id
      * @param {number} id Item id
      * @param {*} [options] Override http request option.
@@ -398,7 +405,7 @@ export class CompanyApi extends BaseAPI {
         return CompanyApiFp(this.configuration).companyIdGet(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+     * Add a new company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
      * @summary Add a company
      * @param {Company} company
      * @param {*} [options] Override http request option.
@@ -408,7 +415,7 @@ export class CompanyApi extends BaseAPI {
         return CompanyApiFp(this.configuration).companyPost(company, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+     * Update an existing company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
      * @summary Update a company
      * @param {Company} company
      * @param {*} [options] Override http request option.

package/dist/esm/src/api/export-api.d.ts

@@ -0,0 +1,115 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+/**
+ * ExportApi - axios parameter creator
+ */
+export declare const ExportApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet: (type?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExportApi - functional programming interface
+ */
+export declare const ExportApiFp: (configuration?: Configuration) => {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet(type?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ExportApi - factory interface
+ */
+export declare const ExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet(type?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ExportApi - interface
+ */
+export interface ExportApiInterface {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet(type?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+}
+/**
+ * ExportApi - object-oriented interface
+ */
+export declare class ExportApi extends BaseAPI implements ExportApiInterface {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet(type?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}
+export declare const ExportGetTypeEnum: {
+    readonly Send: "Send";
+    readonly Receive: "Receive";
+    readonly Both: "Both";
+};
+export type ExportGetTypeEnum = typeof ExportGetTypeEnum[keyof typeof ExportGetTypeEnum];

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

@@ -0,0 +1,179 @@
+/* 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, setBasicAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
+/**
+ * ExportApi - axios parameter creator
+ */
+export const ExportApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+         * @summary Export invoices as a ZIP archive
+         * @param {ExportGetTypeEnum} [type]
+         * @param {number} [companyId] Company id
+         * @param {number} [year]
+         * @param {number} [month]
+         * @param {number} [quarter]
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportGet: (type_1, companyId_1, year_1, month_1, quarter_1, documentDateFrom_1, documentDateTo_1, ...args_1) => __awaiter(this, [type_1, companyId_1, year_1, month_1, quarter_1, documentDateFrom_1, documentDateTo_1, ...args_1], void 0, function* (type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options = {}) {
+            const localVarPath = `/export`;
+            // 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 (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (companyId !== undefined) {
+                localVarQueryParameter['company_id'] = companyId;
+            }
+            if (year !== undefined) {
+                localVarQueryParameter['year'] = year;
+            }
+            if (month !== undefined) {
+                localVarQueryParameter['month'] = month;
+            }
+            if (quarter !== undefined) {
+                localVarQueryParameter['quarter'] = quarter;
+            }
+            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;
+            }
+            localVarHeaderParameter['Accept'] = 'application/problem+json';
+            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,
+            };
+        }),
+    };
+};
+/**
+ * ExportApi - functional programming interface
+ */
+export const ExportApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ExportApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+         * @summary Export invoices as a ZIP archive
+         * @param {ExportGetTypeEnum} [type]
+         * @param {number} [companyId] Company id
+         * @param {number} [year]
+         * @param {number} [month]
+         * @param {number} [quarter]
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExportApi.exportGet']) === 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);
+            });
+        },
+    };
+};
+/**
+ * ExportApi - factory interface
+ */
+export const ExportApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ExportApiFp(configuration);
+    return {
+        /**
+         * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+         * @summary Export invoices as a ZIP archive
+         * @param {ExportGetTypeEnum} [type]
+         * @param {number} [companyId] Company id
+         * @param {number} [year]
+         * @param {number} [month]
+         * @param {number} [quarter]
+         * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options) {
+            return localVarFp.exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ExportApi - object-oriented interface
+ */
+export class ExportApi extends BaseAPI {
+    /**
+     * Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).  **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded.  **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations.  ### Period filters  You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range  These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`.  ### Response  Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`).  ### Rate limiting  This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
+     * @summary Export invoices as a ZIP archive
+     * @param {ExportGetTypeEnum} [type]
+     * @param {number} [companyId] Company id
+     * @param {number} [year]
+     * @param {number} [month]
+     * @param {number} [quarter]
+     * @param {string} [documentDateFrom] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {string} [documentDateTo] UTC ISO 8601 (2024-11-29T12:34:56Z)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options) {
+        return ExportApiFp(this.configuration).exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+export const ExportGetTypeEnum = {
+    Send: 'Send',
+    Receive: 'Receive',
+    Both: 'Both'
+};