@emilgroup/accounting-sdk-node 1.32.1-beta.3 → 1.32.1-beta.30

package/.openapi-generator/FILES

@@ -5,11 +5,13 @@ README.md
 api.ts
 api/accounting-configs-api.ts
 api/booking-entries-api.ts
+api/commission-account-mappings-api.ts
 api/financial-accounts-api.ts
 api/financial-transactions-api.ts
 api/health-api.ts
 api/number-ranges-api.ts
 api/personal-accounts-api.ts
+api/product-account-mappings-api.ts
 base.ts
 common.ts
 configuration.ts
@@ -24,6 +26,11 @@ models/accounting-config-data-dto-default-account-mappings.ts
 models/accounting-config-data-dto.ts
 models/accounting-configuration-class.ts
 models/booking-entry-class.ts
+models/commission-account-mapping-class.ts
+models/commission-agreement-account-mapping-detail-class.ts
+models/commission-agreement-partner-class.ts
+models/commission-agreement-with-account-mapping-class.ts
+models/commission-type-account-mapping-class.ts
 models/create-and-enable-subledger-request-dto.ts
 models/create-and-enable-subledger-response-class.ts
 models/create-booking-entry-request-dto.ts
@@ -39,6 +46,7 @@ models/financial-account-class.ts
 models/financial-transaction-class.ts
 models/financial-transaction-data-dto.ts
 models/get-accounting-categories-response-class.ts
+models/get-activation-snapshot-response-class.ts
 models/get-booking-entry-response-class.ts
 models/get-financial-account-response-class.ts
 models/get-financial-transaction-response-class.ts
@@ -48,12 +56,34 @@ models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
 models/list-booking-entries-response-class.ts
+models/list-commission-account-mappings-response-class.ts
+models/list-commission-agreements-with-account-mappings-response-class.ts
+models/list-commission-type-account-mappings-response-class.ts
 models/list-financial-accounts-response-class.ts
 models/list-financial-transactions-response-class.ts
 models/list-number-range-response-class.ts
 models/list-personal-accounts-response-class.ts
+models/list-product-account-mappings-response-class.ts
+models/list-products-with-account-mappings-response-class.ts
 models/number-range-class.ts
 models/personal-account-class.ts
+models/post-financial-event-request-dto.ts
+models/post-financial-event-response-class.ts
+models/premium-item-account-mapping-class.ts
+models/product-account-mapping-class.ts
+models/product-account-mapping-detail-class.ts
+models/product-version-account-mapping-detail-class.ts
+models/product-version-with-account-mappings-class.ts
+models/product-with-account-mappings-class.ts
+models/put-premium-item-account-body-dto.ts
+models/put-product-category-account-body-dto.ts
+models/put-product-version-category-account-body-dto.ts
+models/resolved-account-mapping-class.ts
+models/resolved-commission-account-mapping-class.ts
+models/update-commission-agreement-account-body-dto.ts
+models/update-commission-type-account-body-dto.ts
+models/update-financial-account-body-dto.ts
+models/update-financial-account-response-class.ts
 models/validate-accounting-config-request-dto.ts
 models/validate-accounting-config-response-class.ts
 package.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.32.1-beta.3 --save
+npm install @emilgroup/accounting-sdk-node@1.32.1-beta.30 --save
 ```
 or 
 ```
-yarn add @emilgroup/accounting-sdk-node@1.32.1-beta.3
+yarn add @emilgroup/accounting-sdk-node@1.32.1-beta.30
 ```
 
 And then you can import `FinancialAccountsApi`.

package/api/accounting-configs-api.ts

@@ -29,6 +29,8 @@ import { ExportAccountingConfigResponseClass } from '../models';
 // @ts-ignore
 import { GetAccountingCategoriesResponseClass } from '../models';
 // @ts-ignore
+import { GetActivationSnapshotResponseClass } from '../models';
+// @ts-ignore
 import { ValidateAccountingConfigRequestDto } from '../models';
 // @ts-ignore
 import { ValidateAccountingConfigResponseClass } from '../models';
@@ -53,7 +55,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
         createAndEnableSubledger: async (createAndEnableSubledgerRequestDto: CreateAndEnableSubledgerRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'createAndEnableSubledgerRequestDto' is not null or undefined
             assertParamExists('createAndEnableSubledger', 'createAndEnableSubledgerRequestDto', createAndEnableSubledgerRequestDto)
-            const localVarPath = `/accountingservice/v1/accountingconfigs`;
+            const localVarPath = `/accountingservice/v1/subledger`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -100,7 +102,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
         createAndEnableSubledgerFromFile: async (file: any, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'file' is not null or undefined
             assertParamExists('createAndEnableSubledgerFromFile', 'file', file)
-            const localVarPath = `/accountingservice/v1/accountingconfigs/upload`;
+            const localVarPath = `/accountingservice/v1/subledger/upload`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -150,7 +152,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
          * @throws {RequiredError}
          */
         exportAccountingConfig: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/accountingservice/v1/accountingconfigs`;
