@invoicetronic/ts-sdk 1.1.7 → 1.3.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 (88) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +2 -2
  3. package/api.ts +1 -0
  4. package/common.ts +15 -2
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +1 -0
  7. package/dist/api.js +1 -0
  8. package/dist/common.d.ts +6 -0
  9. package/dist/common.js +17 -3
  10. package/dist/configuration.js +1 -1
  11. package/dist/esm/api.d.ts +1 -0
  12. package/dist/esm/api.js +1 -0
  13. package/dist/esm/common.d.ts +6 -0
  14. package/dist/esm/common.js +15 -2
  15. package/dist/esm/configuration.js +1 -1
  16. package/dist/esm/src/api/company-api.d.ts +35 -30
  17. package/dist/esm/src/api/company-api.js +34 -27
  18. package/dist/esm/src/api/export-api.d.ts +115 -0
  19. package/dist/esm/src/api/export-api.js +179 -0
  20. package/dist/esm/src/api/log-api.d.ts +10 -10
  21. package/dist/esm/src/api/log-api.js +8 -8
  22. package/dist/esm/src/api/receive-api.d.ts +15 -15
  23. package/dist/esm/src/api/receive-api.js +12 -12
  24. package/dist/esm/src/api/send-api.d.ts +55 -55
  25. package/dist/esm/src/api/send-api.js +44 -44
  26. package/dist/esm/src/api/status-api.d.ts +5 -5
  27. package/dist/esm/src/api/status-api.js +4 -4
  28. package/dist/esm/src/api/update-api.d.ts +10 -10
  29. package/dist/esm/src/api/update-api.js +8 -8
  30. package/dist/esm/src/api/webhook-api.d.ts +25 -25
  31. package/dist/esm/src/api/webhook-api.js +20 -20
  32. package/dist/esm/src/models/event.d.ts +2 -2
  33. package/dist/esm/src/models/receive.d.ts +3 -3
  34. package/dist/esm/src/models/send.d.ts +2 -2
  35. package/dist/esm/src/models/update.d.ts +2 -2
  36. package/dist/esm/src/models/web-hook-history.d.ts +1 -1
  37. package/dist/esm/src/models/web-hook.d.ts +2 -2
  38. package/dist/src/api/company-api.d.ts +35 -30
  39. package/dist/src/api/company-api.js +34 -27
  40. package/dist/src/api/export-api.d.ts +115 -0
  41. package/dist/src/api/export-api.js +186 -0
  42. package/dist/src/api/log-api.d.ts +10 -10
  43. package/dist/src/api/log-api.js +8 -8
  44. package/dist/src/api/receive-api.d.ts +15 -15
  45. package/dist/src/api/receive-api.js +12 -12
  46. package/dist/src/api/send-api.d.ts +55 -55
  47. package/dist/src/api/send-api.js +44 -44
  48. package/dist/src/api/status-api.d.ts +5 -5
  49. package/dist/src/api/status-api.js +4 -4
  50. package/dist/src/api/update-api.d.ts +10 -10
  51. package/dist/src/api/update-api.js +8 -8
  52. package/dist/src/api/webhook-api.d.ts +25 -25
  53. package/dist/src/api/webhook-api.js +20 -20
  54. package/dist/src/models/event.d.ts +2 -2
  55. package/dist/src/models/receive.d.ts +3 -3
  56. package/dist/src/models/send.d.ts +2 -2
  57. package/dist/src/models/update.d.ts +2 -2
  58. package/dist/src/models/web-hook-history.d.ts +1 -1
  59. package/dist/src/models/web-hook.d.ts +2 -2
  60. package/docs/CompanyApi.md +10 -6
  61. package/docs/Event.md +2 -2
  62. package/docs/ExportApi.md +79 -0
  63. package/docs/LogApi.md +2 -2
  64. package/docs/Receive.md +3 -3
  65. package/docs/ReceiveApi.md +4 -3
  66. package/docs/Send.md +2 -2
  67. package/docs/SendApi.md +11 -11
  68. package/docs/StatusApi.md +1 -1
  69. package/docs/Update.md +2 -2
  70. package/docs/UpdateApi.md +2 -2
  71. package/docs/WebHook.md +2 -2
  72. package/docs/WebHookHistory.md +1 -1
  73. package/docs/WebhookApi.md +6 -5
  74. package/package.json +1 -1
  75. package/src/api/company-api.ts +43 -34
  76. package/src/api/export-api.ts +211 -0
  77. package/src/api/log-api.ts +11 -11
  78. package/src/api/receive-api.ts +16 -16
  79. package/src/api/send-api.ts +56 -56
  80. package/src/api/status-api.ts +6 -6
  81. package/src/api/update-api.ts +11 -11
  82. package/src/api/webhook-api.ts +26 -26
  83. package/src/models/event.ts +2 -2
  84. package/src/models/receive.ts +3 -3
  85. package/src/models/send.ts +2 -2
  86. package/src/models/update.ts +2 -2
  87. package/src/models/web-hook-history.ts +1 -1
  88. package/src/models/web-hook.ts +2 -2
