@invoicetronic/ts-sdk 1.0.0

package/dist/src/models/web-hook.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Invoicetronic API
+ * The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools.  For more information, see  [Invoicetronic website][2]  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@invoicetronic.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface WebHook
+ */
+export interface WebHook {
+    /**
+     * Unique identifier. Leave it at 0 for new records as it will be set automatically.
+     * @type {number}
+     * @memberof WebHook
+     */
+    'id'?: number;
+    /**
+     * Creation date. It is set automatically.
+     * @type {string}
+     * @memberof WebHook
+     */
+    'created'?: string;
+    /**
+     * Row version, for optimistic concurrency. It is set automatically.
+     * @type {number}
+     * @memberof WebHook
+     */
+    'version'?: number;
+    /**
+     * User id.
+     * @type {number}
+     * @memberof WebHook
+     */
+    'user_id'?: number;
+    /**
+     * Company id.
+     * @type {number}
+     * @memberof WebHook
+     */
+    'company_id'?: number | null;
+    /**
+     * The url of your application\'s endpoint that will receive a POST request when the webhook is fired.
+     * @type {string}
+     * @memberof WebHook
+     */
+    'url'?: string | null;
+    /**
+     * Wether the webhook is enabled. On creation, this is set to `true`.
+     * @type {boolean}
+     * @memberof WebHook
+     */
+    'enabled'?: boolean;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof WebHook
+     */
+    'secret'?: string | null;
+    /**
+     * An optional description.
+     * @type {string}
+     * @memberof WebHook
+     */
+    'description'?: string | null;
+    /**
+     * List of events to that trigger the webhook.  See Invoicetronic.SupportedEvents.Available for a list of valid event names.
+     * @type {Array<string>}
+     * @memberof WebHook
+     */
+    'events'?: Array<string> | null;
+}

package/dist/src/models/web-hook.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Invoicetronic API
+ * The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools.  For more information, see  [Invoicetronic website][2]  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@invoicetronic.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/Allegati.md

