@emilgroup/accounting-sdk-node 1.1.0 → 1.2.0

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

@@ -0,0 +1,337 @@
+/**
+ * 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 { CreateVbaRequestDto } from '../models';
+import { CreateVbaResponseClass } from '../models';
+import { GetVbaResponseClass } from '../models';
+import { ListVbasResponseClass } from '../models';
+import { UpdateVbaRequestDto } from '../models';
+/**
+ * VbasApi - axios parameter creator
+ * @export
+ */
+export declare const VbasApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an asynchronous vba, the method will return a code to retrieve the vba when it is ready.
+     * @summary Create the vba
+     * @param {CreateVbaRequestDto} createVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVba: (createVbaRequestDto: CreateVbaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the vba that was previously created. Supply the unique vba code      that was returned when you created it and Emil Api will return the corresponding vba information.
+     * @summary Retrieve the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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}
+     */
+    getVba: (code: string, authorization?: string, expand?: 'responses', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of vbas you have previously created.        The vbas are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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, 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, expiryDate, 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}
+     */
+    listVbas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified vba by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbaRequestDto} updateVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVba: (code: string, updateVbaRequestDto: UpdateVbaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VbasApi - functional programming interface
+ * @export
+ */
+export declare const VbasApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an asynchronous vba, the method will return a code to retrieve the vba when it is ready.
+     * @summary Create the vba
+     * @param {CreateVbaRequestDto} createVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVba(createVbaRequestDto: CreateVbaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVbaResponseClass>>;
+    /**
+     * Retrieves the details of the vba that was previously created. Supply the unique vba code      that was returned when you created it and Emil Api will return the corresponding vba information.
+     * @summary Retrieve the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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}
+     */
+    getVba(code: string, authorization?: string, expand?: 'responses', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetVbaResponseClass>>;
+    /**
+     * Returns a list of vbas you have previously created.        The vbas are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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, 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, expiryDate, 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}
+     */
+    listVbas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListVbasResponseClass>>;
+    /**
+     * Updates the specified vba by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbaRequestDto} updateVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVba(code: string, updateVbaRequestDto: UpdateVbaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateVbaRequestDto>>;
+};
+/**
+ * VbasApi - factory interface
+ * @export
+ */
+export declare const VbasApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an asynchronous vba, the method will return a code to retrieve the vba when it is ready.
+     * @summary Create the vba
+     * @param {CreateVbaRequestDto} createVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVba(createVbaRequestDto: CreateVbaRequestDto, authorization?: string, options?: any): AxiosPromise<CreateVbaResponseClass>;
+    /**
+     * Retrieves the details of the vba that was previously created. Supply the unique vba code      that was returned when you created it and Emil Api will return the corresponding vba information.
+     * @summary Retrieve the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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}
+     */
+    getVba(code: string, authorization?: string, expand?: 'responses', options?: any): AxiosPromise<GetVbaResponseClass>;
+    /**
+     * Returns a list of vbas you have previously created.        The vbas are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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, 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, expiryDate, 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}
+     */
+    listVbas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListVbasResponseClass>;
+    /**
+     * Updates the specified vba by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vba
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVbaRequestDto} updateVbaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVba(code: string, updateVbaRequestDto: UpdateVbaRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateVbaRequestDto>;
+};
+/**
+ * Request parameters for createVba operation in VbasApi.
+ * @export
+ * @interface VbasApiCreateVbaRequest
+ */
+export interface VbasApiCreateVbaRequest {
+    /**
+     *
+     * @type {CreateVbaRequestDto}
+     * @memberof VbasApiCreateVba
+     */
+    readonly createVbaRequestDto: CreateVbaRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VbasApiCreateVba
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getVba operation in VbasApi.
+ * @export
+ * @interface VbasApiGetVbaRequest
+ */
+export interface VbasApiGetVbaRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VbasApiGetVba
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VbasApiGetVba
+     */
+    readonly authorization?: string;
+    /**
+     * You can expand policy in this endpoint.        By default, versions will be an empty array.
+     * @type {'responses'}
+     * @memberof VbasApiGetVba
+     */
+    readonly expand?: 'responses';
+}
+/**
+ * Request parameters for listVbas operation in VbasApi.
+ * @export
+ * @interface VbasApiListVbasRequest
+ */
+export interface VbasApiListVbasRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VbasApiListVbas
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof VbasApiListVbas
+     */
+    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 VbasApiListVbas
+     */
+    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, policyCode, customerName&lt;/i&gt;       &lt;br/&gt;       &lt;i&gt;policyCode&lt;/i&gt; is required, other filters are optional.
+     * @type {any}
+     * @memberof VbasApiListVbas
+     */
+    readonly filter?: any;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof VbasApiListVbas
+     */
+    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, expiryDate, createdAt, updatedAt&lt;/i&gt;
+     * @type {any}
+     * @memberof VbasApiListVbas
+     */
+    readonly order?: any;
+    /**
+     * No expanding supported
+     * @type {any}
+     * @memberof VbasApiListVbas
+     */
+    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 VbasApiListVbas
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updateVba operation in VbasApi.
+ * @export
+ * @interface VbasApiUpdateVbaRequest
+ */
+export interface VbasApiUpdateVbaRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VbasApiUpdateVba
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateVbaRequestDto}
+     * @memberof VbasApiUpdateVba
+     */
+    readonly updateVbaRequestDto: UpdateVbaRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VbasApiUpdateVba
+     */
+    readonly authorization?: string;
+}
+/**
+ * VbasApi - object-oriented interface
+ * @export
+ * @class VbasApi
+ * @extends {BaseAPI}
+ */
+export declare class VbasApi extends BaseAPI {
+    /**
+     * This will create an asynchronous vba, the method will return a code to retrieve the vba when it is ready.
+     * @summary Create the vba
+     * @param {VbasApiCreateVbaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbasApi
+     */
+    createVba(requestParameters: VbasApiCreateVbaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVbaResponseClass, any>>;
+    /**
+     * Retrieves the details of the vba that was previously created. Supply the unique vba code      that was returned when you created it and Emil Api will return the corresponding vba information.
+     * @summary Retrieve the vba
+     * @param {VbasApiGetVbaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbasApi
+     */
+    getVba(requestParameters: VbasApiGetVbaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetVbaResponseClass, any>>;
+    /**
+     * Returns a list of vbas you have previously created.        The vbas are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List vbas
+     * @param {VbasApiListVbasRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbasApi
+     */
+    listVbas(requestParameters?: VbasApiListVbasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListVbasResponseClass, any>>;
+    /**
+     * Updates the specified vba by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the vba
+     * @param {VbasApiUpdateVbaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VbasApi
+     */
+    updateVba(requestParameters: VbasApiUpdateVbaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateVbaRequestDto, any>>;
+}