@emilgroup/accounting-sdk-node 1.1.0 → 1.2.0

package/dist/api/vbus-api.d.ts

@@ -0,0 +1,395 @@
+/**
+ * EMIL GdvService
+ * The EMIL GdvService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateVbuRequestDto } from '../models';
+import { CreateVbuResponseClass } from '../models';
+import { CreateVbuvRequestDto } from '../models';
+import { CreateVbuvResponseClass } from '../models';
+import { GetVbuResponseClass } from '../models';
+import { ListVbusResponseClass } from '../models';
+import { UpdateVbuRequestDto } from '../models';
+import { UpdateVbuResponseClass } from '../models';
+/**
+ * VbusApi - axios parameter creator
+ * @export
+ */
+export declare const VbusApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This endpoint will create a vbu message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuRequestDto} createVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbu: (createVbuRequestDto: CreateVbuRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint will create a vbuv message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuvRequestDto} createVbuvRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbuv: (createVbuvRequestDto: CreateVbuvRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the vbu that was previously created. Supply the unique vbu code      that was returned when you created it and Emil Api will return the corresponding vbu information.
+     * @summary Retrieve the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {'responses'} [expand] You can expand policy in this endpoint.        By default, versions will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVbu: (code: string, authorization?: string, expand?: 'responses', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of vbus you have previously created.        The vbus are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbus
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will       conserve bandwidth and reduce response time.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: id, code, leadNumber, policyNumber, leadCode, policyCode, customerName&lt;/i&gt;       &lt;br/&gt;       &lt;i&gt;policyCode&lt;/i&gt; is required, other filters are optional.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, code, transmissionStart, createdAt, updatedAt&lt;/i&gt;
+     * @param {any} [expand] No expanding supported
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVbus: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified vbu by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbuRequestDto} updateVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVbu: (code: string, updateVbuRequestDto: UpdateVbuRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VbusApi - functional programming interface
+ * @export
+ */
+export declare const VbusApiFp: (configuration?: Configuration) => {
+    /**
+     * This endpoint will create a vbu message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuRequestDto} createVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbu(createVbuRequestDto: CreateVbuRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVbuResponseClass>>;
+    /**
+     * This endpoint will create a vbuv message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuvRequestDto} createVbuvRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbuv(createVbuvRequestDto: CreateVbuvRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVbuvResponseClass>>;
+    /**
+     * Retrieves the details of the vbu that was previously created. Supply the unique vbu code      that was returned when you created it and Emil Api will return the corresponding vbu information.
+     * @summary Retrieve the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {'responses'} [expand] You can expand policy in this endpoint.        By default, versions will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVbu(code: string, authorization?: string, expand?: 'responses', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetVbuResponseClass>>;
+    /**
+     * Returns a list of vbus you have previously created.        The vbus are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbus
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will       conserve bandwidth and reduce response time.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: id, code, leadNumber, policyNumber, leadCode, policyCode, customerName&lt;/i&gt;       &lt;br/&gt;       &lt;i&gt;policyCode&lt;/i&gt; is required, other filters are optional.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, code, transmissionStart, createdAt, updatedAt&lt;/i&gt;
+     * @param {any} [expand] No expanding supported
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVbus(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListVbusResponseClass>>;
+    /**
+     * Updates the specified vbu by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbuRequestDto} updateVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVbu(code: string, updateVbuRequestDto: UpdateVbuRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateVbuResponseClass>>;
+};
+/**
+ * VbusApi - factory interface
+ * @export
+ */
+export declare const VbusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This endpoint will create a vbu message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuRequestDto} createVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbu(createVbuRequestDto: CreateVbuRequestDto, authorization?: string, options?: any): AxiosPromise<CreateVbuResponseClass>;
+    /**
+     * This endpoint will create a vbuv message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {CreateVbuvRequestDto} createVbuvRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVbuv(createVbuvRequestDto: CreateVbuvRequestDto, authorization?: string, options?: any): AxiosPromise<CreateVbuvResponseClass>;
+    /**
+     * Retrieves the details of the vbu that was previously created. Supply the unique vbu code      that was returned when you created it and Emil Api will return the corresponding vbu information.
+     * @summary Retrieve the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {'responses'} [expand] You can expand policy in this endpoint.        By default, versions will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVbu(code: string, authorization?: string, expand?: 'responses', options?: any): AxiosPromise<GetVbuResponseClass>;
+    /**
+     * Returns a list of vbus you have previously created.        The vbus are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbus
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will       conserve bandwidth and reduce response time.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: id, code, leadNumber, policyNumber, leadCode, policyCode, customerName&lt;/i&gt;       &lt;br/&gt;       &lt;i&gt;policyCode&lt;/i&gt; is required, other filters are optional.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, code, transmissionStart, createdAt, updatedAt&lt;/i&gt;
+     * @param {any} [expand] No expanding supported
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVbus(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListVbusResponseClass>;
+    /**
+     * Updates the specified vbu by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vbu
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbuRequestDto} updateVbuRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVbu(code: string, updateVbuRequestDto: UpdateVbuRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateVbuResponseClass>;
+};
+/**
+ * Request parameters for createVbu operation in VbusApi.
+ * @export
+ * @interface VbusApiCreateVbuRequest
+ */
+export interface VbusApiCreateVbuRequest {
+    /**
+     *
+     * @type {CreateVbuRequestDto}
+     * @memberof VbusApiCreateVbu
+     */
+    readonly createVbuRequestDto: CreateVbuRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof VbusApiCreateVbu
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createVbuv operation in VbusApi.
+ * @export
+ * @interface VbusApiCreateVbuvRequest
+ */
+export interface VbusApiCreateVbuvRequest {
+    /**
+     *
+     * @type {CreateVbuvRequestDto}
+     * @memberof VbusApiCreateVbuv
+     */
+    readonly createVbuvRequestDto: CreateVbuvRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof VbusApiCreateVbuv
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getVbu operation in VbusApi.
+ * @export
+ * @interface VbusApiGetVbuRequest
+ */
+export interface VbusApiGetVbuRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VbusApiGetVbu
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof VbusApiGetVbu
+     */
+    readonly authorization?: string;
+    /**
+     * You can expand policy in this endpoint.        By default, versions will be an empty array.
+     * @type {'responses'}
+     * @memberof VbusApiGetVbu
+     */
+    readonly expand?: 'responses';
+}
+/**
+ * Request parameters for listVbus operation in VbusApi.
+ * @export
+ * @interface VbusApiListVbusRequest
+ */
+export interface VbusApiListVbusRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof VbusApiListVbus
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly pageSize?: any;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields. In general, fetching filtered responses will       conserve bandwidth and reduce response time.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: id, code, leadNumber, policyNumber, leadCode, policyCode, customerName&lt;/i&gt;       &lt;br/&gt;       &lt;i&gt;policyCode&lt;/i&gt; is required, other filters are optional.
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly filter?: any;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly search?: any;
+    /**
+     * Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, code, transmissionStart, createdAt, updatedAt&lt;/i&gt;
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly order?: any;
+    /**
+     * No expanding supported
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly expand?: any;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof VbusApiListVbus
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updateVbu operation in VbusApi.
+ * @export
+ * @interface VbusApiUpdateVbuRequest
+ */
+export interface VbusApiUpdateVbuRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VbusApiUpdateVbu
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateVbuRequestDto}
+     * @memberof VbusApiUpdateVbu
+     */
+    readonly updateVbuRequestDto: UpdateVbuRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof VbusApiUpdateVbu
+     */
+    readonly authorization?: string;
+}
+/**
+ * VbusApi - object-oriented interface
+ * @export
+ * @class VbusApi
+ * @extends {BaseAPI}
+ */
+export declare class VbusApi extends BaseAPI {
+    /**
+     * This endpoint will create a vbu message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {VbusApiCreateVbuRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbusApi
+     */
+    createVbu(requestParameters: VbusApiCreateVbuRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVbuResponseClass, any>>;
+    /**
+     * This endpoint will create a vbuv message. The call is asynchronous and will return a code to retrieve the vbu when it is ready.
+     * @summary Create the vbu
+     * @param {VbusApiCreateVbuvRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbusApi
+     */
+    createVbuv(requestParameters: VbusApiCreateVbuvRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVbuvResponseClass, any>>;
+    /**
+     * Retrieves the details of the vbu that was previously created. Supply the unique vbu code      that was returned when you created it and Emil Api will return the corresponding vbu information.
+     * @summary Retrieve the vbu
+     * @param {VbusApiGetVbuRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbusApi
+     */
+    getVbu(requestParameters: VbusApiGetVbuRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetVbuResponseClass, any>>;
+    /**
+     * Returns a list of vbus you have previously created.        The vbus are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbus
+     * @param {VbusApiListVbusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbusApi
+     */
+    listVbus(requestParameters?: VbusApiListVbusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListVbusResponseClass, any>>;
+    /**
+     * Updates the specified vbu by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vbu
+     * @param {VbusApiUpdateVbuRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbusApi
+     */
+    updateVbu(requestParameters: VbusApiUpdateVbuRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateVbuResponseClass, any>>;
+}