@@ -21,7 +21,7 @@ import globalAxios from 'axios';
21
21
  import { URL, URLSearchParams } from 'url';
22
22
  // Some imports not used depending on template conditions
23
23
  // @ts-ignore
24
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../../common';
24
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../../common';
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../../base';
27
27
  // @ts-ignore
@@ -32,7 +32,7 @@ import type { Status } from '../../src/models';
32
32
  export const StatusApiAxiosParamCreator = function (configuration?: Configuration) {
33
33
  return {
34
34
  /**
35
- * This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com). __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
35
+ * Retrieve the number of operations (invoices + validations) and signatures left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response when trying to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can also check your account status from the [Dashboard](https://dashboard.invoicetronic.com), where you can purchase additional operations and/or signatures. **Please note** that these values are not enforced if you are on the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
36
36
  * @summary Account status
37
37
  * @param {*} [options] Override http request option.
38
38
  * @throws {RequiredError}
@@ -75,7 +75,7 @@ export const StatusApiFp = function(configuration?: Configuration) {
75
75
  const localVarAxiosParamCreator = StatusApiAxiosParamCreator(configuration)
76
76
  return {
77
77
  /**
78
- * This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com). __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
78
+ * Retrieve the number of operations (invoices + validations) and signatures left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response when trying to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can also check your account status from the [Dashboard](https://dashboard.invoicetronic.com), where you can purchase additional operations and/or signatures. **Please note** that these values are not enforced if you are on the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
79
79
  * @summary Account status
80
80
  * @param {*} [options] Override http request option.
81
81
  * @throws {RequiredError}
@@ -96,7 +96,7 @@ export const StatusApiFactory = function (configuration?: Configuration, basePat
96
96
  const localVarFp = StatusApiFp(configuration)
97
97
  return {
98
98
  /**
99
- * This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com). __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
99
+ * Retrieve the number of operations (invoices + validations) and signatures left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response when trying to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can also check your account status from the [Dashboard](https://dashboard.invoicetronic.com), where you can purchase additional operations and/or signatures. **Please note** that these values are not enforced if you are on the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
100
100
  * @summary Account status
101
101
  * @param {*} [options] Override http request option.
102
102
  * @throws {RequiredError}
@@ -112,7 +112,7 @@ export const StatusApiFactory = function (configuration?: Configuration, basePat
112
112
  */
113
113
  export interface StatusApiInterface {
114
114
  /**
115
- * This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com). __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
115
+ * Retrieve the number of operations (invoices + validations) and signatures left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response when trying to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can also check your account status from the [Dashboard](https://dashboard.invoicetronic.com), where you can purchase additional operations and/or signatures. **Please note** that these values are not enforced if you are on the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
116
116
  * @summary Account status
117
117
  * @param {*} [options] Override http request option.
118
118
  * @throws {RequiredError}
@@ -126,7 +126,7 @@ export interface StatusApiInterface {
126
126
  */
127
127
  export class StatusApi extends BaseAPI implements StatusApiInterface {
128
128
  /**
129
- * This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com). __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
129
+ * Retrieve the number of operations (invoices + validations) and signatures left on your account. When `signature_left` is 0, you will receive a `403 Forbidden` response when trying to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice. You can also check your account status from the [Dashboard](https://dashboard.invoicetronic.com), where you can purchase additional operations and/or signatures. **Please note** that these values are not enforced if you are on the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
130
130
  * @summary Account status
131
131
  * @param {*} [options] Override http request option.
132
132
  * @throws {RequiredError}
@@ -21,7 +21,7 @@ import globalAxios from 'axios';
21
21
  import { URL, URLSearchParams } from 'url';
22
22
  // Some imports not used depending on template conditions
23
23
  // @ts-ignore
24
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../../common';
24
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../../common';
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../../base';
27
27
  // @ts-ignore
@@ -34,7 +34,7 @@ import type { Update } from '../../src/models';
34
34
  export const UpdateApiAxiosParamCreator = function (configuration?: Configuration) {
35
35
  return {
36
36
  /**
37
- * Updates are notifications sent by the SDI about the status of invoices you sent.
37
+ * Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
38
38
  * @summary List updates
39
39
  * @param {number} [companyId] Company id
40
40
  * @param {string} [identifier] SDI identifier.
@@ -141,7 +141,7 @@ export const UpdateApiAxiosParamCreator = function (configuration?: Configuratio
141
141
  };
142
142
  },
143
143
  /**
144
- * Updates are notifications sent by the SDI about the status of invoices you sent.
144
+ * Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
145
145
  * @summary Get an update by id
146
146
  * @param {number} id Item id
147
147
  * @param {*} [options] Override http request option.
@@ -188,7 +188,7 @@ export const UpdateApiFp = function(configuration?: Configuration) {
188
188
  const localVarAxiosParamCreator = UpdateApiAxiosParamCreator(configuration)
189
189
  return {
190
190
  /**
191
- * Updates are notifications sent by the SDI about the status of invoices you sent.
191
+ * Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
192
192
  * @summary List updates
193
193
  * @param {number} [companyId] Company id
194
194
  * @param {string} [identifier] SDI identifier.
@@ -213,7 +213,7 @@ export const UpdateApiFp = function(configuration?: Configuration) {
213
213
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
214
214
  },
215
215
  /**
216
- * Updates are notifications sent by the SDI about the status of invoices you sent.
216
+ * Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
217
217
  * @summary Get an update by id
218
218
  * @param {number} id Item id
219
219
  * @param {*} [options] Override http request option.
@@ -235,7 +235,7 @@ export const UpdateApiFactory = function (configuration?: Configuration, basePat
235
235
  const localVarFp = UpdateApiFp(configuration)
236
236
  return {
237
237
  /**
238
- * Updates are notifications sent by the SDI about the status of invoices you sent.
238
+ * Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
239
239
  * @summary List updates
240
240
  * @param {number} [companyId] Company id
241
241
  * @param {string} [identifier] SDI identifier.
@@ -257,7 +257,7 @@ export const UpdateApiFactory = function (configuration?: Configuration, basePat
257
257
  return localVarFp.updateGet(companyId, identifier, prestatore, unread, sendId, state, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, page, pageSize, sort, options).then((request) => request(axios, basePath));
258
258
  },
259
259
  /**
260
- * Updates are notifications sent by the SDI about the status of invoices you sent.
260
+ * Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
261
261
  * @summary Get an update by id
262
262
  * @param {number} id Item id
263
263
  * @param {*} [options] Override http request option.
@@ -274,7 +274,7 @@ export const UpdateApiFactory = function (configuration?: Configuration, basePat
274
274
  */
275
275
  export interface UpdateApiInterface {
276
276
  /**
277
- * Updates are notifications sent by the SDI about the status of invoices you sent.
277
+ * Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
278
278
  * @summary List updates
279
279
  * @param {number} [companyId] Company id
280
280
  * @param {string} [identifier] SDI identifier.
@@ -295,7 +295,7 @@ export interface UpdateApiInterface {
295
295
  updateGet(companyId?: number, identifier?: string, prestatore?: string, unread?: boolean, sendId?: number, state?: UpdateGetStateEnum, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Update>>;
296
296
 
297
297
  /**
298
- * Updates are notifications sent by the SDI about the status of invoices you sent.
298
+ * Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
299
299
  * @summary Get an update by id
300
300
  * @param {number} id Item id
301
301
  * @param {*} [options] Override http request option.
@@ -310,7 +310,7 @@ export interface UpdateApiInterface {
310
310
  */
311
311
  export class UpdateApi extends BaseAPI implements UpdateApiInterface {
312
312
  /**
313
- * Updates are notifications sent by the SDI about the status of invoices you sent.
313
+ * Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
314
314
  * @summary List updates
315
315
  * @param {number} [companyId] Company id
316
316
  * @param {string} [identifier] SDI identifier.
@@ -333,7 +333,7 @@ export class UpdateApi extends BaseAPI implements UpdateApiInterface {
333
333
  }
334
334
 
335
335
  /**
336
- * Updates are notifications sent by the SDI about the status of invoices you sent.
336
+ * Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
337
337
  * @summary Get an update by id
338
338
  * @param {number} id Item id
339
339
  * @param {*} [options] Override http request option.
@@ -21,7 +21,7 @@ import globalAxios from 'axios';
21
21
  import { URL, URLSearchParams } from 'url';
22
22
  // Some imports not used depending on template conditions
23
23
  // @ts-ignore
24
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../../common';
24
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../../common';
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../../base';
27
27
  // @ts-ignore
@@ -38,7 +38,7 @@ import type { WebHookHistory } from '../../src/models';
38
38
  export const WebhookApiAxiosParamCreator = function (configuration?: Configuration) {
39
39
  return {
40
40
  /**
41
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
41
+ * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
42
42
  * @summary List webhooks
43
43
  * @param {number} [companyId] Company id
44
44
  * @param {number} [page] Page number.
@@ -112,7 +112,7 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati
112
112
  };
113
113
  },
114
114
  /**
115
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
115
+ * Delete a webhook subscription by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
116
116
  * @summary Delete a webhook by id
117
117
  * @param {number} id Item id
118
118
  * @param {*} [options] Override http request option.
@@ -150,7 +150,7 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati
150
150
  };
151
151
  },
152
152
  /**
153
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
153
+ * Retrieve a webhook by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
154
154
  * @summary Get a webhook by id
155
155
  * @param {number} id Item id
156
156
  * @param {*} [options] Override http request option.
@@ -188,7 +188,7 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati
188
188
  };
189
189
  },
190
190
  /**
191
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
191
+ * Create a new webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
192
192
  * @summary Add a webhook
193
193
  * @param {WebHook} webHook
194
194
  * @param {*} [options] Override http request option.
@@ -227,7 +227,7 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati
227
227
  };
228
228
  },
229
229
  /**
230
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
230
+ * Update an existing webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
231
231
  * @summary Update a webhook
232
232
  * @param {WebHook} webHook
233
233
  * @param {*} [options] Override http request option.
@@ -367,7 +367,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
367
367
  const localVarAxiosParamCreator = WebhookApiAxiosParamCreator(configuration)
368
368
  return {
369
369
  /**
370
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
370
+ * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
371
371
  * @summary List webhooks
372
372
  * @param {number} [companyId] Company id
373
373
  * @param {number} [page] Page number.
@@ -387,7 +387,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
387
387
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
388
388
  },
389
389
  /**
390
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
390
+ * Delete a webhook subscription by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
391
391
  * @summary Delete a webhook by id
392
392
  * @param {number} id Item id
393
393
  * @param {*} [options] Override http request option.
@@ -400,7 +400,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
400
400
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
401
401
  },
402
402
  /**
403
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
403
+ * Retrieve a webhook by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
404
404
  * @summary Get a webhook by id
405
405
  * @param {number} id Item id
406
406
  * @param {*} [options] Override http request option.
@@ -413,7 +413,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
413
413
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
414
414
  },
415
415
  /**
416
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
416
+ * Create a new webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
417
417
  * @summary Add a webhook
418
418
  * @param {WebHook} webHook
419
419
  * @param {*} [options] Override http request option.
@@ -426,7 +426,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
426
426
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
427
427
  },
428
428
  /**
429
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
429
+ * Update an existing webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
430
430
  * @summary Update a webhook
431
431
  * @param {WebHook} webHook
432
432
  * @param {*} [options] Override http request option.
@@ -477,7 +477,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
477
477
  const localVarFp = WebhookApiFp(configuration)
478
478
  return {
479
479
  /**
480
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
480
+ * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
481
481
  * @summary List webhooks
482
482
  * @param {number} [companyId] Company id
483
483
  * @param {number} [page] Page number.
@@ -494,7 +494,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
494
494
  return localVarFp.webhookGet(companyId, page, pageSize, sort, description, enabled, events, url, options).then((request) => request(axios, basePath));
495
495
  },
496
496
  /**
497
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
497
+ * Delete a webhook subscription by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
498
498
  * @summary Delete a webhook by id
499
499
  * @param {number} id Item id
500
500
  * @param {*} [options] Override http request option.
@@ -504,7 +504,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
504
504
  return localVarFp.webhookIdDelete(id, options).then((request) => request(axios, basePath));
505
505
  },
506
506
  /**
507
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
507
+ * Retrieve a webhook by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
508
508
  * @summary Get a webhook by id
509
509
  * @param {number} id Item id
510
510
  * @param {*} [options] Override http request option.
@@ -514,7 +514,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
514
514
  return localVarFp.webhookIdGet(id, options).then((request) => request(axios, basePath));
515
515
  },
516
516
  /**
517
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
517
+ * Create a new webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
518
518
  * @summary Add a webhook
519
519
  * @param {WebHook} webHook
520
520
  * @param {*} [options] Override http request option.
@@ -524,7 +524,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
524
524
  return localVarFp.webhookPost(webHook, options).then((request) => request(axios, basePath));
525
525
  },
526
526
  /**
527
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
527
+ * Update an existing webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
528
528
  * @summary Update a webhook
529
529
  * @param {WebHook} webHook
530
530
  * @param {*} [options] Override http request option.
@@ -564,7 +564,7 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa
564
564
  */
565
565
  export interface WebhookApiInterface {
566
566
  /**
567
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
567
+ * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
568
568
  * @summary List webhooks
569
569
  * @param {number} [companyId] Company id
570
570
  * @param {number} [page] Page number.
@@ -580,7 +580,7 @@ export interface WebhookApiInterface {
580
580
  webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHook>>;
581
581
 
582
582
  /**
583
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
583
+ * Delete a webhook subscription by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
584
584
  * @summary Delete a webhook by id
585
585
  * @param {number} id Item id
586
586
  * @param {*} [options] Override http request option.
@@ -589,7 +589,7 @@ export interface WebhookApiInterface {
589
589
  webhookIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
590
590
 
591
591
  /**
592
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
592
+ * Retrieve a webhook by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
593
593
  * @summary Get a webhook by id
594
594
  * @param {number} id Item id
595
595
  * @param {*} [options] Override http request option.
@@ -598,7 +598,7 @@ export interface WebhookApiInterface {
598
598
  webhookIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
599
599
 
600
600
  /**
601
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
601
+ * Create a new webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
602
602
  * @summary Add a webhook
603
603
  * @param {WebHook} webHook
604
604
  * @param {*} [options] Override http request option.
@@ -607,7 +607,7 @@ export interface WebhookApiInterface {
607
607
  webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
608
608
 
609
609
  /**
610
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
610
+ * Update an existing webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
611
611
  * @summary Update a webhook
612
612
  * @param {WebHook} webHook
613
613
  * @param {*} [options] Override http request option.
@@ -643,7 +643,7 @@ export interface WebhookApiInterface {
643
643
  */
644
644
  export class WebhookApi extends BaseAPI implements WebhookApiInterface {
645
645
  /**
646
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
646
+ * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
647
647
  * @summary List webhooks
648
648
  * @param {number} [companyId] Company id
649
649
  * @param {number} [page] Page number.
@@ -661,7 +661,7 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
661
661
  }
662
662
 
663
663
  /**
664
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
664
+ * Delete a webhook subscription by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
665
665
  * @summary Delete a webhook by id
666
666
  * @param {number} id Item id
667
667
  * @param {*} [options] Override http request option.
@@ -672,7 +672,7 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
672
672
  }
673
673
 
674
674
  /**
675
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
675
+ * Retrieve a webhook by its internal id. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
676
676
  * @summary Get a webhook by id
677
677
  * @param {number} id Item id
678
678
  * @param {*} [options] Override http request option.
@@ -683,7 +683,7 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
683
683
  }
684
684
 
685
685
  /**
686
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
686
+ * Create a new webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
687
687
  * @summary Add a webhook
688
688
  * @param {WebHook} webHook
689
689
  * @param {*} [options] Override http request option.
@@ -694,7 +694,7 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
694
694
  }
695
695
 
696
696
  /**
697
- * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
697
+ * Update an existing webhook subscription. **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com). For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
698
698
  * @summary Update a webhook
699
699
  * @param {WebHook} webHook
700
700
  * @param {*} [options] Override http request option.
@@ -68,7 +68,7 @@ export interface Event {
68
68
  */
69
69
  'resource_id'?: number | null;
70
70
  /**
71
- * Wether the request was successful.
71
+ * Whether the request was successful.
72
72
  */
73
73
  'success'?: boolean;
74
74
  /**
@@ -76,7 +76,7 @@ export interface Event {
76
76
  */
77
77
  'query'?: string | null;
78
78
  /**
79
- * Response payload. It is guaranteed to be cyphered at rest.
79
+ * Response payload. It is guaranteed to be encrypted at rest.
80
80
  */
81
81
  'response_body'?: string | null;
82
82
  }
@@ -47,7 +47,7 @@ export interface Receive {
47
47
  */
48
48
  'prestatore'?: string | null;
49
49
  /**
50
- * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
50
+ * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
51
51
  */
52
52
  'identifier'?: string | null;
53
53
  /**
@@ -59,7 +59,7 @@ export interface Receive {
59
59
  */
60
60
  'format'?: string | null;
61
61
  /**
62
- * Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest.
62
+ * Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest.
63
63
  */
64
64
  'payload': string;
65
65
  /**
@@ -79,7 +79,7 @@ export interface Receive {
79
79
  */
80
80
  'encoding'?: ReceiveEncodingEnum;
81
81
  /**
82
- * Wether the invoice has been read at least once.
82
+ * Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true.
83
83
  */
84
84
  'is_read'?: boolean;
85
85
  /**
@@ -50,7 +50,7 @@ export interface Send {
50
50
  */
51
51
  'prestatore'?: string | null;
52
52
  /**
53
- * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
53
+ * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
54
54
  */
55
55
  'identifier'?: string | null;
56
56
  /**
@@ -62,7 +62,7 @@ export interface Send {
62
62
  */
63
63
  'format'?: string | null;
64
64
  /**
65
- * Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest.
65
+ * Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest.
66
66
  */
67
67
  'payload': string;
68
68
  /**
@@ -47,7 +47,7 @@ export interface Update {
47
47
  */
48
48
  'last_update'?: string;
49
49
  /**
50
- * State of the document. Theses are the possible values, as per the SDI documentation:
50
+ * State of the document. These are the possible values, as per the SDI documentation:
51
51
  */
52
52
  'state'?: UpdateStateEnum;
53
53
  /**
@@ -63,7 +63,7 @@ export interface Update {
63
63
  */
64
64
  'errors'?: Array<Error> | null;
65
65
  /**
66
- * Wether the item has been read at least once.
66
+ * Whether the item has been read at least once.
67
67
  */
68
68
  'is_read'?: boolean;
69
69
  'send'?: SendReduced;
@@ -51,7 +51,7 @@ export interface WebHookHistory {
51
51
  */
52
52
  'date_time'?: string;
53
53
  /**
54
- * Wether the request was successful.
54
+ * Whether the request was successful.
55
55
  */
56
56
  'success'?: boolean;
57
57
  }
@@ -40,7 +40,7 @@ export interface WebHook {
40
40
  */
41
41
  'url': string;
42
42
  /**
43
- * Wether the webhook is enabled. On creation, this is set to `true`.
43
+ * Whether the webhook is enabled. On creation, this is set to `true`.
44
44
  */
45
45
  'enabled'?: boolean;
46
46
  /**
@@ -52,7 +52,7 @@ export interface WebHook {
52
52
  */
53
53
  'description'?: string | null;
54
54
  /**
55
- * List of events to that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.
55
+ * List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.
56
56
  */
57
57
  'events'?: Array<string> | null;
58
58
  }