@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.
Files changed (90) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +2 -2
  3. package/api.ts +1 -0
  4. package/configuration.ts +1 -1
  5. package/dist/api.d.ts +1 -0
  6. package/dist/api.js +1 -0
  7. package/dist/configuration.js +1 -1
  8. package/dist/esm/api.d.ts +1 -0
  9. package/dist/esm/api.js +1 -0
  10. package/dist/esm/configuration.js +1 -1
  11. package/dist/esm/src/api/company-api.d.ts +15 -10
  12. package/dist/esm/src/api/company-api.js +18 -11
  13. package/dist/esm/src/api/export-api.d.ts +10 -16
  14. package/dist/esm/src/api/export-api.js +4 -9
  15. package/dist/esm/src/api/health-api.d.ts +74 -0
  16. package/dist/esm/src/api/health-api.js +120 -0
  17. package/dist/esm/src/api/receive-api.d.ts +15 -10
  18. package/dist/esm/src/api/receive-api.js +18 -11
  19. package/dist/esm/src/api/send-api.d.ts +55 -51
  20. package/dist/esm/src/api/send-api.js +74 -67
  21. package/dist/esm/src/api/update-api.d.ts +10 -10
  22. package/dist/esm/src/api/update-api.js +8 -8
  23. package/dist/esm/src/models/document-data.d.ts +15 -0
  24. package/dist/esm/src/models/document-data.js +14 -0
  25. package/dist/esm/src/models/index.d.ts +5 -0
  26. package/dist/esm/src/models/index.js +5 -0
  27. package/dist/esm/src/models/model-error.d.ts +28 -0
  28. package/dist/esm/src/models/model-error.js +14 -0
  29. package/dist/esm/src/models/problem-details.d.ts +19 -0
  30. package/dist/esm/src/models/problem-details.js +14 -0
  31. package/dist/esm/src/models/problem-http-result.d.ts +17 -0
  32. package/dist/esm/src/models/problem-http-result.js +14 -0
  33. package/dist/esm/src/models/receive.d.ts +4 -0
  34. package/dist/esm/src/models/send-reduced.d.ts +39 -0
  35. package/dist/esm/src/models/send-reduced.js +14 -0
  36. package/dist/esm/src/models/send.d.ts +4 -0
  37. package/dist/src/api/company-api.d.ts +15 -10
  38. package/dist/src/api/company-api.js +18 -11
  39. package/dist/src/api/export-api.d.ts +10 -16
  40. package/dist/src/api/export-api.js +5 -10
  41. package/dist/src/api/health-api.d.ts +74 -0
  42. package/dist/src/api/health-api.js +127 -0
  43. package/dist/src/api/receive-api.d.ts +15 -10
  44. package/dist/src/api/receive-api.js +18 -11
  45. package/dist/src/api/send-api.d.ts +55 -51
  46. package/dist/src/api/send-api.js +74 -67
  47. package/dist/src/api/update-api.d.ts +10 -10
  48. package/dist/src/api/update-api.js +8 -8
  49. package/dist/src/models/document-data.d.ts +15 -0
  50. package/dist/src/models/document-data.js +15 -0
  51. package/dist/src/models/index.d.ts +5 -0
  52. package/dist/src/models/index.js +5 -0
  53. package/dist/src/models/model-error.d.ts +28 -0
  54. package/dist/src/models/model-error.js +15 -0
  55. package/dist/src/models/problem-details.d.ts +19 -0
  56. package/dist/src/models/problem-details.js +15 -0
  57. package/dist/src/models/problem-http-result.d.ts +17 -0
  58. package/dist/src/models/problem-http-result.js +15 -0
  59. package/dist/src/models/receive.d.ts +4 -0
  60. package/dist/src/models/send-reduced.d.ts +39 -0
  61. package/dist/src/models/send-reduced.js +15 -0
  62. package/dist/src/models/send.d.ts +4 -0
  63. package/docs/CompanyApi.md +5 -2
  64. package/docs/DocumentData.md +22 -0
  65. package/docs/Error.md +25 -0
  66. package/docs/ExportApi.md +2 -2
  67. package/docs/HealthApi.md +54 -0
  68. package/docs/ProblemDetails.md +28 -0
  69. package/docs/ProblemHttpResult.md +24 -0
  70. package/docs/Receive.md +2 -0
  71. package/docs/ReceiveApi.md +5 -2
  72. package/docs/Send.md +2 -0
  73. package/docs/SendApi.md +25 -26
  74. package/docs/SendReduced.md +29 -0
  75. package/docs/UpdateApi.md +2 -2
  76. package/package.json +1 -1
  77. package/src/api/company-api.ts +22 -13
  78. package/src/api/export-api.ts +10 -16
  79. package/src/api/health-api.ts +135 -0
  80. package/src/api/receive-api.ts +22 -13
  81. package/src/api/send-api.ts +86 -79
  82. package/src/api/update-api.ts +10 -10
  83. package/src/models/document-data.ts +21 -0
  84. package/src/models/index.ts +5 -0
  85. package/src/models/model-error.ts +34 -0
  86. package/src/models/problem-details.ts +26 -0
  87. package/src/models/problem-http-result.ts +25 -0
  88. package/src/models/receive.ts +4 -0
  89. package/src/models/send-reduced.ts +45 -0
  90. package/src/models/send.ts +4 -0
