@emilgroup/commission-sdk-node 2.9.1-beta.5 → 2.9.1-beta.6

package/.openapi-generator/FILES

@@ -17,6 +17,7 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/clawback-config-dto.ts
 models/commission-agreement-class.ts
 models/commission-agreement-metadata-dto.ts
 models/commission-agreement-metadata-partner-dto.ts
@@ -43,6 +44,8 @@ models/create-commission-agreement-version-request-dto.ts
 models/create-commission-agreement-version-response-class.ts
 models/create-commission-candidate-request-dto.ts
 models/create-commission-candidate-response-class.ts
+models/create-commission-clawback-request-dto.ts
+models/create-commission-clawback-response-class.ts
 models/create-commission-item-request-dto.ts
 models/create-commission-recipient-for-products-request-dto.ts
 models/create-commission-recipient-for-products-response-class.ts
@@ -81,6 +84,10 @@ models/patch-commission-agreement-status-request-dto.ts
 models/patch-commission-agreement-status-response-class.ts
 models/publish-commission-settlements-request-dto.ts
 models/publish-commission-settlements-response-class.ts
+models/trigger-commission-settlement-creation-request-dto.ts
+models/trigger-commission-settlement-creation-response-class.ts
+models/trigger-due-commission-clawbacks-request-dto.ts
+models/trigger-due-commission-clawbacks-response-class.ts
 models/update-commission-agreement-product-request-dto.ts
 models/update-commission-agreement-product-response-class.ts
 models/update-commission-agreement-request-dto.ts

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/commission-sdk-node@2.9.1-beta.5 --save
+npm install @emilgroup/commission-sdk-node@2.9.1-beta.6 --save
 ```
 or 
 ```
-yarn add @emilgroup/commission-sdk-node@2.9.1-beta.5
+yarn add @emilgroup/commission-sdk-node@2.9.1-beta.6
 ```
 
 And then you can import `CommissionApi`.

package/api/commission-agreement-versions-api.ts

@@ -188,11 +188,11 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
          * @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=1, your subsequent call can include pageToken=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.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=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.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate, settlementCreationDate</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: agreements<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -311,11 +311,11 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
          * @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=1, your subsequent call can include pageToken=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.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=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.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate, settlementCreationDate</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: agreements<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -373,11 +373,11 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
          * @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=1, your subsequent call can include pageToken=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.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=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.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate, settlementCreationDate</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: agreements<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -485,7 +485,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
     readonly pageToken?: string
 
     /**
-     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */
@@ -499,7 +499,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
     readonly search?: string
 
     /**
-     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate</i>
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: code, createdAt, startDate, endDate, settlementCreationDate</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */
@@ -513,7 +513,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
     readonly expand?: string
 
     /**
-     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
+     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */

package/api/commission-settlements-api.ts

@@ -33,6 +33,10 @@ import { PublishCommissionSettlementsRequestDto } from '../models';
 // @ts-ignore
 import { PublishCommissionSettlementsResponseClass } from '../models';
 // @ts-ignore
+import { TriggerCommissionSettlementCreationRequestDto } from '../models';
+// @ts-ignore
+import { TriggerCommissionSettlementCreationResponseClass } from '../models';
+// @ts-ignore
 import { UpdateCommissionSettlementRequestDto } from '../models';
 // @ts-ignore
 import { UpdateCommissionSettlementResponseClass } from '../models';
@@ -313,6 +317,53 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Triggers the commission settlement creation job.
+         * @summary Create the commission settlement creation job
+         * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerCommissionSettlementCreation: async (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'triggerCommissionSettlementCreationRequestDto' is not null or undefined
+            assertParamExists('triggerCommissionSettlementCreation', 'triggerCommissionSettlementCreationRequestDto', triggerCommissionSettlementCreationRequestDto)
+            const localVarPath = `/commissionservice/v1/commission-settlements/commission-settlement-creation/trigger`;
+            // 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(triggerCommissionSettlementCreationRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * This will update commission settlement.
          * @summary Update the commission settlement
@@ -441,6 +492,18 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
             const localVarAxiosArgs = await localVarAxiosParamCreator.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Triggers the commission settlement creation job.
+         * @summary Create the commission settlement creation job
+         * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This will update commission settlement.
          * @summary Update the commission settlement
@@ -526,6 +589,17 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
         publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass> {
             return localVarFp.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Triggers the commission settlement creation job.
+         * @summary Create the commission settlement creation job
+         * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass> {
+            return localVarFp.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This will update commission settlement.
          * @summary Update the commission settlement
@@ -695,6 +769,27 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
+ */
+export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
+    /**
+     * 
+     * @type {TriggerCommissionSettlementCreationRequestDto}
+     * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
+     */
+    readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
  * @export
@@ -790,6 +885,18 @@ export class CommissionSettlementsApi extends BaseAPI {
         return CommissionSettlementsApiFp(this.configuration).publishCommissionSettlements(requestParameters.publishCommissionSettlementsRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Triggers the commission settlement creation job.
+     * @summary Create the commission settlement creation job
+     * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    public triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig) {
+        return CommissionSettlementsApiFp(this.configuration).triggerCommissionSettlementCreation(requestParameters.triggerCommissionSettlementCreationRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This will update commission settlement.
      * @summary Update the commission settlement