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

package/.openapi-generator/FILES

@@ -17,6 +17,7 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/clawback-config-class.ts
 models/clawback-config-dto.ts
 models/commission-agreement-class.ts
 models/commission-agreement-metadata-dto.ts
@@ -26,12 +27,21 @@ models/commission-agreement-rule-class.ts
 models/commission-agreement-rule-config-dto.ts
 models/commission-agreement-rule-evaluation-class.ts
 models/commission-agreement-version-class.ts
+models/commission-agreement-version-config-class.ts
+models/commission-agreement-version-config-dto.ts
 models/commission-candidate-class.ts
 models/commission-class.ts
 models/commission-conditions-dto.ts
 models/commission-config-dto.ts
+models/commission-creation-config-class.ts
+models/commission-creation-config-dto.ts
+models/commission-creation-invoice-config-class.ts
+models/commission-creation-invoice-config-dto.ts
+models/commission-creation-renewal-config-class.ts
+models/commission-creation-renewal-config-dto.ts
 models/commission-estimate-class.ts
 models/commission-item-class.ts
+models/commission-paid-invoice-entry-class.ts
 models/commission-recipient-class.ts
 models/commission-settlement-class.ts
 models/create-commission-agreement-product-request-dto.ts
@@ -77,13 +87,16 @@ models/list-commission-agreement-rules-response-class.ts
 models/list-commission-agreement-versions-response-class.ts
 models/list-commission-agreements-response-class.ts
 models/list-commission-candidates-response-class.ts
+models/list-commission-paid-invoice-entries-response-class.ts
 models/list-commission-recipients-response-class.ts
 models/list-commission-settlements-response-class.ts
 models/list-commissions-response-class.ts
+models/list-scheduled-commission-clawback-triggers-response-class.ts
 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/scheduled-commission-clawback-trigger-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

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

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

@@ -243,10 +243,11 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvaluationDefaultData: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getEvaluationDefaultData: async (authorization?: string, commissionAgreementProductCode?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/commissionservice/v1/agreement-rules/evaluation-default-data`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -265,6 +266,10 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (commissionAgreementProductCode !== undefined) {
+                localVarQueryParameter['commissionAgreementProductCode'] = commissionAgreementProductCode;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -470,11 +475,12 @@ export const CommissionAgreementRulesApiFp = function(configuration?: Configurat
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluationDefaultData(authorization, options);
+        async getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -567,11 +573,12 @@ export const CommissionAgreementRulesApiFactory = function (configuration?: Conf
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass> {
-            return localVarFp.getEvaluationDefaultData(authorization, options).then((request) => request(axios, basePath));
+        getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass> {
+            return localVarFp.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieves a list of commission agreement rules.
@@ -708,6 +715,13 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
      * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
      */
     readonly authorization?: string
+
+    /**
+     * Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
+     * @type {string}
+     * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
+     */
+    readonly commissionAgreementProductCode?: string
 }
 
 /**
@@ -865,7 +879,7 @@ export class CommissionAgreementRulesApi extends BaseAPI {
      * @memberof CommissionAgreementRulesApi
      */
     public getEvaluationDefaultData(requestParameters: CommissionAgreementRulesApiGetEvaluationDefaultDataRequest = {}, options?: AxiosRequestConfig) {
-        return CommissionAgreementRulesApiFp(this.configuration).getEvaluationDefaultData(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return CommissionAgreementRulesApiFp(this.configuration).getEvaluationDefaultData(requestParameters.authorization, requestParameters.commissionAgreementProductCode, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/api/commission-settlements-api.ts

@@ -200,7 +200,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
          * @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 {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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=xxx to fetch the result.
          * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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 {'commissions'} [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.
@@ -208,7 +208,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissionSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCommissionSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/commissionservice/v1/commission-settlements`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -468,7 +468,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
          * @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 {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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 {'commissions'} [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.
@@ -476,7 +476,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>> {
+        async listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -567,7 +567,7 @@ export const CommissionSettlementsApiFactory = 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-         * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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 {'commissions'} [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.
@@ -575,7 +575,7 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass> {
+        listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass> {
             return localVarFp.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
@@ -714,10 +714,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
 
     /**
      * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
+     * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
      * @memberof CommissionSettlementsApiListCommissionSettlements
      */
-    readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
+    readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'
 
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.