@emilgroup/accounting-sdk 1.10.0 → 1.11.1-beta.0

package/.openapi-generator/FILES

@@ -3,66 +3,29 @@
 .openapi-generator-ignore
 README.md
 api.ts
+api/booking-processes-api.ts
+api/financial-accounts-api.ts
 api/health-api.ts
-api/mailbox-api.ts
-api/messages-api.ts
-api/users-api.ts
-api/vbas-api.ts
-api/vbus-api.ts
-api/zip-codes-api.ts
 base.ts
 common.ts
 configuration.ts
 git_push.sh
 index.ts
-models/address-class.ts
-models/create-mailbox-request-dto.ts
-models/create-user-request-dto.ts
-models/create-user-response-class.ts
-models/create-vba-request-dto.ts
-models/create-vba-response-class.ts
-models/create-vbu-request-dto.ts
-models/create-vbu-response-class.ts
-models/create-vbuv-request-dto.ts
-models/create-vbuv-response-class.ts
-models/get-request-message-response-class.ts
-models/get-response-message-response-class.ts
-models/get-user-response-class.ts
-models/get-vba-response-class.ts
-models/get-vbu-response-class.ts
-models/get-zip-code-response-class.ts
+models/booking-entry-class.ts
+models/booking-process-class.ts
+models/create-booking-entry-request-dto.ts
+models/create-booking-process-request-dto.ts
+models/create-booking-process-response-class.ts
+models/create-financial-account-request-dto.ts
+models/create-financial-account-response-class.ts
+models/financial-account-class.ts
+models/financial-transaction-class.ts
+models/financial-transaction-data-dto.ts
+models/get-financial-account-response-class.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
-models/list-all-messages-response-class.ts
-models/list-requests-messages-response-class.ts
-models/list-responses-messages-response-class.ts
-models/list-users-response-class.ts
-models/list-vbas-response-class.ts
-models/list-vbus-response-class.ts
-models/list-zip-codes-response-class.ts
-models/message-class.ts
-models/request-details-class.ts
-models/request-message-class.ts
-models/response-details-class.ts
-models/response-message-class.ts
-models/store-zip-codes-request-dto.ts
-models/store-zip-codes-response-class.ts
-models/update-request-message-request-dto.ts
-models/update-request-message-response-class.ts
-models/update-response-message-request-dto.ts
-models/update-response-message-response-class.ts
-models/update-user-request-dto.ts
-models/update-user-response-class.ts
-models/update-vba-request-dto.ts
-models/update-vbu-request-dto.ts
-models/update-vbu-response-class.ts
-models/user-class.ts
-models/vba-class.ts
-models/vba-response-class.ts
-models/vbu-class.ts
-models/vbu-response-class.ts
-models/xlsx-zip-code-dto.ts
-models/zip-code-class.ts
+models/list-booking-process-response-class.ts
+models/list-financial-accounts-response-class.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/accounting-sdk@1.10.0 --save
+npm install @emilgroup/accounting-sdk@1.11.1-beta.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/accounting-sdk@1.10.0
+yarn add @emilgroup/accounting-sdk@1.11.1-beta.0
 ```
 
 And then you can import `FinancialAccountsApi`.

package/api/booking-processes-api.ts

@@ -0,0 +1,353 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { CreateBookingProcessRequestDto } from '../models';
+// @ts-ignore
+import { CreateBookingProcessResponseClass } from '../models';
+// @ts-ignore
+import { ListBookingProcessResponseClass } from '../models';
+/**
+ * BookingProcessesApi - axios parameter creator
+ * @export
+ */
+export const BookingProcessesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This endpoint creates a new booking process.
+         * @summary Create the booking process
+         * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createBookingProcess: async (createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createBookingProcessRequestDto' is not null or undefined
+            assertParamExists('createBookingProcess', 'createBookingProcessRequestDto', createBookingProcessRequestDto)
+            const localVarPath = `/accountingservice/v1/booking-processes`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createBookingProcessRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns a list of Booking processes you have previously created.          The Booking processes are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * @summary List Booking processes
+         * @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 {string} [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: code&lt;/i&gt;
+         * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBookingProcesses: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/accountingservice/v1/booking-processes`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * BookingProcessesApi - functional programming interface
+ * @export
+ */
+export const BookingProcessesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = BookingProcessesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This endpoint creates a new booking process.
+         * @summary Create the booking process
+         * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createBookingProcess(createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBookingProcessResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createBookingProcess(createBookingProcessRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a list of Booking processes you have previously created.          The Booking processes are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * @summary List Booking processes
+         * @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 {string} [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: code&lt;/i&gt;
+         * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingProcessResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * BookingProcessesApi - factory interface
+ * @export
+ */
+export const BookingProcessesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = BookingProcessesApiFp(configuration)
+    return {
+        /**
+         * This endpoint creates a new booking process.
+         * @summary Create the booking process
+         * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createBookingProcess(createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingProcessResponseClass> {
+            return localVarFp.createBookingProcess(createBookingProcessRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a list of Booking processes you have previously created.          The Booking processes are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * @summary List Booking processes
+         * @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 {string} [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: code&lt;/i&gt;
+         * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListBookingProcessResponseClass> {
+            return localVarFp.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createBookingProcess operation in BookingProcessesApi.
+ * @export
+ * @interface BookingProcessesApiCreateBookingProcessRequest
+ */
+export interface BookingProcessesApiCreateBookingProcessRequest {
+    /**
+     * 
+     * @type {CreateBookingProcessRequestDto}
+     * @memberof BookingProcessesApiCreateBookingProcess
+     */
+    readonly createBookingProcessRequestDto: CreateBookingProcessRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingProcessesApiCreateBookingProcess
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listBookingProcesses operation in BookingProcessesApi.
+ * @export
+ * @interface BookingProcessesApiListBookingProcessesRequest
+ */
+export interface BookingProcessesApiListBookingProcessesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    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 BookingProcessesApiListBookingProcesses
+     */
+    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: code&lt;/i&gt;
+     * @type {string}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly filter?: string
+
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly search?: any
+
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly order?: string
+
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly expand?: any
+
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code&lt;/i&gt;
+     * @type {string}
+     * @memberof BookingProcessesApiListBookingProcesses
+     */
+    readonly filters?: string
+}
+
+/**
+ * BookingProcessesApi - object-oriented interface
+ * @export
+ * @class BookingProcessesApi
+ * @extends {BaseAPI}
+ */
+export class BookingProcessesApi extends BaseAPI {
+    /**
+     * This endpoint creates a new booking process.
+     * @summary Create the booking process
+     * @param {BookingProcessesApiCreateBookingProcessRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingProcessesApi
+     */
+    public createBookingProcess(requestParameters: BookingProcessesApiCreateBookingProcessRequest, options?: AxiosRequestConfig) {
+        return BookingProcessesApiFp(this.configuration).createBookingProcess(requestParameters.createBookingProcessRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a list of Booking processes you have previously created.          The Booking processes are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List Booking processes
+     * @param {BookingProcessesApiListBookingProcessesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingProcessesApi
+     */
+    public listBookingProcesses(requestParameters: BookingProcessesApiListBookingProcessesRequest = {}, options?: AxiosRequestConfig) {
+        return BookingProcessesApiFp(this.configuration).listBookingProcesses(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}