@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.
- package/CHANGELOG.md +1 -1
- package/README.md +2 -2
- package/api.ts +1 -0
- package/common.ts +15 -2
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/common.d.ts +6 -0
- package/dist/common.js +17 -3
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/common.d.ts +6 -0
- package/dist/esm/common.js +15 -2
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/src/api/company-api.d.ts +35 -30
- package/dist/esm/src/api/company-api.js +34 -27
- package/dist/esm/src/api/export-api.d.ts +115 -0
- package/dist/esm/src/api/export-api.js +179 -0
- package/dist/esm/src/api/log-api.d.ts +10 -10
- package/dist/esm/src/api/log-api.js +8 -8
- package/dist/esm/src/api/receive-api.d.ts +15 -15
- package/dist/esm/src/api/receive-api.js +12 -12
- package/dist/esm/src/api/send-api.d.ts +55 -55
- package/dist/esm/src/api/send-api.js +44 -44
- package/dist/esm/src/api/status-api.d.ts +5 -5
- package/dist/esm/src/api/status-api.js +4 -4
- package/dist/esm/src/api/update-api.d.ts +10 -10
- package/dist/esm/src/api/update-api.js +8 -8
- package/dist/esm/src/api/webhook-api.d.ts +25 -25
- package/dist/esm/src/api/webhook-api.js +20 -20
- package/dist/esm/src/models/event.d.ts +2 -2
- package/dist/esm/src/models/receive.d.ts +3 -3
- package/dist/esm/src/models/send.d.ts +2 -2
- package/dist/esm/src/models/update.d.ts +2 -2
- package/dist/esm/src/models/web-hook-history.d.ts +1 -1
- package/dist/esm/src/models/web-hook.d.ts +2 -2
- package/dist/src/api/company-api.d.ts +35 -30
- package/dist/src/api/company-api.js +34 -27
- package/dist/src/api/export-api.d.ts +115 -0
- package/dist/src/api/export-api.js +186 -0
- package/dist/src/api/log-api.d.ts +10 -10
- package/dist/src/api/log-api.js +8 -8
- package/dist/src/api/receive-api.d.ts +15 -15
- package/dist/src/api/receive-api.js +12 -12
- package/dist/src/api/send-api.d.ts +55 -55
- package/dist/src/api/send-api.js +44 -44
- package/dist/src/api/status-api.d.ts +5 -5
- package/dist/src/api/status-api.js +4 -4
- package/dist/src/api/update-api.d.ts +10 -10
- package/dist/src/api/update-api.js +8 -8
- package/dist/src/api/webhook-api.d.ts +25 -25
- package/dist/src/api/webhook-api.js +20 -20
- package/dist/src/models/event.d.ts +2 -2
- package/dist/src/models/receive.d.ts +3 -3
- package/dist/src/models/send.d.ts +2 -2
- package/dist/src/models/update.d.ts +2 -2
- package/dist/src/models/web-hook-history.d.ts +1 -1
- package/dist/src/models/web-hook.d.ts +2 -2
- package/docs/CompanyApi.md +10 -6
- package/docs/Event.md +2 -2
- package/docs/ExportApi.md +79 -0
- package/docs/LogApi.md +2 -2
- package/docs/Receive.md +3 -3
- package/docs/ReceiveApi.md +4 -3
- package/docs/Send.md +2 -2
- package/docs/SendApi.md +11 -11
- package/docs/StatusApi.md +1 -1
- package/docs/Update.md +2 -2
- package/docs/UpdateApi.md +2 -2
- package/docs/WebHook.md +2 -2
- package/docs/WebHookHistory.md +1 -1
- package/docs/WebhookApi.md +6 -5
- package/package.json +1 -1
- package/src/api/company-api.ts +43 -34
- package/src/api/export-api.ts +211 -0
- package/src/api/log-api.ts +11 -11
- package/src/api/receive-api.ts +16 -16
- package/src/api/send-api.ts +56 -56
- package/src/api/status-api.ts +6 -6
- package/src/api/update-api.ts +11 -11
- package/src/api/webhook-api.ts +26 -26
- package/src/models/event.ts +2 -2
- package/src/models/receive.ts +3 -3
- package/src/models/send.ts +2 -2
- package/src/models/update.ts +2 -2
- package/src/models/web-hook-history.ts +1 -1
- package/src/models/web-hook.ts +2 -2
|
@@ -18,7 +18,7 @@ import type { Update } from '../../src/models';
|
|
|
18
18
|
*/
|
|
19
19
|
export declare const UpdateApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
20
|
/**
|
|
21
|
-
* Updates are notifications sent by the SDI
|
|
21
|
+
* 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.
|
|
22
22
|
* @summary List updates
|
|
23
23
|
* @param {number} [companyId] Company id
|
|
24
24
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -38,7 +38,7 @@ export declare const UpdateApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
38
38
|
*/
|
|
39
39
|
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) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
* Updates are notifications sent by the SDI
|
|
41
|
+
* 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.
|
|
42
42
|
* @summary Get an update by id
|
|
43
43
|
* @param {number} id Item id
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
@@ -51,7 +51,7 @@ export declare const UpdateApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
51
51
|
*/
|
|
52
52
|
export declare const UpdateApiFp: (configuration?: Configuration) => {
|
|
53
53
|
/**
|
|
54
|
-
* Updates are notifications sent by the SDI
|
|
54
|
+
* 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.
|
|
55
55
|
* @summary List updates
|
|
56
56
|
* @param {number} [companyId] Company id
|
|
57
57
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -71,7 +71,7 @@ export declare const UpdateApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
*/
|
|
72
72
|
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Update>>>;
|
|
73
73
|
/**
|
|
74
|
-
* Updates are notifications sent by the SDI
|
|
74
|
+
* 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.
|
|
75
75
|
* @summary Get an update by id
|
|
76
76
|
* @param {number} id Item id
|
|
77
77
|
* @param {*} [options] Override http request option.
|
|
@@ -84,7 +84,7 @@ export declare const UpdateApiFp: (configuration?: Configuration) => {
|
|
|
84
84
|
*/
|
|
85
85
|
export declare const UpdateApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
86
86
|
/**
|
|
87
|
-
* Updates are notifications sent by the SDI
|
|
87
|
+
* 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.
|
|
88
88
|
* @summary List updates
|
|
89
89
|
* @param {number} [companyId] Company id
|
|
90
90
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -104,7 +104,7 @@ export declare const UpdateApiFactory: (configuration?: Configuration, basePath?
|
|
|
104
104
|
*/
|
|
105
105
|
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>>;
|
|
106
106
|
/**
|
|
107
|
-
* Updates are notifications sent by the SDI
|
|
107
|
+
* 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.
|
|
108
108
|
* @summary Get an update by id
|
|
109
109
|
* @param {number} id Item id
|
|
110
110
|
* @param {*} [options] Override http request option.
|
|
@@ -117,7 +117,7 @@ export declare const UpdateApiFactory: (configuration?: Configuration, basePath?
|
|
|
117
117
|
*/
|
|
118
118
|
export interface UpdateApiInterface {
|
|
119
119
|
/**
|
|
120
|
-
* Updates are notifications sent by the SDI
|
|
120
|
+
* 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.
|
|
121
121
|
* @summary List updates
|
|
122
122
|
* @param {number} [companyId] Company id
|
|
123
123
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -137,7 +137,7 @@ export interface UpdateApiInterface {
|
|
|
137
137
|
*/
|
|
138
138
|
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>>;
|
|
139
139
|
/**
|
|
140
|
-
* Updates are notifications sent by the SDI
|
|
140
|
+
* 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.
|
|
141
141
|
* @summary Get an update by id
|
|
142
142
|
* @param {number} id Item id
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +150,7 @@ export interface UpdateApiInterface {
|
|
|
150
150
|
*/
|
|
151
151
|
export declare class UpdateApi extends BaseAPI implements UpdateApiInterface {
|
|
152
152
|
/**
|
|
153
|
-
* Updates are notifications sent by the SDI
|
|
153
|
+
* 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.
|
|
154
154
|
* @summary List updates
|
|
155
155
|
* @param {number} [companyId] Company id
|
|
156
156
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -170,7 +170,7 @@ export declare class UpdateApi extends BaseAPI implements UpdateApiInterface {
|
|
|
170
170
|
*/
|
|
171
171
|
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): Promise<import("axios").AxiosResponse<Update[], any, {}>>;
|
|
172
172
|
/**
|
|
173
|
-
* Updates are notifications sent by the SDI
|
|
173
|
+
* 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.
|
|
174
174
|
* @summary Get an update by id
|
|
175
175
|
* @param {number} id Item id
|
|
176
176
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
|
|
|
35
35
|
export const UpdateApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* Updates are notifications sent by the SDI
|
|
38
|
+
* 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.
|
|
39
39
|
* @summary List updates
|
|
40
40
|
* @param {number} [companyId] Company id
|
|
41
41
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -124,7 +124,7 @@ export const UpdateApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
};
|
|
125
125
|
}),
|
|
126
126
|
/**
|
|
127
|
-
* Updates are notifications sent by the SDI
|
|
127
|
+
* 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.
|
|
128
128
|
* @summary Get an update by id
|
|
129
129
|
* @param {number} id Item id
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
@@ -165,7 +165,7 @@ export const UpdateApiFp = function (configuration) {
|
|
|
165
165
|
const localVarAxiosParamCreator = UpdateApiAxiosParamCreator(configuration);
|
|
166
166
|
return {
|
|
167
167
|
/**
|
|
168
|
-
* Updates are notifications sent by the SDI
|
|
168
|
+
* 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.
|
|
169
169
|
* @summary List updates
|
|
170
170
|
* @param {number} [companyId] Company id
|
|
171
171
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -193,7 +193,7 @@ export const UpdateApiFp = function (configuration) {
|
|
|
193
193
|
});
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
|
-
* Updates are notifications sent by the SDI
|
|
196
|
+
* 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.
|
|
197
197
|
* @summary Get an update by id
|
|
198
198
|
* @param {number} id Item id
|
|
199
199
|
* @param {*} [options] Override http request option.
|
|
@@ -217,7 +217,7 @@ export const UpdateApiFactory = function (configuration, basePath, axios) {
|
|
|
217
217
|
const localVarFp = UpdateApiFp(configuration);
|
|
218
218
|
return {
|
|
219
219
|
/**
|
|
220
|
-
* Updates are notifications sent by the SDI
|
|
220
|
+
* 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.
|
|
221
221
|
* @summary List updates
|
|
222
222
|
* @param {number} [companyId] Company id
|
|
223
223
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -239,7 +239,7 @@ export const UpdateApiFactory = function (configuration, basePath, axios) {
|
|
|
239
239
|
return localVarFp.updateGet(companyId, identifier, prestatore, unread, sendId, state, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, page, pageSize, sort, options).then((request) => request(axios, basePath));
|
|
240
240
|
},
|
|
241
241
|
/**
|
|
242
|
-
* Updates are notifications sent by the SDI
|
|
242
|
+
* 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.
|
|
243
243
|
* @summary Get an update by id
|
|
244
244
|
* @param {number} id Item id
|
|
245
245
|
* @param {*} [options] Override http request option.
|
|
@@ -255,7 +255,7 @@ export const UpdateApiFactory = function (configuration, basePath, axios) {
|
|
|
255
255
|
*/
|
|
256
256
|
export class UpdateApi extends BaseAPI {
|
|
257
257
|
/**
|
|
258
|
-
* Updates are notifications sent by the SDI
|
|
258
|
+
* 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.
|
|
259
259
|
* @summary List updates
|
|
260
260
|
* @param {number} [companyId] Company id
|
|
261
261
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -277,7 +277,7 @@ export class UpdateApi extends BaseAPI {
|
|
|
277
277
|
return UpdateApiFp(this.configuration).updateGet(companyId, identifier, prestatore, unread, sendId, state, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
|
|
278
278
|
}
|
|
279
279
|
/**
|
|
280
|
-
* Updates are notifications sent by the SDI
|
|
280
|
+
* 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.
|
|
281
281
|
* @summary Get an update by id
|
|
282
282
|
* @param {number} id Item id
|
|
283
283
|
* @param {*} [options] Override http request option.
|
|
@@ -19,7 +19,7 @@ import type { WebHookHistory } from '../../src/models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Webhooks
|
|
22
|
+
* 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/)**.
|
|
23
23
|
* @summary List webhooks
|
|
24
24
|
* @param {number} [companyId] Company id
|
|
25
25
|
* @param {number} [page] Page number.
|
|
@@ -34,7 +34,7 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
34
34
|
*/
|
|
35
35
|
webhookGet: (companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Webhooks
|
|
37
|
+
* 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/)**.
|
|
38
38
|
* @summary Delete a webhook by id
|
|
39
39
|
* @param {number} id Item id
|
|
40
40
|
* @param {*} [options] Override http request option.
|
|
@@ -42,7 +42,7 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
42
42
|
*/
|
|
43
43
|
webhookIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
* Webhooks
|
|
45
|
+
* 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/)**.
|
|
46
46
|
* @summary Get a webhook by id
|
|
47
47
|
* @param {number} id Item id
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
@@ -50,7 +50,7 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
50
50
|
*/
|
|
51
51
|
webhookIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
52
|
/**
|
|
53
|
-
* Webhooks
|
|
53
|
+
* 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/)**.
|
|
54
54
|
* @summary Add a webhook
|
|
55
55
|
* @param {WebHook} webHook
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
@@ -58,7 +58,7 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
58
58
|
*/
|
|
59
59
|
webhookPost: (webHook: WebHook, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* Webhooks
|
|
61
|
+
* 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/)**.
|
|
62
62
|
* @summary Update a webhook
|
|
63
63
|
* @param {WebHook} webHook
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -90,7 +90,7 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
90
90
|
*/
|
|
91
91
|
export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
92
92
|
/**
|
|
93
|
-
* Webhooks
|
|
93
|
+
* 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/)**.
|
|
94
94
|
* @summary List webhooks
|
|
95
95
|
* @param {number} [companyId] Company id
|
|
96
96
|
* @param {number} [page] Page number.
|
|
@@ -105,7 +105,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
105
105
|
*/
|
|
106
106
|
webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WebHook>>>;
|
|
107
107
|
/**
|
|
108
|
-
* Webhooks
|
|
108
|
+
* 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/)**.
|
|
109
109
|
* @summary Delete a webhook by id
|
|
110
110
|
* @param {number} id Item id
|
|
111
111
|
* @param {*} [options] Override http request option.
|
|
@@ -113,7 +113,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
113
113
|
*/
|
|
114
114
|
webhookIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
|
|
115
115
|
/**
|
|
116
|
-
* Webhooks
|
|
116
|
+
* 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/)**.
|
|
117
117
|
* @summary Get a webhook by id
|
|
118
118
|
* @param {number} id Item id
|
|
119
119
|
* @param {*} [options] Override http request option.
|
|
@@ -121,7 +121,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
121
121
|
*/
|
|
122
122
|
webhookIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
|
|
123
123
|
/**
|
|
124
|
-
* Webhooks
|
|
124
|
+
* 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/)**.
|
|
125
125
|
* @summary Add a webhook
|
|
126
126
|
* @param {WebHook} webHook
|
|
127
127
|
* @param {*} [options] Override http request option.
|
|
@@ -129,7 +129,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
129
129
|
*/
|
|
130
130
|
webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
|
|
131
131
|
/**
|
|
132
|
-
* Webhooks
|
|
132
|
+
* 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/)**.
|
|
133
133
|
* @summary Update a webhook
|
|
134
134
|
* @param {WebHook} webHook
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
@@ -161,7 +161,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
161
161
|
*/
|
|
162
162
|
export declare const WebhookApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
163
163
|
/**
|
|
164
|
-
* Webhooks
|
|
164
|
+
* 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/)**.
|
|
165
165
|
* @summary List webhooks
|
|
166
166
|
* @param {number} [companyId] Company id
|
|
167
167
|
* @param {number} [page] Page number.
|
|
@@ -176,7 +176,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
176
176
|
*/
|
|
177
177
|
webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHook>>;
|
|
178
178
|
/**
|
|
179
|
-
* Webhooks
|
|
179
|
+
* 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/)**.
|
|
180
180
|
* @summary Delete a webhook by id
|
|
181
181
|
* @param {number} id Item id
|
|
182
182
|
* @param {*} [options] Override http request option.
|
|
@@ -184,7 +184,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
184
184
|
*/
|
|
185
185
|
webhookIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
186
186
|
/**
|
|
187
|
-
* Webhooks
|
|
187
|
+
* 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/)**.
|
|
188
188
|
* @summary Get a webhook by id
|
|
189
189
|
* @param {number} id Item id
|
|
190
190
|
* @param {*} [options] Override http request option.
|
|
@@ -192,7 +192,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
192
192
|
*/
|
|
193
193
|
webhookIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
194
194
|
/**
|
|
195
|
-
* Webhooks
|
|
195
|
+
* 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/)**.
|
|
196
196
|
* @summary Add a webhook
|
|
197
197
|
* @param {WebHook} webHook
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
@@ -200,7 +200,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
200
200
|
*/
|
|
201
201
|
webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
202
202
|
/**
|
|
203
|
-
* Webhooks
|
|
203
|
+
* 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/)**.
|
|
204
204
|
* @summary Update a webhook
|
|
205
205
|
* @param {WebHook} webHook
|
|
206
206
|
* @param {*} [options] Override http request option.
|
|
@@ -232,7 +232,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
232
232
|
*/
|
|
233
233
|
export interface WebhookApiInterface {
|
|
234
234
|
/**
|
|
235
|
-
* Webhooks
|
|
235
|
+
* 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/)**.
|
|
236
236
|
* @summary List webhooks
|
|
237
237
|
* @param {number} [companyId] Company id
|
|
238
238
|
* @param {number} [page] Page number.
|
|
@@ -247,7 +247,7 @@ export interface WebhookApiInterface {
|
|
|
247
247
|
*/
|
|
248
248
|
webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHook>>;
|
|
249
249
|
/**
|
|
250
|
-
* Webhooks
|
|
250
|
+
* 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/)**.
|
|
251
251
|
* @summary Delete a webhook by id
|
|
252
252
|
* @param {number} id Item id
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
@@ -255,7 +255,7 @@ export interface WebhookApiInterface {
|
|
|
255
255
|
*/
|
|
256
256
|
webhookIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
257
257
|
/**
|
|
258
|
-
* Webhooks
|
|
258
|
+
* 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/)**.
|
|
259
259
|
* @summary Get a webhook by id
|
|
260
260
|
* @param {number} id Item id
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -263,7 +263,7 @@ export interface WebhookApiInterface {
|
|
|
263
263
|
*/
|
|
264
264
|
webhookIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
265
265
|
/**
|
|
266
|
-
* Webhooks
|
|
266
|
+
* 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/)**.
|
|
267
267
|
* @summary Add a webhook
|
|
268
268
|
* @param {WebHook} webHook
|
|
269
269
|
* @param {*} [options] Override http request option.
|
|
@@ -271,7 +271,7 @@ export interface WebhookApiInterface {
|
|
|
271
271
|
*/
|
|
272
272
|
webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
|
|
273
273
|
/**
|
|
274
|
-
* Webhooks
|
|
274
|
+
* 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/)**.
|
|
275
275
|
* @summary Update a webhook
|
|
276
276
|
* @param {WebHook} webHook
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
@@ -303,7 +303,7 @@ export interface WebhookApiInterface {
|
|
|
303
303
|
*/
|
|
304
304
|
export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
305
305
|
/**
|
|
306
|
-
* Webhooks
|
|
306
|
+
* 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/)**.
|
|
307
307
|
* @summary List webhooks
|
|
308
308
|
* @param {number} [companyId] Company id
|
|
309
309
|
* @param {number} [page] Page number.
|
|
@@ -318,7 +318,7 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
318
318
|
*/
|
|
319
319
|
webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook[], any, {}>>;
|
|
320
320
|
/**
|
|
321
|
-
* Webhooks
|
|
321
|
+
* 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/)**.
|
|
322
322
|
* @summary Delete a webhook by id
|
|
323
323
|
* @param {number} id Item id
|
|
324
324
|
* @param {*} [options] Override http request option.
|
|
@@ -326,7 +326,7 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
326
326
|
*/
|
|
327
327
|
webhookIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any, {}>>;
|
|
328
328
|
/**
|
|
329
|
-
* Webhooks
|
|
329
|
+
* 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/)**.
|
|
330
330
|
* @summary Get a webhook by id
|
|
331
331
|
* @param {number} id Item id
|
|
332
332
|
* @param {*} [options] Override http request option.
|
|
@@ -334,7 +334,7 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
334
334
|
*/
|
|
335
335
|
webhookIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any, {}>>;
|
|
336
336
|
/**
|
|
337
|
-
* Webhooks
|
|
337
|
+
* 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/)**.
|
|
338
338
|
* @summary Add a webhook
|
|
339
339
|
* @param {WebHook} webHook
|
|
340
340
|
* @param {*} [options] Override http request option.
|
|
@@ -342,7 +342,7 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
342
342
|
*/
|
|
343
343
|
webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any, {}>>;
|
|
344
344
|
/**
|
|
345
|
-
* Webhooks
|
|
345
|
+
* 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/)**.
|
|
346
346
|
* @summary Update a webhook
|
|
347
347
|
* @param {WebHook} webHook
|
|
348
348
|
* @param {*} [options] Override http request option.
|