package/CHANGELOG.md CHANGED
@@ -1 +1 @@
1
- # Changelog\n\n## [1.4.0] - 2026-02-25\nSee main repository changelog for details.
1
+ # Changelog\n\n## [1.5.0] - 2026-03-12\nSee main repository changelog for details.
package/README.md CHANGED
@@ -7,7 +7,7 @@ For more information, see [Invoicetronic website][2]
7
7
  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/
8
8
  [2]: https://invoicetronic.com/
9
9
 
10
- ## @invoicetronic/ts-sdk@1.4
10
+ ## @invoicetronic/ts-sdk@1.5
11
11
 
12
12
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
13
13
 
@@ -45,7 +45,7 @@ navigate to the folder of your consuming project and run one of the following co
45
45
  _published:_
46
46
 
47
47
  ```
48
- npm install @invoicetronic/ts-sdk@1.4 --save
48
+ npm install @invoicetronic/ts-sdk@1.5 --save
49
49
  ```
50
50
 
51
51
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -16,6 +16,7 @@
16
16
 
17
17
  export * from './src/api/company-api';
18
18
  export * from './src/api/export-api';
19
+ export * from './src/api/health-api';
19
20
  export * from './src/api/log-api';
20
21
  export * from './src/api/receive-api';
21
22
  export * from './src/api/send-api';
