@emilgroup/accounting-sdk-node 1.0.1-beta.2 → 1.0.1-beta.3

package/.openapi-generator/FILES

@@ -3,26 +3,28 @@
 .openapi-generator-ignore
 README.md
 api.ts
-api/default-api.ts
+api/booking-processes-api.ts
 api/financial-accounts-api.ts
-api/transactions-api.ts
+api/health-api.ts
 base.ts
 common.ts
 configuration.ts
 git_push.sh
 index.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/create-transaction-request-dto.ts
-models/create-transaction-response-class.ts
-models/entry-data-dto.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-financial-accounts-response-class.ts
-models/list-transactions-response-class.ts
-models/transaction-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-node@1.0.1-beta.2 --save
+npm install @emilgroup/accounting-sdk-node@1.0.1-beta.3 --save
 ```
 or 
 ```
-yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.2
+yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.3
 ```
 
 And then you can import `FinancialAccountsApi`.
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
 export EMIL_PASSWORD=XXXXXXXXXXXXXX
 ```
 
+## Base path
+
+To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
+
+```ts
+import { FinancialAccountsApi, Environment } from '@emilgroup/accounting-sdk-node'
+
+const financialAccountsApi = new FinancialAccountsApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+financialAccountsApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+financialAccountsApi.selectBasePath('https://my-custom-domain.com');
+```
+
 ## Example
 
 Here is a basic functionning example:

package/api/booking-processes-api.ts