@@ -0,0 +1,28 @@
+# Allegati
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nome_attachment** | **string** |  | [optional] [default to undefined]
+**algoritmo_compressione** | **string** |  | [optional] [default to undefined]
+**formato_attachment** | **string** |  | [optional] [default to undefined]
+**descrizione_attachment** | **string** |  | [optional] [default to undefined]
+**attachment** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Allegati } from '@invoicetronic/ts-sdk';
+
+const instance: Allegati = {
+    nome_attachment,
+    algoritmo_compressione,
+    formato_attachment,
+    descrizione_attachment,
+    attachment,
+};
+```
+
+[[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/AltriDatiGestionali.md

@@ -0,0 +1,26 @@
+# AltriDatiGestionali
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tipo_dato** | **string** |  | [optional] [default to undefined]
+**riferimento_testo** | **string** |  | [optional] [default to undefined]
+**riferimento_numero** | **number** |  | [optional] [default to undefined]
+**riferimento_data** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AltriDatiGestionali } from '@invoicetronic/ts-sdk';
+
+const instance: AltriDatiGestionali = {
+    tipo_dato,
+    riferimento_testo,
+    riferimento_numero,
+    riferimento_data,
+};
+```
+
+[[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/Anagrafica.md

@@ -0,0 +1,28 @@
+# Anagrafica
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**denominazione** | **string** |  | [optional] [default to undefined]
+**nome** | **string** |  | [optional] [default to undefined]
+**cognome** | **string** |  | [optional] [default to undefined]
+**titolo** | **string** |  | [optional] [default to undefined]
+**cod_eori** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Anagrafica } from '@invoicetronic/ts-sdk';
+
+const instance: Anagrafica = {
+    denominazione,
+    nome,
+    cognome,
+    titolo,
+    cod_eori,
+};
+```
+
+[[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/CedentePrestatore.md

@@ -0,0 +1,30 @@
+# CedentePrestatore
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dati_anagrafici** | [**DatiAnagraficiCedentePrestatore**](DatiAnagraficiCedentePrestatore.md) |  | [optional] [default to undefined]
+**sede** | [**SedeCedentePrestatore**](SedeCedentePrestatore.md) |  | [optional] [default to undefined]
+**stabile_organizzazione** | [**StabileOrganizzazione**](StabileOrganizzazione.md) |  | [optional] [default to undefined]
+**iscrizione_rea** | [**IscrizioneREA**](IscrizioneREA.md) |  | [optional] [default to undefined]
+**contatti** | [**Contatti**](Contatti.md) |  | [optional] [default to undefined]
+**riferimento_amministrazione** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CedentePrestatore } from '@invoicetronic/ts-sdk';
+
+const instance: CedentePrestatore = {
+    dati_anagrafici,
+    sede,
+    stabile_organizzazione,
+    iscrizione_rea,
+    contatti,
+    riferimento_amministrazione,
+};
+```
+
+[[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/CessionarioCommittente.md

@@ -0,0 +1,26 @@
+# CessionarioCommittente
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dati_anagrafici** | [**DatiAnagraficiCessionarioCommittente**](DatiAnagraficiCessionarioCommittente.md) |  | [optional] [default to undefined]
+**sede** | [**SedeCessionarioCommittente**](SedeCessionarioCommittente.md) |  | [optional] [default to undefined]
+**stabile_organizzazione** | [**StabileOrganizzazione**](StabileOrganizzazione.md) |  | [optional] [default to undefined]
+**rappresentante_fiscale** | [**RappresentanteFiscaleCessionarioCommittente**](RappresentanteFiscaleCessionarioCommittente.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CessionarioCommittente } from '@invoicetronic/ts-sdk';
+
+const instance: CessionarioCommittente = {
+    dati_anagrafici,
+    sede,
+    stabile_organizzazione,
+    rappresentante_fiscale,
+};
+```
+
+[[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/CodiceArticolo.md

@@ -0,0 +1,22 @@
+# CodiceArticolo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codice_tipo** | **string** |  | [optional] [default to undefined]
+**codice_valore** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CodiceArticolo } from '@invoicetronic/ts-sdk';
+
+const instance: CodiceArticolo = {
+    codice_tipo,
+    codice_valore,
+};
+```
+
+[[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/Company.md

@@ -0,0 +1,33 @@
+# Company
+
+A company model.
+
+## 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]
+**vat** | **string** | Vat number. Must include the country code. | [default to undefined]
+**fiscal_code** | **string** | Fiscal code. In most cases it\'s the same as the vat number. | [default to undefined]
+**name** | **string** | Name | [default to undefined]
+
+## Example
+
+```typescript
+import { Company } from '@invoicetronic/ts-sdk';
+
+const instance: Company = {
+    id,
+    created,
+    version,
+    user_id,
+    vat,
+    fiscal_code,
+    name,
+};
+```
+
+[[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/CompanyApi.md

@@ -0,0 +1,285 @@
+# CompanyApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**companyGet**](#companyget) | **GET** /company | List companies|
+|[**companyIdDelete**](#companyiddelete) | **DELETE** /company/{id} | Delete a company|
+|[**companyIdGet**](#companyidget) | **GET** /company/{id} | Get a company by id|
+|[**companyPost**](#companypost) | **POST** /company | Add a company|
+|[**companyPut**](#companyput) | **PUT** /company | Update a company|
+
+# **companyGet**
+> Array<Company> companyGet()
+
+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**.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+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 undefined)
+
+const { status, data } = await apiInstance.companyGet(
+    page,
+    pageSize,
+    sort
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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 undefined|
+
+
+### Return type
+
+**Array<Company>**
+
+### 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)
+
+# **companyIdDelete**
+> Company companyIdDelete()
+
+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**.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let id: number; //Item id (default to undefined)
+
+const { status, data } = await apiInstance.companyIdDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Item id | defaults to undefined|
+
+
+### Return type
+
+**Company**
+
+### 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 |  -  |
+|**422** | Unprocessable Content |  -  |
+|**400** | Bad Request |  -  |
+|**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)
+
+# **companyIdGet**
+> Company companyIdGet()
+
+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**.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let id: number; //Item id (default to undefined)
+
+const { status, data } = await apiInstance.companyIdGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Item id | defaults to undefined|
+
+
+### Return type
+
+**Company**
+
+### 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)
+
+# **companyPost**
+> Company companyPost(company)
+
+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**.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration,
+    Company
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let company: Company; //
+
+const { status, data } = await apiInstance.companyPost(
+    company
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **company** | **Company**|  | |
+
+
+### Return type
+
+**Company**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+|**400** | Bad Request |  -  |
+|**422** | Unprocessable Content |  -  |
+
+[[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)
+
+# **companyPut**
+> Company companyPut(company)
+
+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**.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration,
+    Company
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let company: Company; //
+
+const { status, data } = await apiInstance.companyPut(
+    company
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **company** | **Company**|  | |
+
+
+### Return type
+
+**Company**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**422** | Unprocessable Content |  -  |
+|**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)
+

package/docs/Contatti.md

@@ -0,0 +1,24 @@
+# Contatti
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**telefono** | **string** |  | [optional] [default to undefined]
+**fax** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Contatti } from '@invoicetronic/ts-sdk';
+
+const instance: Contatti = {
+    telefono,
+    fax,
+    email,
+};
+```
+
+[[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/ContattiTrasmittente.md

@@ -0,0 +1,22 @@
+# ContattiTrasmittente
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**telefono** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContattiTrasmittente } from '@invoicetronic/ts-sdk';
+
+const instance: ContattiTrasmittente = {
+    telefono,
+    email,
+};
+```
+
+[[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/DatiAnagrafici.md

@@ -0,0 +1,24 @@
+# DatiAnagrafici
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_fiscale_iva** | [**IdFiscaleIVA**](IdFiscaleIVA.md) |  | [optional] [default to undefined]
+**codice_fiscale** | **string** |  | [optional] [default to undefined]
+**anagrafica** | [**Anagrafica**](Anagrafica.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatiAnagrafici } from '@invoicetronic/ts-sdk';
+
+const instance: DatiAnagrafici = {
+    id_fiscale_iva,
+    codice_fiscale,
+    anagrafica,
+};
+```
+
+[[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/DatiAnagraficiCedentePrestatore.md

@@ -0,0 +1,34 @@
+# DatiAnagraficiCedentePrestatore
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_fiscale_iva** | [**IdFiscaleIVA**](IdFiscaleIVA.md) |  | [optional] [default to undefined]
+**codice_fiscale** | **string** |  | [optional] [default to undefined]
+**anagrafica** | [**Anagrafica**](Anagrafica.md) |  | [optional] [default to undefined]
+**albo_professionale** | **string** |  | [optional] [default to undefined]
+**provincia_albo** | **string** |  | [optional] [default to undefined]
+**numero_iscrizione_albo** | **string** |  | [optional] [default to undefined]
+**data_iscrizione_albo** | **string** |  | [optional] [default to undefined]
+**regime_fiscale** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatiAnagraficiCedentePrestatore } from '@invoicetronic/ts-sdk';
+
+const instance: DatiAnagraficiCedentePrestatore = {
+    id_fiscale_iva,
+    codice_fiscale,
+    anagrafica,
+    albo_professionale,
+    provincia_albo,
+    numero_iscrizione_albo,
+    data_iscrizione_albo,
+    regime_fiscale,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)