@invoicetronic/ts-sdk 1.0.0

package/docs/StabileOrganizzazione.md

@@ -0,0 +1,30 @@
+# StabileOrganizzazione
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indirizzo** | **string** |  | [optional] [default to undefined]
+**numero_civico** | **string** |  | [optional] [default to undefined]
+**cap** | **string** |  | [optional] [default to undefined]
+**comune** | **string** |  | [optional] [default to undefined]
+**provincia** | **string** |  | [optional] [default to undefined]
+**nazione** | **string** |  | [optional] [default to 'IT']
+
+## Example
+
+```typescript
+import { StabileOrganizzazione } from '@invoicetronic/ts-sdk';
+
+const instance: StabileOrganizzazione = {
+    indirizzo,
+    numero_civico,
+    cap,
+    comune,
+    provincia,
+    nazione,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Status.md

@@ -0,0 +1,22 @@
+# Status
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation_left** | **number** | Operations (invoices and validations) left. | [optional] [default to undefined]
+**signature_left** | **number** | Signatures left. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Status } from '@invoicetronic/ts-sdk';
+
+const instance: Status = {
+    operation_left,
+    signature_left,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StatusApi.md

@@ -0,0 +1,52 @@
+# StatusApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**statusGet**](#statusget) | **GET** /status | Account status|
+
+# **statusGet**
+> Status statusGet()
+
+This endpoint is used to know how many operations (invoices + validations) and signatures are left on your account.   When `signature_left` is 0, you will receive a `403 Forbidden` response if you try to sign an invoice. Likewise, if `operation_left` is 0, you will receive a `403 Forbidden` response when storing or validating an invoice.  You can raise the limits by purchasing operations and/or signatures from the [Dashboard](https://dashboard.invoicetronic.com).  __Please note__ that these values are not enforced if you are on the Sandbox. See the [API Keys & Sandbox](https://invoicetronic.com/apikeys/) documentation section to learn more about the Sandbox.
+
+### Example
+
+```typescript
+import {
+    StatusApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StatusApi(configuration);
+
+const { status, data } = await apiInstance.statusGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Status**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/TerzoIntermediarioOSoggettoEmittente.md

@@ -0,0 +1,20 @@
+# TerzoIntermediarioOSoggettoEmittente
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dati_anagrafici** | [**DatiAnagrafici**](DatiAnagrafici.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TerzoIntermediarioOSoggettoEmittente } from '@invoicetronic/ts-sdk';
+
+const instance: TerzoIntermediarioOSoggettoEmittente = {
+    dati_anagrafici,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Update.md

@@ -0,0 +1,44 @@
+# Update
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**user_id** | **number** | User id. | [optional] [default to undefined]
+**company_id** | **number** | Company id. | [optional] [default to undefined]
+**send_id** | **number** | Send id. This is the id of the sent invoice to which this update refers to. | [optional] [default to undefined]
+**last_update** | **string** | Last update from SDI. | [optional] [default to undefined]
+**state** | **string** | State of the document. Theses are the possible values, as per the SDI documentation: | [optional] [default to undefined]
+**description** | **string** | Description for the state. | [optional] [default to undefined]
+**message_id** | **string** | SDI message id. | [optional] [default to undefined]
+**errors** | **Array<Error>** | SDI errors, if any. | [optional] [default to undefined]
+**is_read** | **boolean** | Wether the item has been read at least once. | [optional] [default to undefined]
+**send** | [**SendReduced**](SendReduced.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Update } from '@invoicetronic/ts-sdk';
+
+const instance: Update = {
+    id,
+    created,
+    version,
+    user_id,
+    company_id,
+    send_id,
+    last_update,
+    state,
+    description,
+    message_id,
+    errors,
+    is_read,
+    send,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateApi.md

@@ -0,0 +1,150 @@
+# UpdateApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**updateGet**](#updateget) | **GET** /update | List updates|
+|[**updateIdGet**](#updateidget) | **GET** /update/{id} | Get an update by id|
+
+# **updateGet**
+> Array<Update> updateGet()
+
+Updates are notifications sent by the SDI about the status of invoices you sent.
+
+### Example
+
+```typescript
+import {
+    UpdateApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UpdateApi(configuration);
+
+let companyId: number; //Company id (optional) (default to undefined)
+let identifier: string; //SDI identifier. (optional) (default to undefined)
+let prestatore: string; //Vat number or fiscal code. (optional) (default to undefined)
+let unread: boolean; //Unread items only. (optional) (default to undefined)
+let sendId: number; //Send item\'s id. (optional) (default to undefined)
+let state: 'Inviato' | 'Consegnato' | 'NonConsegnato' | 'Scartato' | 'AccettatoDalDestinatario' | 'RifiutatoDalDestinatario' | 'ImpossibilitaDiRecapito' | 'DecorrenzaTermini' | 'AttestazioneTrasmissioneFattura'; //SDI state (optional) (default to undefined)
+let lastUpdateFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let lastUpdateTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let dateSentFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let dateSentTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let page: number; //Page number. (optional) (default to 1)
+let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
+let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to 'last_update')
+
+const { status, data } = await apiInstance.updateGet(
+    companyId,
+    identifier,
+    prestatore,
+    unread,
+    sendId,
+    state,
+    lastUpdateFrom,
+    lastUpdateTo,
+    dateSentFrom,
+    dateSentTo,
+    page,
+    pageSize,
+    sort
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyId** | [**number**] | Company id | (optional) defaults to undefined|
+| **identifier** | [**string**] | SDI identifier. | (optional) defaults to undefined|
+| **prestatore** | [**string**] | Vat number or fiscal code. | (optional) defaults to undefined|
+| **unread** | [**boolean**] | Unread items only. | (optional) defaults to undefined|
+| **sendId** | [**number**] | Send item\&#39;s id. | (optional) defaults to undefined|
+| **state** | [**&#39;Inviato&#39; | &#39;Consegnato&#39; | &#39;NonConsegnato&#39; | &#39;Scartato&#39; | &#39;AccettatoDalDestinatario&#39; | &#39;RifiutatoDalDestinatario&#39; | &#39;ImpossibilitaDiRecapito&#39; | &#39;DecorrenzaTermini&#39; | &#39;AttestazioneTrasmissioneFattura&#39;**]**Array<&#39;Inviato&#39; &#124; &#39;Consegnato&#39; &#124; &#39;NonConsegnato&#39; &#124; &#39;Scartato&#39; &#124; &#39;AccettatoDalDestinatario&#39; &#124; &#39;RifiutatoDalDestinatario&#39; &#124; &#39;ImpossibilitaDiRecapito&#39; &#124; &#39;DecorrenzaTermini&#39; &#124; &#39;AttestazioneTrasmissioneFattura&#39;>** | SDI state | (optional) defaults to undefined|
+| **lastUpdateFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **lastUpdateTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **dateSentFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **dateSentTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **page** | [**number**] | Page number. | (optional) defaults to 1|
+| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
+| **sort** | [**string**] | Sort by field. Prefix with \&#39;-\&#39; for descending order. | (optional) defaults to 'last_update'|
+
+
+### Return type
+
+**Array<Update>**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**404** | Not Found |  -  |
+|**400** | Bad Request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateIdGet**
+> Update updateIdGet()
+
+Updates are notifications sent by the SDI about the status of invoices you sent.
+
+### Example
+
+```typescript
+import {
+    UpdateApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UpdateApi(configuration);
+
+let id: number; //Item id (default to undefined)
+
+const { status, data } = await apiInstance.updateIdGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Item id | defaults to undefined|
+
+
+### Return type
+
+**Update**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/WebHook.md

@@ -0,0 +1,38 @@
+# WebHook
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**user_id** | **number** | User id. | [optional] [default to undefined]
+**company_id** | **number** | Company id. | [optional] [default to undefined]
+**url** | **string** | The url of your application\'s endpoint that will receive a POST request when the webhook is fired. | [optional] [default to undefined]
+**enabled** | **boolean** | Wether the webhook is enabled. On creation, this is set to `true`. | [optional] [default to undefined]
+**secret** | **string** | The secret used to generate webhook signatures, only returned on creation. You should store this value securely and validate it on every call, to ensure that the caller is InvoicetronicApi. | [optional] [default to undefined]
+**description** | **string** | An optional description. | [optional] [default to undefined]
+**events** | **Array<string>** | List of events to that trigger the webhook.  See Invoicetronic.SupportedEvents.Available for a list of valid event names. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebHook } from '@invoicetronic/ts-sdk';
+
+const instance: WebHook = {
+    id,
+    created,
+    version,
+    user_id,
+    company_id,
+    url,
+    enabled,
+    secret,
+    description,
+    events,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/WebHookHistory.md

@@ -0,0 +1,37 @@
+# WebHookHistory
+
+Webhook history.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**web_hook_id** | **number** | Webhook id. | [optional] [default to undefined]
+**user_id** | **number** | User id. | [optional] [default to undefined]
+**event** | **string** | Event name. | [optional] [default to undefined]
+**status_code** | **number** | Status code. | [optional] [default to undefined]
+**date_time** | **string** | Date and time of the request. | [optional] [default to undefined]
+**success** | **boolean** | Wether the request was successful. | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { WebHookHistory } from '@invoicetronic/ts-sdk';
+
+const instance: WebHookHistory = {
+    id,
+    created,
+    version,
+    web_hook_id,
+    user_id,
+    event,
+    status_code,
+    date_time,
+    success,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)