@emilgroup/accounting-sdk 1.19.0 → 1.20.0

package/api/financial-transactions-api.ts

@@ -0,0 +1,365 @@
+/* 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 { GetFinancialTransactionResponseClass } from '../models';
+// @ts-ignore
+import { ListFinancialTransactionsResponseClass } from '../models';
+/**
+ * FinancialTransactionsApi - axios parameter creator
+ * @export
+ */
+export const FinancialTransactionsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This endpoint gets a financial transaction.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary Retrieve the financial transaction
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFinancialTransaction: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getFinancialTransaction', 'code', code)
+            // verify required parameter 'expand' is not null or undefined
+            assertParamExists('getFinancialTransaction', 'expand', expand)
+            const localVarPath = `/accountingservice/v1/financial-transactions/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // 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 (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            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,
+            };
+        },
+        /**
+         * This endpoint list financial transactions.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary List financial transactions
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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.
+         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {string} [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.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFinancialTransactions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/accountingservice/v1/financial-transactions`;
+            // 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,
+            };
+        },
+    }
+};
+
+/**
+ * FinancialTransactionsApi - functional programming interface
+ * @export
+ */
+export const FinancialTransactionsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = FinancialTransactionsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This endpoint gets a financial transaction.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary Retrieve the financial transaction
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getFinancialTransaction(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialTransactionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getFinancialTransaction(code, expand, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This endpoint list financial transactions.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary List financial transactions
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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.
+         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {string} [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.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listFinancialTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialTransactionsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * FinancialTransactionsApi - factory interface
+ * @export
+ */
+export const FinancialTransactionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = FinancialTransactionsApiFp(configuration)
+    return {
+        /**
+         * This endpoint gets a financial transaction.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary Retrieve the financial transaction
+         * @param {string} code 
+         * @param {string} expand 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFinancialTransaction(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialTransactionResponseClass> {
+            return localVarFp.getFinancialTransaction(code, expand, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This endpoint list financial transactions.  **Required Permissions**  \"accounting-management.accounts.view\"
+         * @summary List financial transactions
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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.
+         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {string} [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.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFinancialTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialTransactionsResponseClass> {
+            return localVarFp.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getFinancialTransaction operation in FinancialTransactionsApi.
+ * @export
+ * @interface FinancialTransactionsApiGetFinancialTransactionRequest
+ */
+export interface FinancialTransactionsApiGetFinancialTransactionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof FinancialTransactionsApiGetFinancialTransaction
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof FinancialTransactionsApiGetFinancialTransaction
+     */
+    readonly expand: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialTransactionsApiGetFinancialTransaction
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listFinancialTransactions operation in FinancialTransactionsApi.
+ * @export
+ * @interface FinancialTransactionsApiListFinancialTransactionsRequest
+ */
+export interface FinancialTransactionsApiListFinancialTransactionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly pageSize?: number
+
+    /**
+     * 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 {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly pageToken?: string
+
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly filter?: string
+
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly search?: string
+
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    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 {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly expand?: string
+
+    /**
+     * 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 {string}
+     * @memberof FinancialTransactionsApiListFinancialTransactions
+     */
+    readonly filters?: string
+}
+
+/**
+ * FinancialTransactionsApi - object-oriented interface
+ * @export
+ * @class FinancialTransactionsApi
+ * @extends {BaseAPI}
+ */
+export class FinancialTransactionsApi extends BaseAPI {
+    /**
+     * This endpoint gets a financial transaction.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the financial transaction
+     * @param {FinancialTransactionsApiGetFinancialTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialTransactionsApi
+     */
+    public getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig) {
+        return FinancialTransactionsApiFp(this.configuration).getFinancialTransaction(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This endpoint list financial transactions.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List financial transactions
+     * @param {FinancialTransactionsApiListFinancialTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialTransactionsApi
+     */
+    public listFinancialTransactions(requestParameters: FinancialTransactionsApiListFinancialTransactionsRequest = {}, options?: AxiosRequestConfig) {
+        return FinancialTransactionsApiFp(this.configuration).listFinancialTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api/health-api.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -31,13 +31,13 @@ import { InlineResponse503 } from '../models';
 export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Returns the health status of the GdvService service.        This endpoint is used to monitor the operational status of the GdvService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * Returns the health status of the accounting service.        This endpoint is used to monitor the operational status of the accounting service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
          * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/gdvservice/health`;
+            const localVarPath = `/accountingservice/health`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -73,7 +73,7 @@ export const HealthApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
     return {
         /**
-         * Returns the health status of the GdvService service.        This endpoint is used to monitor the operational status of the GdvService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * Returns the health status of the accounting service.        This endpoint is used to monitor the operational status of the accounting service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
          * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -93,7 +93,7 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat
     const localVarFp = HealthApiFp(configuration)
     return {
         /**
-         * Returns the health status of the GdvService service.        This endpoint is used to monitor the operational status of the GdvService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * Returns the health status of the accounting service.        This endpoint is used to monitor the operational status of the accounting service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
          * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -112,7 +112,7 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat
  */
 export class HealthApi extends BaseAPI {
     /**
-     * Returns the health status of the GdvService service.        This endpoint is used to monitor the operational status of the GdvService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * Returns the health status of the accounting service.        This endpoint is used to monitor the operational status of the accounting service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
      * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}