@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
@@ -35,7 +35,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../../base';
35
35
  export const WebhookApiAxiosParamCreator = function (configuration) {
36
36
  return {
37
37
  /**
38
- * 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.
38
+ * 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/)**.
39
39
  * @summary List webhooks
40
40
  * @param {number} [companyId] Company id
41
41
  * @param {number} [page] Page number.
@@ -96,7 +96,7 @@ export const WebhookApiAxiosParamCreator = function (configuration) {
96
96
  };
97
97
  }),
98
98
  /**
99
- * 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.
99
+ * 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/)**.
100
100
  * @summary Delete a webhook by id
101
101
  * @param {number} id Item id
102
102
  * @param {*} [options] Override http request option.
@@ -129,7 +129,7 @@ export const WebhookApiAxiosParamCreator = function (configuration) {
129
129
  };
130
130
  }),
131
131
  /**
132
- * 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.
132
+ * 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/)**.
133
133
  * @summary Get a webhook by id
134
134
  * @param {number} id Item id
135
135
  * @param {*} [options] Override http request option.
@@ -162,7 +162,7 @@ export const WebhookApiAxiosParamCreator = function (configuration) {
162
162
  };
163
163
  }),
164
164
  /**
165
- * 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.
165
+ * 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/)**.
166
166
  * @summary Add a webhook
167
167
  * @param {WebHook} webHook
168
168
  * @param {*} [options] Override http request option.
@@ -196,7 +196,7 @@ export const WebhookApiAxiosParamCreator = function (configuration) {
196
196
  };
197
197
  }),
198
198
  /**
199
- * 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.
199
+ * 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/)**.
200
200
  * @summary Update a webhook
201
201
  * @param {WebHook} webHook
202
202
  * @param {*} [options] Override http request option.
@@ -316,7 +316,7 @@ export const WebhookApiFp = function (configuration) {
316
316
  const localVarAxiosParamCreator = WebhookApiAxiosParamCreator(configuration);
317
317
  return {
318
318
  /**
319
- * 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.
319
+ * 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/)**.
320
320
  * @summary List webhooks
321
321
  * @param {number} [companyId] Company id
322
322
  * @param {number} [page] Page number.
@@ -339,7 +339,7 @@ export const WebhookApiFp = function (configuration) {
339
339
  });
340
340
  },
341
341
  /**
342
- * 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.
342
+ * 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/)**.
343
343
  * @summary Delete a webhook by id
344
344
  * @param {number} id Item id
345
345
  * @param {*} [options] Override http request option.
@@ -355,7 +355,7 @@ export const WebhookApiFp = function (configuration) {
355
355
  });
356
356
  },
357
357
  /**
358
- * 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.
358
+ * 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/)**.
359
359
  * @summary Get a webhook by id
360
360
  * @param {number} id Item id
361
361
  * @param {*} [options] Override http request option.
@@ -371,7 +371,7 @@ export const WebhookApiFp = function (configuration) {
371
371
  });
372
372
  },
373
373
  /**
374
- * 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.
374
+ * 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/)**.
375
375
  * @summary Add a webhook
376
376
  * @param {WebHook} webHook
377
377
  * @param {*} [options] Override http request option.
@@ -387,7 +387,7 @@ export const WebhookApiFp = function (configuration) {
387
387
  });
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
+ * 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/)**.
391
391
  * @summary Update a webhook
392
392
  * @param {WebHook} webHook
393
393
  * @param {*} [options] Override http request option.
@@ -446,7 +446,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
446
446
  const localVarFp = WebhookApiFp(configuration);
447
447
  return {
448
448
  /**
449
- * 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.
449
+ * 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/)**.
450
450
  * @summary List webhooks
451
451
  * @param {number} [companyId] Company id
452
452
  * @param {number} [page] Page number.
@@ -463,7 +463,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
463
463
  return localVarFp.webhookGet(companyId, page, pageSize, sort, description, enabled, events, url, options).then((request) => request(axios, basePath));
464
464
  },
465
465
  /**
466
- * 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.
466
+ * 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/)**.
467
467
  * @summary Delete a webhook by id
468
468
  * @param {number} id Item id
469
469
  * @param {*} [options] Override http request option.
@@ -473,7 +473,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
473
473
  return localVarFp.webhookIdDelete(id, options).then((request) => request(axios, basePath));
474
474
  },
475
475
  /**
476
- * 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.
476
+ * 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/)**.
477
477
  * @summary Get a webhook by id
478
478
  * @param {number} id Item id
479
479
  * @param {*} [options] Override http request option.
@@ -483,7 +483,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
483
483
  return localVarFp.webhookIdGet(id, options).then((request) => request(axios, basePath));
484
484
  },
485
485
  /**
486
- * 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.
486
+ * 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/)**.
487
487
  * @summary Add a webhook
488
488
  * @param {WebHook} webHook
489
489
  * @param {*} [options] Override http request option.
@@ -493,7 +493,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
493
493
  return localVarFp.webhookPost(webHook, options).then((request) => request(axios, basePath));
494
494
  },
495
495
  /**
496
- * 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.
496
+ * 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/)**.
497
497
  * @summary Update a webhook
498
498
  * @param {WebHook} webHook
499
499
  * @param {*} [options] Override http request option.
@@ -532,7 +532,7 @@ export const WebhookApiFactory = function (configuration, basePath, axios) {
532
532
  */
533
533
  export class WebhookApi extends BaseAPI {
534
534
  /**
535
- * 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.
535
+ * 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/)**.
536
536
  * @summary List webhooks
537
537
  * @param {number} [companyId] Company id
538
538
  * @param {number} [page] Page number.
@@ -549,7 +549,7 @@ export class WebhookApi extends BaseAPI {
549
549
  return WebhookApiFp(this.configuration).webhookGet(companyId, page, pageSize, sort, description, enabled, events, url, options).then((request) => request(this.axios, this.basePath));
550
550
  }
551
551
  /**
552
- * 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.
552
+ * 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/)**.
553
553
  * @summary Delete a webhook by id
554
554
  * @param {number} id Item id
555
555
  * @param {*} [options] Override http request option.
@@ -559,7 +559,7 @@ export class WebhookApi extends BaseAPI {
559
559
  return WebhookApiFp(this.configuration).webhookIdDelete(id, options).then((request) => request(this.axios, this.basePath));
560
560
  }
561
561
  /**
562
- * 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.
562
+ * 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/)**.
563
563
  * @summary Get a webhook by id
564
564
  * @param {number} id Item id
565
565
  * @param {*} [options] Override http request option.
@@ -569,7 +569,7 @@ export class WebhookApi extends BaseAPI {
569
569
  return WebhookApiFp(this.configuration).webhookIdGet(id, options).then((request) => request(this.axios, this.basePath));
570
570
  }
571
571
  /**
572
- * 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.
572
+ * 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/)**.
573
573
  * @summary Add a webhook
574
574
  * @param {WebHook} webHook
575
575
  * @param {*} [options] Override http request option.
@@ -579,7 +579,7 @@ export class WebhookApi extends BaseAPI {
579
579
  return WebhookApiFp(this.configuration).webhookPost(webHook, options).then((request) => request(this.axios, this.basePath));
580
580
  }
581
581
  /**
582
- * 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.
582
+ * 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/)**.
583
583
  * @summary Update a webhook
584
584
  * @param {WebHook} webHook
585
585
  * @param {*} [options] Override http request option.
@@ -63,7 +63,7 @@ export interface Event {
63
63
  */
64
64
  'resource_id'?: number | null;
65
65
  /**
66
- * Wether the request was successful.
66
+ * Whether the request was successful.
67
67
  */
68
68
  'success'?: boolean;
69
69
  /**
@@ -71,7 +71,7 @@ export interface Event {
71
71
  */
72
72
  'query'?: string | null;
73
73
  /**
74
- * Response payload. It is guaranteed to be cyphered at rest.
74
+ * Response payload. It is guaranteed to be encrypted at rest.
75
75
  */
76
76
  'response_body'?: string | null;
77
77
  }
@@ -40,7 +40,7 @@ export interface Receive {
40
40
  */
41
41
  'prestatore'?: string | null;
42
42
  /**
43
- * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
43
+ * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
44
44
  */
45
45
  'identifier'?: string | null;
46
46
  /**
@@ -52,7 +52,7 @@ export interface Receive {
52
52
  */
53
53
  'format'?: string | null;
54
54
  /**
55
- * 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.
55
+ * 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.
56
56
  */
57
57
  'payload': string;
58
58
  /**
@@ -72,7 +72,7 @@ export interface Receive {
72
72
  */
73
73
  'encoding'?: ReceiveEncodingEnum;
74
74
  /**
75
- * Wether the invoice has been read at least once.
75
+ * Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true.
76
76
  */
77
77
  'is_read'?: boolean;
78
78
  /**
@@ -41,7 +41,7 @@ export interface Send {
41
41
  */
42
42
  'prestatore'?: string | null;
43
43
  /**
44
- * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
44
+ * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
45
45
  */
46
46
  'identifier'?: string | null;
47
47
  /**
@@ -53,7 +53,7 @@ export interface Send {
53
53
  */
54
54
  'format'?: string | null;
55
55
  /**
56
- * 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.
56
+ * 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.
57
57
  */
58
58
  'payload': string;
59
59
  /**
@@ -40,7 +40,7 @@ export interface Update {
40
40
  */
41
41
  'last_update'?: string;
42
42
  /**
43
- * State of the document. Theses are the possible values, as per the SDI documentation:
43
+ * State of the document. These are the possible values, as per the SDI documentation:
44
44
  */
45
45
  'state'?: UpdateStateEnum;
46
46
  /**
@@ -56,7 +56,7 @@ export interface Update {
56
56
  */
57
57
  'errors'?: Array<Error> | null;
58
58
  /**
59
- * Wether the item has been read at least once.
59
+ * Whether the item has been read at least once.
60
60
  */
61
61
  'is_read'?: boolean;
62
62
  'send'?: SendReduced;
@@ -46,7 +46,7 @@ export interface WebHookHistory {
46
46
  */
47
47
  'date_time'?: string;
48
48
  /**
49
- * Wether the request was successful.
49
+ * Whether the request was successful.
50
50
  */
51
51
  'success'?: boolean;
52
52
  }
@@ -35,7 +35,7 @@ export interface WebHook {
35
35
  */
36
36
  'url': string;
37
37
  /**
38
- * Wether the webhook is enabled. On creation, this is set to `true`.
38
+ * Whether the webhook is enabled. On creation, this is set to `true`.
39
39
  */
40
40
  'enabled'?: boolean;
41
41
  /**
@@ -47,7 +47,7 @@ export interface WebHook {
47
47
  */
48
48
  'description'?: string | null;
49
49
  /**
50
- * List of events to that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.
50
+ * List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.
51
51
  */
52
52
  'events'?: Array<string> | null;
53
53
  }
@@ -18,7 +18,7 @@ import type { Company } from '../../src/models';
18
18
  */
19
19
  export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
21
+ * Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
22
22
  * @summary List companies
23
23
  * @param {number} [page] Page number.
24
24
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -28,15 +28,16 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
28
28
  */
29
29
  companyGet: (page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
30
  /**
31
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
31
+ * Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
32
32
  * @summary Delete a company
33
33
  * @param {number} id Item id
34
+ * @param {boolean} [force] Force delete including all related data.
34
35
  * @param {*} [options] Override http request option.
35
36
  * @throws {RequiredError}
36
37
  */
37
- companyIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
+ companyIdDelete: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
39
  /**
39
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
40
+ * Retrieve a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
40
41
  * @summary Get a company by id
41
42
  * @param {number} id Item id
42
43
  * @param {*} [options] Override http request option.
@@ -44,7 +45,7 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
44
45
  */
45
46
  companyIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
47
  /**
47
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
48
+ * Add a new company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
48
49
  * @summary Add a company
49
50
  * @param {Company} company
50
51
  * @param {*} [options] Override http request option.
@@ -52,7 +53,7 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
52
53
  */
53
54
  companyPost: (company: Company, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
54
55
  /**
55
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
56
+ * Update an existing company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
56
57
  * @summary Update a company
57
58
  * @param {Company} company
58
59
  * @param {*} [options] Override http request option.
@@ -65,7 +66,7 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
65
66
  */
66
67
  export declare const CompanyApiFp: (configuration?: Configuration) => {
67
68
  /**
68
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
69
+ * Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
69
70
  * @summary List companies
70
71
  * @param {number} [page] Page number.
71
72
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -75,15 +76,16 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
75
76
  */
76
77
  companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Company>>>;
77
78
  /**
78
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
79
+ * Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
79
80
  * @summary Delete a company
80
81
  * @param {number} id Item id
82
+ * @param {boolean} [force] Force delete including all related data.
81
83
  * @param {*} [options] Override http request option.
82
84
  * @throws {RequiredError}
83
85
  */
84
- companyIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Company>>;
86
+ companyIdDelete(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Company>>;
85
87
  /**
86
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
88
+ * Retrieve a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
87
89
  * @summary Get a company by id
88
90
  * @param {number} id Item id
89
91
  * @param {*} [options] Override http request option.
@@ -91,7 +93,7 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
91
93
  */
92
94
  companyIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Company>>;
93
95
  /**
94
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
96
+ * Add a new company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
95
97
  * @summary Add a company
96
98
  * @param {Company} company
97
99
  * @param {*} [options] Override http request option.
@@ -99,7 +101,7 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
99
101
  */
100
102
  companyPost(company: Company, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Company>>;
101
103
  /**
102
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
104
+ * Update an existing company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
103
105
  * @summary Update a company
104
106
  * @param {Company} company
105
107
  * @param {*} [options] Override http request option.
@@ -112,7 +114,7 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
112
114
  */
113
115
  export declare const CompanyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
114
116
  /**
115
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
117
+ * Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
116
118
  * @summary List companies
117
119
  * @param {number} [page] Page number.
118
120
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -122,15 +124,16 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
122
124
  */
123
125
  companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
124
126
  /**
125
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
127
+ * Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
126
128
  * @summary Delete a company
127
129
  * @param {number} id Item id
130
+ * @param {boolean} [force] Force delete including all related data.
128
131
  * @param {*} [options] Override http request option.
129
132
  * @throws {RequiredError}
130
133
  */
131
- companyIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
134
+ companyIdDelete(id: number, force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
132
135
  /**
133
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
136
+ * Retrieve a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
134
137
  * @summary Get a company by id
135
138
  * @param {number} id Item id
136
139
  * @param {*} [options] Override http request option.
@@ -138,7 +141,7 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
138
141
  */
139
142
  companyIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
140
143
  /**
141
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
144
+ * Add a new company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
142
145
  * @summary Add a company
143
146
  * @param {Company} company
144
147
  * @param {*} [options] Override http request option.
@@ -146,7 +149,7 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
146
149
  */
147
150
  companyPost(company: Company, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
148
151
  /**
149
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
152
+ * Update an existing company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
150
153
  * @summary Update a company
151
154
  * @param {Company} company
152
155
  * @param {*} [options] Override http request option.
@@ -159,7 +162,7 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
159
162
  */
160
163
  export interface CompanyApiInterface {
161
164
  /**
162
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
165
+ * Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
163
166
  * @summary List companies
164
167
  * @param {number} [page] Page number.
165
168
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -169,15 +172,16 @@ export interface CompanyApiInterface {
169
172
  */
170
173
  companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
171
174
  /**
172
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
175
+ * Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
173
176
  * @summary Delete a company
174
177
  * @param {number} id Item id
178
+ * @param {boolean} [force] Force delete including all related data.
175
179
  * @param {*} [options] Override http request option.
176
180
  * @throws {RequiredError}
177
181
  */
178
- companyIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
182
+ companyIdDelete(id: number, force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
179
183
  /**
180
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
184
+ * Retrieve a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
181
185
  * @summary Get a company by id
182
186
  * @param {number} id Item id
183
187
  * @param {*} [options] Override http request option.
@@ -185,7 +189,7 @@ export interface CompanyApiInterface {
185
189
  */
186
190
  companyIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
187
191
  /**
188
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
192
+ * Add a new company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
189
193
  * @summary Add a company
190
194
  * @param {Company} company
191
195
  * @param {*} [options] Override http request option.
@@ -193,7 +197,7 @@ export interface CompanyApiInterface {
193
197
  */
194
198
  companyPost(company: Company, options?: RawAxiosRequestConfig): AxiosPromise<Company>;
195
199
  /**
196
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
200
+ * Update an existing company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
197
201
  * @summary Update a company
198
202
  * @param {Company} company
199
203
  * @param {*} [options] Override http request option.
@@ -206,7 +210,7 @@ export interface CompanyApiInterface {
206
210
  */
207
211
  export declare class CompanyApi extends BaseAPI implements CompanyApiInterface {
208
212
  /**
209
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
213
+ * Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
210
214
  * @summary List companies
211
215
  * @param {number} [page] Page number.
212
216
  * @param {number} [pageSize] Items per page. Cannot be greater than 200.
@@ -216,15 +220,16 @@ export declare class CompanyApi extends BaseAPI implements CompanyApiInterface {
216
220
  */
217
221
  companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company[], any, {}>>;
218
222
  /**
219
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
223
+ * Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
220
224
  * @summary Delete a company
221
225
  * @param {number} id Item id
226
+ * @param {boolean} [force] Force delete including all related data.
222
227
  * @param {*} [options] Override http request option.
223
228
  * @throws {RequiredError}
224
229
  */
225
- companyIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company, any, {}>>;
230
+ companyIdDelete(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company, any, {}>>;
226
231
  /**
227
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
232
+ * Retrieve a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
228
233
  * @summary Get a company by id
229
234
  * @param {number} id Item id
230
235
  * @param {*} [options] Override http request option.
@@ -232,7 +237,7 @@ export declare class CompanyApi extends BaseAPI implements CompanyApiInterface {
232
237
  */
233
238
  companyIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company, any, {}>>;
234
239
  /**
235
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
240
+ * Add a new company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
236
241
  * @summary Add a company
237
242
  * @param {Company} company
238
243
  * @param {*} [options] Override http request option.
@@ -240,7 +245,7 @@ export declare class CompanyApi extends BaseAPI implements CompanyApiInterface {
240
245
  */
241
246
  companyPost(company: Company, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Company, any, {}>>;
242
247
  /**
243
- * Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
248
+ * Update an existing company. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
244
249
  * @summary Update a company
245
250
  * @param {Company} company
246
251
  * @param {*} [options] Override http request option.