@invoicetronic/ts-sdk 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -1
- package/README.md +2 -2
- package/api.ts +1 -0
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/src/api/company-api.d.ts +15 -10
- package/dist/esm/src/api/company-api.js +18 -11
- package/dist/esm/src/api/export-api.d.ts +10 -16
- package/dist/esm/src/api/export-api.js +4 -9
- package/dist/esm/src/api/health-api.d.ts +74 -0
- package/dist/esm/src/api/health-api.js +120 -0
- package/dist/esm/src/api/receive-api.d.ts +15 -10
- package/dist/esm/src/api/receive-api.js +18 -11
- package/dist/esm/src/api/send-api.d.ts +55 -51
- package/dist/esm/src/api/send-api.js +74 -67
- package/dist/esm/src/api/update-api.d.ts +10 -10
- package/dist/esm/src/api/update-api.js +8 -8
- package/dist/esm/src/models/document-data.d.ts +15 -0
- package/dist/esm/src/models/document-data.js +14 -0
- package/dist/esm/src/models/index.d.ts +5 -0
- package/dist/esm/src/models/index.js +5 -0
- package/dist/esm/src/models/model-error.d.ts +28 -0
- package/dist/esm/src/models/model-error.js +14 -0
- package/dist/esm/src/models/problem-details.d.ts +19 -0
- package/dist/esm/src/models/problem-details.js +14 -0
- package/dist/esm/src/models/problem-http-result.d.ts +17 -0
- package/dist/esm/src/models/problem-http-result.js +14 -0
- package/dist/esm/src/models/receive.d.ts +4 -0
- package/dist/esm/src/models/send-reduced.d.ts +39 -0
- package/dist/esm/src/models/send-reduced.js +14 -0
- package/dist/esm/src/models/send.d.ts +4 -0
- package/dist/src/api/company-api.d.ts +15 -10
- package/dist/src/api/company-api.js +18 -11
- package/dist/src/api/export-api.d.ts +10 -16
- package/dist/src/api/export-api.js +5 -10
- package/dist/src/api/health-api.d.ts +74 -0
- package/dist/src/api/health-api.js +127 -0
- package/dist/src/api/receive-api.d.ts +15 -10
- package/dist/src/api/receive-api.js +18 -11
- package/dist/src/api/send-api.d.ts +55 -51
- package/dist/src/api/send-api.js +74 -67
- package/dist/src/api/update-api.d.ts +10 -10
- package/dist/src/api/update-api.js +8 -8
- package/dist/src/models/document-data.d.ts +15 -0
- package/dist/src/models/document-data.js +15 -0
- package/dist/src/models/index.d.ts +5 -0
- package/dist/src/models/index.js +5 -0
- package/dist/src/models/model-error.d.ts +28 -0
- package/dist/src/models/model-error.js +15 -0
- package/dist/src/models/problem-details.d.ts +19 -0
- package/dist/src/models/problem-details.js +15 -0
- package/dist/src/models/problem-http-result.d.ts +17 -0
- package/dist/src/models/problem-http-result.js +15 -0
- package/dist/src/models/receive.d.ts +4 -0
- package/dist/src/models/send-reduced.d.ts +39 -0
- package/dist/src/models/send-reduced.js +15 -0
- package/dist/src/models/send.d.ts +4 -0
- package/docs/CompanyApi.md +5 -2
- package/docs/DocumentData.md +22 -0
- package/docs/Error.md +25 -0
- package/docs/ExportApi.md +2 -2
- package/docs/HealthApi.md +54 -0
- package/docs/ProblemDetails.md +28 -0
- package/docs/ProblemHttpResult.md +24 -0
- package/docs/Receive.md +2 -0
- package/docs/ReceiveApi.md +5 -2
- package/docs/Send.md +2 -0
- package/docs/SendApi.md +25 -26
- package/docs/SendReduced.md +29 -0
- package/docs/UpdateApi.md +2 -2
- package/package.json +1 -1
- package/src/api/company-api.ts +22 -13
- package/src/api/export-api.ts +10 -16
- package/src/api/health-api.ts +135 -0
- package/src/api/receive-api.ts +22 -13
- package/src/api/send-api.ts +86 -79
- package/src/api/update-api.ts +10 -10
- package/src/models/document-data.ts +21 -0
- package/src/models/index.ts +5 -0
- package/src/models/model-error.ts +34 -0
- package/src/models/problem-details.ts +26 -0
- package/src/models/problem-http-result.ts +25 -0
- package/src/models/receive.ts +4 -0
- package/src/models/send-reduced.ts +45 -0
- package/src/models/send.ts +4 -0
|
@@ -19,7 +19,7 @@ export declare const ExportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
19
19
|
/**
|
|
20
20
|
* 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.
|
|
21
21
|
* @summary Export invoices as a ZIP archive
|
|
22
|
-
* @param {
|
|
22
|
+
* @param {string} [type]
|
|
23
23
|
* @param {number} [companyId] Company id
|
|
24
24
|
* @param {number} [year]
|
|
25
25
|
* @param {number} [month]
|
|
@@ -29,7 +29,7 @@ export declare const ExportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
31
31
|
*/
|
|
32
|
-
exportGet: (type?:
|
|
32
|
+
exportGet: (type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
};
|
|
34
34
|
/**
|
|
35
35
|
* ExportApi - functional programming interface
|
|
@@ -38,7 +38,7 @@ export declare const ExportApiFp: (configuration?: Configuration) => {
|
|
|
38
38
|
/**
|
|
39
39
|
* 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.
|
|
40
40
|
* @summary Export invoices as a ZIP archive
|
|
41
|
-
* @param {
|
|
41
|
+
* @param {string} [type]
|
|
42
42
|
* @param {number} [companyId] Company id
|
|
43
43
|
* @param {number} [year]
|
|
44
44
|
* @param {number} [month]
|
|
@@ -48,7 +48,7 @@ export declare const ExportApiFp: (configuration?: Configuration) => {
|
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
49
49
|
* @throws {RequiredError}
|
|
50
50
|
*/
|
|
51
|
-
exportGet(type?:
|
|
51
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
52
52
|
};
|
|
53
53
|
/**
|
|
54
54
|
* ExportApi - factory interface
|
|
@@ -57,7 +57,7 @@ export declare const ExportApiFactory: (configuration?: Configuration, basePath?
|
|
|
57
57
|
/**
|
|
58
58
|
* 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.
|
|
59
59
|
* @summary Export invoices as a ZIP archive
|
|
60
|
-
* @param {
|
|
60
|
+
* @param {string} [type]
|
|
61
61
|
* @param {number} [companyId] Company id
|
|
62
62
|
* @param {number} [year]
|
|
63
63
|
* @param {number} [month]
|
|
@@ -67,7 +67,7 @@ export declare const ExportApiFactory: (configuration?: Configuration, basePath?
|
|
|
67
67
|
* @param {*} [options] Override http request option.
|
|
68
68
|
* @throws {RequiredError}
|
|
69
69
|
*/
|
|
70
|
-
exportGet(type?:
|
|
70
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
71
71
|
};
|
|
72
72
|
/**
|
|
73
73
|
* ExportApi - interface
|
|
@@ -76,7 +76,7 @@ export interface ExportApiInterface {
|
|
|
76
76
|
/**
|
|
77
77
|
* 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.
|
|
78
78
|
* @summary Export invoices as a ZIP archive
|
|
79
|
-
* @param {
|
|
79
|
+
* @param {string} [type]
|
|
80
80
|
* @param {number} [companyId] Company id
|
|
81
81
|
* @param {number} [year]
|
|
82
82
|
* @param {number} [month]
|
|
@@ -86,7 +86,7 @@ export interface ExportApiInterface {
|
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
87
87
|
* @throws {RequiredError}
|
|
88
88
|
*/
|
|
89
|
-
exportGet(type?:
|
|
89
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
92
|
* ExportApi - object-oriented interface
|
|
@@ -95,7 +95,7 @@ export declare class ExportApi extends BaseAPI implements ExportApiInterface {
|
|
|
95
95
|
/**
|
|
96
96
|
* 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.
|
|
97
97
|
* @summary Export invoices as a ZIP archive
|
|
98
|
-
* @param {
|
|
98
|
+
* @param {string} [type]
|
|
99
99
|
* @param {number} [companyId] Company id
|
|
100
100
|
* @param {number} [year]
|
|
101
101
|
* @param {number} [month]
|
|
@@ -105,11 +105,5 @@ export declare class ExportApi extends BaseAPI implements ExportApiInterface {
|
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
108
|
-
exportGet(type?:
|
|
108
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
109
109
|
}
|
|
110
|
-
export declare const ExportGetTypeEnum: {
|
|
111
|
-
readonly Send: "Send";
|
|
112
|
-
readonly Receive: "Receive";
|
|
113
|
-
readonly Both: "Both";
|
|
114
|
-
};
|
|
115
|
-
export type ExportGetTypeEnum = typeof ExportGetTypeEnum[keyof typeof ExportGetTypeEnum];
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.ExportApi = exports.ExportApiFactory = exports.ExportApiFp = exports.ExportApiAxiosParamCreator = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// URLSearchParams not necessarily used
|
|
28
28
|
// @ts-ignore
|
|
@@ -40,7 +40,7 @@ const ExportApiAxiosParamCreator = function (configuration) {
|
|
|
40
40
|
/**
|
|
41
41
|
* 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.
|
|
42
42
|
* @summary Export invoices as a ZIP archive
|
|
43
|
-
* @param {
|
|
43
|
+
* @param {string} [type]
|
|
44
44
|
* @param {number} [companyId] Company id
|
|
45
45
|
* @param {number} [year]
|
|
46
46
|
* @param {number} [month]
|
|
@@ -110,7 +110,7 @@ const ExportApiFp = function (configuration) {
|
|
|
110
110
|
/**
|
|
111
111
|
* 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.
|
|
112
112
|
* @summary Export invoices as a ZIP archive
|
|
113
|
-
* @param {
|
|
113
|
+
* @param {string} [type]
|
|
114
114
|
* @param {number} [companyId] Company id
|
|
115
115
|
* @param {number} [year]
|
|
116
116
|
* @param {number} [month]
|
|
@@ -141,7 +141,7 @@ const ExportApiFactory = function (configuration, basePath, axios) {
|
|
|
141
141
|
/**
|
|
142
142
|
* 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.
|
|
143
143
|
* @summary Export invoices as a ZIP archive
|
|
144
|
-
* @param {
|
|
144
|
+
* @param {string} [type]
|
|
145
145
|
* @param {number} [companyId] Company id
|
|
146
146
|
* @param {number} [year]
|
|
147
147
|
* @param {number} [month]
|
|
@@ -164,7 +164,7 @@ class ExportApi extends base_1.BaseAPI {
|
|
|
164
164
|
/**
|
|
165
165
|
* 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.
|
|
166
166
|
* @summary Export invoices as a ZIP archive
|
|
167
|
-
* @param {
|
|
167
|
+
* @param {string} [type]
|
|
168
168
|
* @param {number} [companyId] Company id
|
|
169
169
|
* @param {number} [year]
|
|
170
170
|
* @param {number} [month]
|
|
@@ -179,8 +179,3 @@ class ExportApi extends base_1.BaseAPI {
|
|
|
179
179
|
}
|
|
180
180
|
}
|
|
181
181
|
exports.ExportApi = ExportApi;
|
|
182
|
-
exports.ExportGetTypeEnum = {
|
|
183
|
-
Send: 'Send',
|
|
184
|
-
Receive: 'Receive',
|
|
185
|
-
Both: 'Both'
|
|
186
|
-
};
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* 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/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../../base';
|
|
15
|
+
/**
|
|
16
|
+
* HealthApi - axios parameter creator
|
|
17
|
+
*/
|
|
18
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19
|
+
/**
|
|
20
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
21
|
+
* @summary Health check
|
|
22
|
+
* @param {*} [options] Override http request option.
|
|
23
|
+
* @throws {RequiredError}
|
|
24
|
+
*/
|
|
25
|
+
healthGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* HealthApi - functional programming interface
|
|
29
|
+
*/
|
|
30
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
31
|
+
/**
|
|
32
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
33
|
+
* @summary Health check
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
healthGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* HealthApi - factory interface
|
|
41
|
+
*/
|
|
42
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
43
|
+
/**
|
|
44
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
45
|
+
* @summary Health check
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
healthGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* HealthApi - interface
|
|
53
|
+
*/
|
|
54
|
+
export interface HealthApiInterface {
|
|
55
|
+
/**
|
|
56
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
57
|
+
* @summary Health check
|
|
58
|
+
* @param {*} [options] Override http request option.
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
healthGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* HealthApi - object-oriented interface
|
|
65
|
+
*/
|
|
66
|
+
export declare class HealthApi extends BaseAPI implements HealthApiInterface {
|
|
67
|
+
/**
|
|
68
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
69
|
+
* @summary Health check
|
|
70
|
+
* @param {*} [options] Override http request option.
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
healthGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
74
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* 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/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// URLSearchParams not necessarily used
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const url_1 = require("url");
|
|
30
|
+
// Some imports not used depending on template conditions
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
const common_1 = require("../../common");
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
const base_1 = require("../../base");
|
|
35
|
+
/**
|
|
36
|
+
* HealthApi - axios parameter creator
|
|
37
|
+
*/
|
|
38
|
+
const HealthApiAxiosParamCreator = function (configuration) {
|
|
39
|
+
return {
|
|
40
|
+
/**
|
|
41
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
42
|
+
* @summary Health check
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
healthGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
47
|
+
const localVarPath = `/health`;
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
if (configuration) {
|
|
52
|
+
baseOptions = configuration.baseOptions;
|
|
53
|
+
}
|
|
54
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
55
|
+
const localVarHeaderParameter = {};
|
|
56
|
+
const localVarQueryParameter = {};
|
|
57
|
+
// authentication Basic required
|
|
58
|
+
// http basic authentication required
|
|
59
|
+
(0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
|
|
60
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
61
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
63
|
+
return {
|
|
64
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
65
|
+
options: localVarRequestOptions,
|
|
66
|
+
};
|
|
67
|
+
}),
|
|
68
|
+
};
|
|
69
|
+
};
|
|
70
|
+
exports.HealthApiAxiosParamCreator = HealthApiAxiosParamCreator;
|
|
71
|
+
/**
|
|
72
|
+
* HealthApi - functional programming interface
|
|
73
|
+
*/
|
|
74
|
+
const HealthApiFp = function (configuration) {
|
|
75
|
+
const localVarAxiosParamCreator = (0, exports.HealthApiAxiosParamCreator)(configuration);
|
|
76
|
+
return {
|
|
77
|
+
/**
|
|
78
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
79
|
+
* @summary Health check
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
healthGet(options) {
|
|
84
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85
|
+
var _a, _b, _c;
|
|
86
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.healthGet(options);
|
|
87
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
88
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['HealthApi.healthGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
89
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
90
|
+
});
|
|
91
|
+
},
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
exports.HealthApiFp = HealthApiFp;
|
|
95
|
+
/**
|
|
96
|
+
* HealthApi - factory interface
|
|
97
|
+
*/
|
|
98
|
+
const HealthApiFactory = function (configuration, basePath, axios) {
|
|
99
|
+
const localVarFp = (0, exports.HealthApiFp)(configuration);
|
|
100
|
+
return {
|
|
101
|
+
/**
|
|
102
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
103
|
+
* @summary Health check
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
healthGet(options) {
|
|
108
|
+
return localVarFp.healthGet(options).then((request) => request(axios, basePath));
|
|
109
|
+
},
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
exports.HealthApiFactory = HealthApiFactory;
|
|
113
|
+
/**
|
|
114
|
+
* HealthApi - object-oriented interface
|
|
115
|
+
*/
|
|
116
|
+
class HealthApi extends base_1.BaseAPI {
|
|
117
|
+
/**
|
|
118
|
+
* Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
119
|
+
* @summary Health check
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
healthGet(options) {
|
|
124
|
+
return (0, exports.HealthApiFp)(this.configuration).healthGet(options).then((request) => request(this.axios, this.basePath));
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
exports.HealthApi = HealthApi;
|
|
@@ -18,7 +18,7 @@ import type { Receive } from '../../src/models';
|
|
|
18
18
|
*/
|
|
19
19
|
export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
20
|
/**
|
|
21
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
21
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
22
22
|
* @summary List incoming invoices
|
|
23
23
|
* @param {number} [companyId] Company id
|
|
24
24
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -37,10 +37,11 @@ export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration
|
|
|
37
37
|
* @param {number} [page] Page number.
|
|
38
38
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
39
39
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
40
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
40
41
|
* @param {*} [options] Override http request option.
|
|
41
42
|
* @throws {RequiredError}
|
|
42
43
|
*/
|
|
43
|
-
receiveGet: (companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
receiveGet: (companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
45
|
/**
|
|
45
46
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
46
47
|
* @summary Delete an incoming invoice by id
|
|
@@ -72,7 +73,7 @@ export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration
|
|
|
72
73
|
*/
|
|
73
74
|
export declare const ReceiveApiFp: (configuration?: Configuration) => {
|
|
74
75
|
/**
|
|
75
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
76
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
76
77
|
* @summary List incoming invoices
|
|
77
78
|
* @param {number} [companyId] Company id
|
|
78
79
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -91,10 +92,11 @@ export declare const ReceiveApiFp: (configuration?: Configuration) => {
|
|
|
91
92
|
* @param {number} [page] Page number.
|
|
92
93
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
93
94
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
95
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
94
96
|
* @param {*} [options] Override http request option.
|
|
95
97
|
* @throws {RequiredError}
|
|
96
98
|
*/
|
|
97
|
-
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Receive>>>;
|
|
99
|
+
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Receive>>>;
|
|
98
100
|
/**
|
|
99
101
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
100
102
|
* @summary Delete an incoming invoice by id
|
|
@@ -126,7 +128,7 @@ export declare const ReceiveApiFp: (configuration?: Configuration) => {
|
|
|
126
128
|
*/
|
|
127
129
|
export declare const ReceiveApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
128
130
|
/**
|
|
129
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
131
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
130
132
|
* @summary List incoming invoices
|
|
131
133
|
* @param {number} [companyId] Company id
|
|
132
134
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -145,10 +147,11 @@ export declare const ReceiveApiFactory: (configuration?: Configuration, basePath
|
|
|
145
147
|
* @param {number} [page] Page number.
|
|
146
148
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
147
149
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
150
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
148
151
|
* @param {*} [options] Override http request option.
|
|
149
152
|
* @throws {RequiredError}
|
|
150
153
|
*/
|
|
151
|
-
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
|
|
154
|
+
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
|
|
152
155
|
/**
|
|
153
156
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
154
157
|
* @summary Delete an incoming invoice by id
|
|
@@ -180,7 +183,7 @@ export declare const ReceiveApiFactory: (configuration?: Configuration, basePath
|
|
|
180
183
|
*/
|
|
181
184
|
export interface ReceiveApiInterface {
|
|
182
185
|
/**
|
|
183
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
186
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
184
187
|
* @summary List incoming invoices
|
|
185
188
|
* @param {number} [companyId] Company id
|
|
186
189
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -199,10 +202,11 @@ export interface ReceiveApiInterface {
|
|
|
199
202
|
* @param {number} [page] Page number.
|
|
200
203
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
201
204
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
205
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
202
206
|
* @param {*} [options] Override http request option.
|
|
203
207
|
* @throws {RequiredError}
|
|
204
208
|
*/
|
|
205
|
-
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
|
|
209
|
+
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
|
|
206
210
|
/**
|
|
207
211
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
208
212
|
* @summary Delete an incoming invoice by id
|
|
@@ -234,7 +238,7 @@ export interface ReceiveApiInterface {
|
|
|
234
238
|
*/
|
|
235
239
|
export declare class ReceiveApi extends BaseAPI implements ReceiveApiInterface {
|
|
236
240
|
/**
|
|
237
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
241
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
238
242
|
* @summary List incoming invoices
|
|
239
243
|
* @param {number} [companyId] Company id
|
|
240
244
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -253,10 +257,11 @@ export declare class ReceiveApi extends BaseAPI implements ReceiveApiInterface {
|
|
|
253
257
|
* @param {number} [page] Page number.
|
|
254
258
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
255
259
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
260
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
256
261
|
* @param {*} [options] Override http request option.
|
|
257
262
|
* @throws {RequiredError}
|
|
258
263
|
*/
|
|
259
|
-
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Receive[], any, {}>>;
|
|
264
|
+
receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Receive[], any, {}>>;
|
|
260
265
|
/**
|
|
261
266
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
262
267
|
* @summary Delete an incoming invoice by id
|
|
@@ -38,7 +38,7 @@ const base_1 = require("../../base");
|
|
|
38
38
|
const ReceiveApiAxiosParamCreator = function (configuration) {
|
|
39
39
|
return {
|
|
40
40
|
/**
|
|
41
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
41
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
42
42
|
* @summary List incoming invoices
|
|
43
43
|
* @param {number} [companyId] Company id
|
|
44
44
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -57,10 +57,11 @@ const ReceiveApiAxiosParamCreator = function (configuration) {
|
|
|
57
57
|
* @param {number} [page] Page number.
|
|
58
58
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
59
59
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
60
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
60
61
|
* @param {*} [options] Override http request option.
|
|
61
62
|
* @throws {RequiredError}
|
|
62
63
|
*/
|
|
63
|
-
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 = {}) {
|
|
64
|
+
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, q_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, q_1, ...args_1], void 0, function* (companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options = {}) {
|
|
64
65
|
const localVarPath = `/receive`;
|
|
65
66
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66
67
|
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -137,6 +138,9 @@ const ReceiveApiAxiosParamCreator = function (configuration) {
|
|
|
137
138
|
if (sort !== undefined) {
|
|
138
139
|
localVarQueryParameter['sort'] = sort;
|
|
139
140
|
}
|
|
141
|
+
if (q !== undefined) {
|
|
142
|
+
localVarQueryParameter['q'] = q;
|
|
143
|
+
}
|
|
140
144
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
141
145
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
142
146
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -259,7 +263,7 @@ const ReceiveApiFp = function (configuration) {
|
|
|
259
263
|
const localVarAxiosParamCreator = (0, exports.ReceiveApiAxiosParamCreator)(configuration);
|
|
260
264
|
return {
|
|
261
265
|
/**
|
|
262
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
266
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
263
267
|
* @summary List incoming invoices
|
|
264
268
|
* @param {number} [companyId] Company id
|
|
265
269
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -278,13 +282,14 @@ const ReceiveApiFp = function (configuration) {
|
|
|
278
282
|
* @param {number} [page] Page number.
|
|
279
283
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
280
284
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
285
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
281
286
|
* @param {*} [options] Override http request option.
|
|
282
287
|
* @throws {RequiredError}
|
|
283
288
|
*/
|
|
284
|
-
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
|
|
289
|
+
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options) {
|
|
285
290
|
return __awaiter(this, void 0, void 0, function* () {
|
|
286
291
|
var _a, _b, _c;
|
|
287
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options);
|
|
292
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options);
|
|
288
293
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
289
294
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReceiveApi.receiveGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
290
295
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -349,7 +354,7 @@ const ReceiveApiFactory = function (configuration, basePath, axios) {
|
|
|
349
354
|
const localVarFp = (0, exports.ReceiveApiFp)(configuration);
|
|
350
355
|
return {
|
|
351
356
|
/**
|
|
352
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
357
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
353
358
|
* @summary List incoming invoices
|
|
354
359
|
* @param {number} [companyId] Company id
|
|
355
360
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -368,11 +373,12 @@ const ReceiveApiFactory = function (configuration, basePath, axios) {
|
|
|
368
373
|
* @param {number} [page] Page number.
|
|
369
374
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
370
375
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
376
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
371
377
|
* @param {*} [options] Override http request option.
|
|
372
378
|
* @throws {RequiredError}
|
|
373
379
|
*/
|
|
374
|
-
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
|
|
375
|
-
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));
|
|
380
|
+
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options) {
|
|
381
|
+
return localVarFp.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options).then((request) => request(axios, basePath));
|
|
376
382
|
},
|
|
377
383
|
/**
|
|
378
384
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
@@ -413,7 +419,7 @@ exports.ReceiveApiFactory = ReceiveApiFactory;
|
|
|
413
419
|
*/
|
|
414
420
|
class ReceiveApi extends base_1.BaseAPI {
|
|
415
421
|
/**
|
|
416
|
-
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
422
|
+
* Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
417
423
|
* @summary List incoming invoices
|
|
418
424
|
* @param {number} [companyId] Company id
|
|
419
425
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -432,11 +438,12 @@ class ReceiveApi extends base_1.BaseAPI {
|
|
|
432
438
|
* @param {number} [page] Page number.
|
|
433
439
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
434
440
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
441
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
435
442
|
* @param {*} [options] Override http request option.
|
|
436
443
|
* @throws {RequiredError}
|
|
437
444
|
*/
|
|
438
|
-
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options) {
|
|
439
|
-
return (0, exports.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));
|
|
445
|
+
receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options) {
|
|
446
|
+
return (0, exports.ReceiveApiFp)(this.configuration).receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, q, options).then((request) => request(this.axios, this.basePath));
|
|
440
447
|
}
|
|
441
448
|
/**
|
|
442
449
|
* Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|