+            const localVarPath = `/accountingservice/v1/subledger/config/export`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -191,7 +193,48 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
          * @throws {RequiredError}
          */
         getAccountingCategories: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/accountingservice/v1/accountingconfigs/categories`;
+            const localVarPath = `/accountingservice/v1/subledger/categories`;
+            // 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 (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,
+            };
+        },
+        /**
+         * Returns the subledger configuration as it was when the subledger was enabled, along with who created it, when, and its enablement status.  **Required Permissions**  \"accounting-management.financial-accounts.view\"
+         * @summary Retrieve the get activation snapshot
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getActivationSnapshot: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/accountingservice/v1/subledger/activation-snapshot`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -232,7 +275,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
          * @throws {RequiredError}
          */
         resetSubledger: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/accountingservice/v1/accountingconfigs`;
+            const localVarPath = `/accountingservice/v1/subledger/reset`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -276,7 +319,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
         validateAccountingConfig: async (validateAccountingConfigRequestDto: ValidateAccountingConfigRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'validateAccountingConfigRequestDto' is not null or undefined
             assertParamExists('validateAccountingConfig', 'validateAccountingConfigRequestDto', validateAccountingConfigRequestDto)
-            const localVarPath = `/accountingservice/v1/accountingconfigs/validate`;
+            const localVarPath = `/accountingservice/v1/subledger/config/validate`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -323,7 +366,7 @@ export const AccountingConfigsApiAxiosParamCreator = function (configuration?: C
         validateAccountingConfigFromFile: async (file: any, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'file' is not null or undefined
             assertParamExists('validateAccountingConfigFromFile', 'file', file)
-            const localVarPath = `/accountingservice/v1/accountingconfigs/validate/upload`;
+            const localVarPath = `/accountingservice/v1/subledger/config/validate/upload`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -421,6 +464,17 @@ export const AccountingConfigsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountingCategories(authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Returns the subledger configuration as it was when the subledger was enabled, along with who created it, when, and its enablement status.  **Required Permissions**  \"accounting-management.financial-accounts.view\"
+         * @summary Retrieve the get activation snapshot
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getActivationSnapshot(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActivationSnapshotResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getActivationSnapshot(authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This will reset the subledger, and remove all config and accounts.  **Required Permissions**  \"accounting-management.financial-accounts.delete\"
          * @summary Delete the reset subledger
@@ -508,6 +562,16 @@ export const AccountingConfigsApiFactory = function (configuration?: Configurati
         getAccountingCategories(authorization?: string, options?: any): AxiosPromise<GetAccountingCategoriesResponseClass> {
             return localVarFp.getAccountingCategories(authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the subledger configuration as it was when the subledger was enabled, along with who created it, when, and its enablement status.  **Required Permissions**  \"accounting-management.financial-accounts.view\"
+         * @summary Retrieve the get activation snapshot
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getActivationSnapshot(authorization?: string, options?: any): AxiosPromise<GetActivationSnapshotResponseClass> {
+            return localVarFp.getActivationSnapshot(authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This will reset the subledger, and remove all config and accounts.  **Required Permissions**  \"accounting-management.financial-accounts.delete\"
          * @summary Delete the reset subledger
@@ -613,6 +677,20 @@ export interface AccountingConfigsApiGetAccountingCategoriesRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for getActivationSnapshot operation in AccountingConfigsApi.
+ * @export
+ * @interface AccountingConfigsApiGetActivationSnapshotRequest
+ */
+export interface AccountingConfigsApiGetActivationSnapshotRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountingConfigsApiGetActivationSnapshot
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for resetSubledger operation in AccountingConfigsApi.
  * @export
@@ -724,6 +802,18 @@ export class AccountingConfigsApi extends BaseAPI {
         return AccountingConfigsApiFp(this.configuration).getAccountingCategories(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns the subledger configuration as it was when the subledger was enabled, along with who created it, when, and its enablement status.  **Required Permissions**  \"accounting-management.financial-accounts.view\"
+     * @summary Retrieve the get activation snapshot
+     * @param {AccountingConfigsApiGetActivationSnapshotRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountingConfigsApi
+     */
+    public getActivationSnapshot(requestParameters: AccountingConfigsApiGetActivationSnapshotRequest = {}, options?: AxiosRequestConfig) {
+        return AccountingConfigsApiFp(this.configuration).getActivationSnapshot(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This will reset the subledger, and remove all config and accounts.  **Required Permissions**  \"accounting-management.financial-accounts.delete\"
      * @summary Delete the reset subledger

package/api/booking-entries-api.ts

@@ -28,6 +28,10 @@ import { CreateBookingEntryResponseClass } from '../models';
 import { GetBookingEntryResponseClass } from '../models';
 // @ts-ignore
 import { ListBookingEntriesResponseClass } from '../models';
+// @ts-ignore
+import { PostFinancialEventRequestDto } from '../models';
+// @ts-ignore
+import { PostFinancialEventResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -208,6 +212,53 @@ export const BookingEntriesApiAxiosParamCreator = function (configuration?: Conf
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postFinancialEvent: async (postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'postFinancialEventRequestDto' is not null or undefined
+            assertParamExists('postFinancialEvent', 'postFinancialEventRequestDto', postFinancialEventRequestDto)
+            const localVarPath = `/accountingservice/v1/booking-entries/post-financial-event`;
+            // 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(postFinancialEventRequestDto, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -266,6 +317,18 @@ export const BookingEntriesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postFinancialEvent(postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFinancialEventResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postFinancialEvent(postFinancialEventRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     }
 };
 
@@ -316,6 +379,17 @@ export const BookingEntriesApiFactory = function (configuration?: Configuration,
         listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBookingEntriesResponseClass> {
             return localVarFp.listBookingEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+         * @summary Create the booking entry from a source entity
+         * @param {PostFinancialEventRequestDto} postFinancialEventRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postFinancialEvent(postFinancialEventRequestDto: PostFinancialEventRequestDto, authorization?: string, options?: any): AxiosPromise<PostFinancialEventResponseClass> {
+            return localVarFp.postFinancialEvent(postFinancialEventRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -431,6 +505,27 @@ export interface BookingEntriesApiListBookingEntriesRequest {
     readonly filters?: string
 }
 
+/**
+ * Request parameters for postFinancialEvent operation in BookingEntriesApi.
+ * @export
+ * @interface BookingEntriesApiPostFinancialEventRequest
+ */
+export interface BookingEntriesApiPostFinancialEventRequest {
+    /**
+     * 
+     * @type {PostFinancialEventRequestDto}
+     * @memberof BookingEntriesApiPostFinancialEvent
+     */
+    readonly postFinancialEventRequestDto: PostFinancialEventRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingEntriesApiPostFinancialEvent
+     */
+    readonly authorization?: string
+}
+
 /**
  * BookingEntriesApi - object-oriented interface
  * @export
@@ -473,4 +568,16 @@ export class BookingEntriesApi extends BaseAPI {
     public listBookingEntries(requestParameters: BookingEntriesApiListBookingEntriesRequest = {}, options?: AxiosRequestConfig) {
         return BookingEntriesApiFp(this.configuration).listBookingEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * This endpoint posts the booking entry for an existing invoice, payment,     exceeding credit or credit allocation on demand. The entity is fetched from the service     that owns it and run through the same posting flow its domain event triggers, so the     call is idempotent: an entity that is already posted returns its existing booking entry.     When the flow deliberately posts nothing (subledger not active for the booking date,     non-positive amount) the call fails with a precondition error carrying the reason.  **Required Permissions**  \"accounting-management.entries.create\"
+     * @summary Create the booking entry from a source entity
+     * @param {BookingEntriesApiPostFinancialEventRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingEntriesApi
+     */
+    public postFinancialEvent(requestParameters: BookingEntriesApiPostFinancialEventRequest, options?: AxiosRequestConfig) {
+        return BookingEntriesApiFp(this.configuration).postFinancialEvent(requestParameters.postFinancialEventRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
 }