@invoicetronic/ts-sdk 1.0.0

package/dist/esm/src/api/webhook-api.d.ts

@@ -0,0 +1,393 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+import type { WebHook } from '../../src/models';
+import type { WebHookHistory } from '../../src/models';
+/**
+ * WebhookApi - axios parameter creator
+ * @export
+ */
+export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary List webhooks
+     * @param {number} [companyId] Company id
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
+     * @param {string} [description]
+     * @param {boolean} [enabled]
+     * @param {string} [events]
+     * @param {string} [url]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookGet: (companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Delete a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Get a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Add a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPost: (webHook: WebHook, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Update a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPut: (webHook: WebHook, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary List webhook history items
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {number} [webhookId] WebHook id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryGet: (page?: number, pageSize?: number, sort?: string, webhookId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary Get a webhook history item by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * WebhookApi - functional programming interface
+ * @export
+ */
+export declare const WebhookApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary List webhooks
+     * @param {number} [companyId] Company id
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {string} [description]
+     * @param {boolean} [enabled]
+     * @param {string} [events]
+     * @param {string} [url]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>>>;
+    /**
+     * 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.
+     * @summary Delete a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
+    /**
+     * 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.
+     * @summary Get a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
+    /**
+     * 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.
+     * @summary Add a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
+    /**
+     * 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.
+     * @summary Update a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPut(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHook>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary List webhook history items
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {number} [webhookId] WebHook id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryGet(page?: number, pageSize?: number, sort?: string, webhookId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WebHookHistory>>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary Get a webhook history item by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebHookHistory>>;
+};
+/**
+ * WebhookApi - factory interface
+ * @export
+ */
+export declare const WebhookApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.
+     * @summary List webhooks
+     * @param {number} [companyId] Company id
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {string} [description]
+     * @param {boolean} [enabled]
+     * @param {string} [events]
+     * @param {string} [url]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHook>>;
+    /**
+     * 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.
+     * @summary Delete a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Get a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Add a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Update a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookPut(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary List webhook history items
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {number} [webhookId] WebHook id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryGet(page?: number, pageSize?: number, sort?: string, webhookId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHookHistory>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary Get a webhook history item by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    webhookhistoryIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHookHistory>;
+};
+/**
+ * WebhookApi - interface
+ * @export
+ * @interface WebhookApi
+ */
+export interface WebhookApiInterface {
+    /**
+     * 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.
+     * @summary List webhooks
+     * @param {number} [companyId] Company id
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {string} [description]
+     * @param {boolean} [enabled]
+     * @param {string} [events]
+     * @param {string} [url]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookGet(companyId?: number, page?: number, pageSize?: number, sort?: string, description?: string, enabled?: boolean, events?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHook>>;
+    /**
+     * 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.
+     * @summary Delete a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Get a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Add a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * 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.
+     * @summary Update a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookPut(webHook: WebHook, options?: RawAxiosRequestConfig): AxiosPromise<WebHook>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary List webhook history items
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {number} [webhookId] WebHook id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookhistoryGet(page?: number, pageSize?: number, sort?: string, webhookId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<WebHookHistory>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary Get a webhook history item by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApiInterface
+     */
+    webhookhistoryIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<WebHookHistory>;
+}
+/**
+ * WebhookApi - object-oriented interface
+ * @export
+ * @class WebhookApi
+ * @extends {BaseAPI}
+ */
+export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
+    /**
+     * 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.
+     * @summary List webhooks
+     * @param {number} [companyId] Company id
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {string} [description]
+     * @param {boolean} [enabled]
+     * @param {string} [events]
+     * @param {string} [url]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    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>>;
+    /**
+     * 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.
+     * @summary Delete a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any>>;
+    /**
+     * 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.
+     * @summary Get a webhook by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any>>;
+    /**
+     * 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.
+     * @summary Add a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookPost(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any>>;
+    /**
+     * 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.
+     * @summary Update a webhook
+     * @param {WebHook} webHook
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookPut(webHook: WebHook, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHook, any>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary List webhook history items
+     * @param {number} [page] Page number.
+     * @param {number} [pageSize] Items per page. Cannot be greater than 200.
+     * @param {string} [sort] Sort by field. Prefix with \&#39;-\&#39; for descending order.
+     * @param {number} [webhookId] WebHook id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookhistoryGet(page?: number, pageSize?: number, sort?: string, webhookId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHookHistory[], any>>;
+    /**
+     * Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.
+     * @summary Get a webhook history item by id
+     * @param {number} id Item id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhookApi
+     */
+    webhookhistoryIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebHookHistory, any>>;
+}