@@ -0,0 +1,169 @@
+/* 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';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * BookingProcessesApi - axios parameter creator
+ * @export
+ */
+export const BookingProcessesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+         * @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,
+            };
+        },
+    }
+};
+
+/**
+ * BookingProcessesApi - functional programming interface
+ * @export
+ */
+export const BookingProcessesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = BookingProcessesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+         * @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);
+        },
+    }
+};
+
+/**
+ * BookingProcessesApi - factory interface
+ * @export
+ */
+export const BookingProcessesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = BookingProcessesApiFp(configuration)
+    return {
+        /**
+         * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+         * @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));
+        },
+    };
+};
+
+/**
+ * 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
+}
+
+/**
+ * BookingProcessesApi - object-oriented interface
+ * @export
+ * @class BookingProcessesApi
+ * @extends {BaseAPI}
+ */
+export class BookingProcessesApi extends BaseAPI {
+    /**
+     * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+     * @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));
+    }
+}

package/api/financial-accounts-api.ts

@@ -131,7 +131,7 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * Retrieves the details of the account that was previously created. Supply the unique account code        that was returned when you created it and Emil Api will return the corresponding account information.
+         * Retrieves the details of the account that was previously created. Supply the unique account code      that was returned when you created it and Emil Api will return the corresponding account information.
          * @summary Retrieve the account
          * @param {string} code Unique identifier for the object.
          * @param {string} expand 
@@ -293,7 +293,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Retrieves the details of the account that was previously created. Supply the unique account code        that was returned when you created it and Emil Api will return the corresponding account information.
+         * Retrieves the details of the account that was previously created. Supply the unique account code      that was returned when you created it and Emil Api will return the corresponding account information.
          * @summary Retrieve the account
          * @param {string} code Unique identifier for the object.
          * @param {string} expand 
@@ -356,7 +356,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
             return localVarFp.deleteFinancialAccount(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieves the details of the account that was previously created. Supply the unique account code        that was returned when you created it and Emil Api will return the corresponding account information.
+         * Retrieves the details of the account that was previously created. Supply the unique account code      that was returned when you created it and Emil Api will return the corresponding account information.
          * @summary Retrieve the account
          * @param {string} code Unique identifier for the object.
          * @param {string} expand 
@@ -552,7 +552,7 @@ export class FinancialAccountsApi extends BaseAPI {
     }
 
     /**
-     * Retrieves the details of the account that was previously created. Supply the unique account code        that was returned when you created it and Emil Api will return the corresponding account information.
+     * Retrieves the details of the account that was previously created. Supply the unique account code      that was returned when you created it and Emil Api will return the corresponding account information.
      * @summary Retrieve the account
      * @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/api/{default-api.ts → health-api.ts}

@@ -29,10 +29,10 @@ import { InlineResponse503 } from '../models';
 import { URL, URLSearchParams } from 'url';
 const FormData = require('form-data');
 /**
- * DefaultApi - axios parameter creator
+ * HealthApi - axios parameter creator
  * @export
  */
-export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
          * 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.
@@ -70,11 +70,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
 };
 
 /**
- * DefaultApi - functional programming interface
+ * HealthApi - functional programming interface
  * @export
  */
-export const DefaultApiFp = function(configuration?: Configuration) {
-    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
+export const HealthApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
     return {
         /**
          * 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.
@@ -90,11 +90,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
 };
 
 /**
- * DefaultApi - factory interface
+ * HealthApi - factory interface
  * @export
  */
-export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
-    const localVarFp = DefaultApiFp(configuration)
+export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = HealthApiFp(configuration)
     return {
         /**
          * 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.
@@ -109,20 +109,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
 };
 
 /**
- * DefaultApi - object-oriented interface
+ * HealthApi - object-oriented interface
  * @export
- * @class DefaultApi
+ * @class HealthApi
  * @extends {BaseAPI}
  */
-export class DefaultApi extends BaseAPI {
+export class HealthApi extends BaseAPI {
     /**
      * 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}
-     * @memberof DefaultApi
+     * @memberof HealthApi
      */
     public check(options?: AxiosRequestConfig) {
-        return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
+        return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
     }
 }

package/api.ts

@@ -24,12 +24,12 @@ import FormData from 'form-data'
 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';
-import { DefaultApi } from './api';
+import { BookingProcessesApi } from './api';
 import { FinancialAccountsApi } from './api';
-import { TransactionsApi } from './api';
+import { HealthApi } from './api';
 
 
-export * from './api/default-api';
+export * from './api/booking-processes-api';
 export * from './api/financial-accounts-api';
-export * from './api/transactions-api';
+export * from './api/health-api';
 

package/base.ts

@@ -79,6 +79,7 @@ export class BaseAPI {
     protected configuration: Configuration;
     private username?: string;
     private password?: string;
+    private permissions: Array<string> = [];
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
@@ -149,6 +150,10 @@ export class BaseAPI {
         this.configuration.basePath = env;
     }
 
+    getPermissions(): Array<string> {
+        return this.permissions;
+    }
+
     async authorize(username: string, password: string): Promise<void> {
         const options: AxiosRequestConfig = {
             method: 'POST',
@@ -163,20 +168,21 @@ export class BaseAPI {
 
         const response = await globalAxios.request<LoginClass>(options);
 
-        const { data: { accessToken } } = response;
+        const { data: { accessToken, permissions } } = response;
         this.configuration.username = username;
         this.configuration.accessToken = `Bearer ${accessToken}`;
+        this.permissions = permissions;
 
         const refreshToken = this.extractRefreshToken(response)
         this.configuration.refreshToken = refreshToken;
     }
 
-    async refreshTokenInternal(): Promise<string> {
+    async refreshTokenInternal(): Promise<LoginClass> {
         const { username, refreshToken } = this.configuration;
         
 
         if (!username || !refreshToken) {
-            return '';
+            throw new Error('Failed to refresh token.');
         }
 
         const options: AxiosRequestConfig = {
@@ -190,9 +196,9 @@ export class BaseAPI {
             withCredentials: true,
         };
 
-        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+        const response = await globalAxios.request<LoginClass>(options);
 
-        return accessToken;
+        return response.data;
     }
 
     private extractRefreshToken(response: AxiosResponse): string {
@@ -221,8 +227,9 @@ export class BaseAPI {
                     if (err.response.status === 401 && !originalConfig._retry) {
                         originalConfig._retry = true;
                         try {
-                            const tokenString = await this.refreshTokenInternal();
+                            const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                             const accessToken = `Bearer ${tokenString}`;
+                            this.permissions = permissions;
 
                             originalConfig.headers['Authorization'] = `Bearer ${accessToken}`
 
@@ -246,8 +253,9 @@ export class BaseAPI {
                 ){ 
                     _retry_count++;
                     try {
-                        const tokenString = await this.refreshTokenInternal();
+                        const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                         const accessToken = `Bearer ${tokenString}`;
+                        this.permissions = permissions;
 
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken; 

package/dist/api/booking-processes-api.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateBookingProcessRequestDto } from '../models';
+import { CreateBookingProcessResponseClass } from '../models';
+/**
+ * BookingProcessesApi - axios parameter creator
+ * @export
+ */
+export declare const BookingProcessesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+     * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BookingProcessesApi - functional programming interface
+ * @export
+ */
+export declare const BookingProcessesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+     * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBookingProcessResponseClass>>;
+};
+/**
+ * BookingProcessesApi - factory interface
+ * @export
+ */
+export declare const BookingProcessesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+     * @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>;
+};
+/**
+ * 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;
+}
+/**
+ * BookingProcessesApi - object-oriented interface
+ * @export
+ * @class BookingProcessesApi
+ * @extends {BaseAPI}
+ */
+export declare class BookingProcessesApi extends BaseAPI {
+    /**
+     * This will create an account in the database.      The account will be created with the provided name, type, and account number.      Optionally, you can provide a parent account ID to create a sub-account.
+     * @summary Create the booking process
+     * @param {BookingProcessesApiCreateBookingProcessRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingProcessesApi
+     */
+    createBookingProcess(requestParameters: BookingProcessesApiCreateBookingProcessRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingProcessResponseClass, any>>;
+}