package/configuration.ts CHANGED
@@ -98,7 +98,7 @@ export class Configuration {
98
98
  this.baseOptions = {
99
99
  ...param.baseOptions,
100
100
  headers: {
101
- 'User-Agent': "Invoicetronic/1.4/TypeScript-SDK",
101
+ 'User-Agent': "Invoicetronic/1.5/TypeScript-SDK",
102
102
  ...param.baseOptions?.headers,
103
103
  },
104
104
  };
package/dist/api.d.ts CHANGED
@@ -11,6 +11,7 @@
11
11
  */
12
12
  export * from './src/api/company-api';
13
13
  export * from './src/api/export-api';
14
+ export * from './src/api/health-api';
14
15
  export * from './src/api/log-api';
15
16
  export * from './src/api/receive-api';
16
17
  export * from './src/api/send-api';
package/dist/api.js CHANGED
@@ -29,6 +29,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
30
  __exportStar(require("./src/api/company-api"), exports);
31
31
  __exportStar(require("./src/api/export-api"), exports);
32
+ __exportStar(require("./src/api/health-api"), exports);
32
33
  __exportStar(require("./src/api/log-api"), exports);
33
34
  __exportStar(require("./src/api/receive-api"), exports);
34
35
  __exportStar(require("./src/api/send-api"), exports);
@@ -23,7 +23,7 @@ class Configuration {
23
23
  this.awsv4 = param.awsv4;
24
24
  this.basePath = param.basePath;
25
25
  this.serverIndex = param.serverIndex;
26
- this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "Invoicetronic/1.4/TypeScript-SDK" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
26
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "Invoicetronic/1.5/TypeScript-SDK" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
27
27
  this.formDataCtor = param.formDataCtor;
28
28
  }
29
29
  /**
package/dist/esm/api.d.ts CHANGED
@@ -11,6 +11,7 @@
11
11
  */
12
12
  export * from './src/api/company-api';
13
13
  export * from './src/api/export-api';
14
+ export * from './src/api/health-api';
14
15
  export * from './src/api/log-api';
15
16
  export * from './src/api/receive-api';
16
17
  export * from './src/api/send-api';
package/dist/esm/api.js CHANGED
@@ -13,6 +13,7 @@
13
13
  */
14
14
  export * from './src/api/company-api';
15
15
  export * from './src/api/export-api';
16
+ export * from './src/api/health-api';
16
17
  export * from './src/api/log-api';
17
18
  export * from './src/api/receive-api';
18
19
  export * from './src/api/send-api';
@@ -20,7 +20,7 @@ export class Configuration {
20
20
  this.awsv4 = param.awsv4;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
- this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "Invoicetronic/1.4/TypeScript-SDK" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
23
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "Invoicetronic/1.5/TypeScript-SDK" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
24
24
  this.formDataCtor = param.formDataCtor;
25
25
  }
26
26
  /**
@@ -18,15 +18,16 @@ import type { Company } from '../../src/models';
18
18
  */
19
19
  export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * 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.
21
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
22
22
  * @summary List companies
23
23
  * @param {number} [page] Page number.
24
24
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
25
25
  * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
26
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
26
27
  * @param {*} [options] Override http request option.
27
28
  * @throws {RequiredError}
28
29
  */
29
- companyGet: (page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
+ companyGet: (page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
31
  /**
31
32
  * 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.
32
33
  * @summary Delete a company
@@ -74,15 +75,16 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
74
75
  */
75
76
  export declare const CompanyApiFp: (configuration?: Configuration) => {
76
77
  /**
77
- * 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.
78
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
78
79
  * @summary List companies
79
80
  * @param {number} [page] Page number.
80
81
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
81
82
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
83
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
82
84
  * @param {*} [options] Override http request option.
83
85
  * @throws {RequiredError}
84
86
  */
85
- companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Company>>>;
87
+ companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Company>>>;
86
88
  /**
87
89
  * 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.
88
90
  * @summary Delete a company
@@ -130,15 +132,16 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
130
132
  */
131
133
  export declare const CompanyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
132
134
  /**
133
- * 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.
135
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
134
136
  * @summary List companies
135
137
  * @param {number} [page] Page number.
136
138
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
137
139
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
140
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
138
141
  * @param {*} [options] Override http request option.
139
142
  * @throws {RequiredError}
140
143
  */
141
- companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
144
+ companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
142
145
  /**
143
146
  * 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.
144
147
  * @summary Delete a company
@@ -186,15 +189,16 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
186
189
  */
187
190
  export interface CompanyApiInterface {
188
191
  /**
189
- * 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.
192
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
190
193
  * @summary List companies
191
194
  * @param {number} [page] Page number.
192
195
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
193
196
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
197
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
194
198
  * @param {*} [options] Override http request option.
195
199
  * @throws {RequiredError}
196
200
  */
197
- companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
201
+ companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
198
202
  /**
199
203
  * 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.
200
204
  * @summary Delete a company
@@ -242,15 +246,16 @@ export interface CompanyApiInterface {
242
246
  */
243
247
  export declare class CompanyApi extends BaseAPI implements CompanyApiInterface {
244
248
  /**
245
- * 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.
249
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
246
250
  * @summary List companies
247
251
  * @param {number} [page] Page number.
248
252
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
249
253
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
254
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
250
255
  * @param {*} [options] Override http request option.
251
256
  * @throws {RequiredError}
252
257
  */
253
- companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company[], any, {}>>;
258
+ companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company[], any, {}>>;
254
259
  /**
255
260
  * 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.
256
261
  * @summary Delete a company
@@ -35,15 +35,16 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
35
35
  export const CompanyApiAxiosParamCreator = function (configuration) {
36
36
  return {
37
37
  /**
38
- * 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.
38
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
39
39
  * @summary List companies
40
40
  * @param {number} [page] Page number.
41
41
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
42
42
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
43
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
43
44
  * @param {*} [options] Override http request option.
44
45
  * @throws {RequiredError}
45
46
  */
46
- companyGet: (page_1, pageSize_1, sort_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, sort_1, ...args_1], void 0, function* (page, pageSize, sort, options = {}) {
47
+ companyGet: (page_1, pageSize_1, sort_1, q_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, sort_1, q_1, ...args_1], void 0, function* (page, pageSize, sort, q, options = {}) {
47
48
  const localVarPath = `/company`;
48
49
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
49
50
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -66,6 +67,9 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
66
67
  if (sort !== undefined) {
67
68
  localVarQueryParameter['sort'] = sort;
68
69
  }
70
+ if (q !== undefined) {
71
+ localVarQueryParameter['q'] = q;
72
+ }
69
73
  localVarHeaderParameter['Accept'] = 'application/json';
70
74
  setSearchParams(localVarUrlObj, localVarQueryParameter);
71
75
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -255,18 +259,19 @@ export const CompanyApiFp = function (configuration) {
255
259
  const localVarAxiosParamCreator = CompanyApiAxiosParamCreator(configuration);
256
260
  return {
257
261
  /**
258
- * 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.
262
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
259
263
  * @summary List companies
260
264
  * @param {number} [page] Page number.
261
265
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
262
266
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
267
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
263
268
  * @param {*} [options] Override http request option.
264
269
  * @throws {RequiredError}
265
270
  */
266
- companyGet(page, pageSize, sort, options) {
271
+ companyGet(page, pageSize, sort, q, options) {
267
272
  return __awaiter(this, void 0, void 0, function* () {
268
273
  var _a, _b, _c;
269
- const localVarAxiosArgs = yield localVarAxiosParamCreator.companyGet(page, pageSize, sort, options);
274
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.companyGet(page, pageSize, sort, q, options);
270
275
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
271
276
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CompanyApi.companyGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
272
277
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -362,16 +367,17 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
362
367
  const localVarFp = CompanyApiFp(configuration);
363
368
  return {
364
369
  /**
365
- * 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.
370
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
366
371
  * @summary List companies
367
372
  * @param {number} [page] Page number.
368
373
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
369
374
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
375
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
370
376
  * @param {*} [options] Override http request option.
371
377
  * @throws {RequiredError}
372
378
  */
373
- companyGet(page, pageSize, sort, options) {
374
- return localVarFp.companyGet(page, pageSize, sort, options).then((request) => request(axios, basePath));
379
+ companyGet(page, pageSize, sort, q, options) {
380
+ return localVarFp.companyGet(page, pageSize, sort, q, options).then((request) => request(axios, basePath));
375
381
  },
376
382
  /**
377
383
  * 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.
@@ -431,16 +437,17 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
431
437
  */
432
438
  export class CompanyApi extends BaseAPI {
433
439
  /**
434
- * 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.
440
+ * Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
435
441
  * @summary List companies
436
442
  * @param {number} [page] Page number.
437
443
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
438
444
  * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
445
+ * @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
439
446
  * @param {*} [options] Override http request option.
440
447
  * @throws {RequiredError}
441
448
  */
442
- companyGet(page, pageSize, sort, options) {
443
- return CompanyApiFp(this.configuration).companyGet(page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
449
+ companyGet(page, pageSize, sort, q, options) {
450
+ return CompanyApiFp(this.configuration).companyGet(page, pageSize, sort, q, options).then((request) => request(this.axios, this.basePath));
444
451
  }
445
452
  /**
446
453
  * 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.
@@ -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 {ExportGetTypeEnum} [type]
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?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
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 {ExportGetTypeEnum} [type]
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?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
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 {ExportGetTypeEnum} [type]
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?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
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 {ExportGetTypeEnum} [type]
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?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
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 {ExportGetTypeEnum} [type]
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?: ExportGetTypeEnum, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
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];
@@ -37,7 +37,7 @@ export const ExportApiAxiosParamCreator = function (configuration) {
37
37
  /**
38
38
  * 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.
39
39
  * @summary Export invoices as a ZIP archive
40
- * @param {ExportGetTypeEnum} [type]
40
+ * @param {string} [type]
41
41
  * @param {number} [companyId] Company id
42
42
  * @param {number} [year]
43
43
  * @param {number} [month]
@@ -106,7 +106,7 @@ export const ExportApiFp = function (configuration) {
106
106
  /**
107
107
  * 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.
108
108
  * @summary Export invoices as a ZIP archive
109
- * @param {ExportGetTypeEnum} [type]
109
+ * @param {string} [type]
110
110
  * @param {number} [companyId] Company id
111
111
  * @param {number} [year]
112
112
  * @param {number} [month]
@@ -136,7 +136,7 @@ export const ExportApiFactory = function (configuration, basePath, axios) {
136
136
  /**
137
137
  * 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.
138
138
  * @summary Export invoices as a ZIP archive
139
- * @param {ExportGetTypeEnum} [type]
139
+ * @param {string} [type]
140
140
  * @param {number} [companyId] Company id
141
141
  * @param {number} [year]
142
142
  * @param {number} [month]
@@ -158,7 +158,7 @@ export class ExportApi extends BaseAPI {
158
158
  /**
159
159
  * 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.
160
160
  * @summary Export invoices as a ZIP archive
161
- * @param {ExportGetTypeEnum} [type]
161
+ * @param {string} [type]
162
162
  * @param {number} [companyId] Company id
163
163
  * @param {number} [year]
164
164
  * @param {number} [month]
@@ -172,8 +172,3 @@ export class ExportApi extends BaseAPI {
172
172
  return ExportApiFp(this.configuration).exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options).then((request) => request(this.axios, this.basePath));
173
173
  }
174
174
  }
175
- export const ExportGetTypeEnum = {
176
- Send: 'Send',
177
- Receive: 'Receive',
178
- Both: 'Both'
179
- };
@@ -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
+ }