@emilgroup/commission-sdk-node 1.0.0-beta.21 → 1.0.0-beta.23

package/api/commissions-api.ts

@@ -192,7 +192,7 @@ export const CommissionsApiAxiosParamCreator = 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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [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 {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [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.
@@ -200,7 +200,7 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/commissionservice/v1/commissions`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -366,7 +366,7 @@ export const CommissionsApiFp = 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' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [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 {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [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.
@@ -374,7 +374,7 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
+        async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -441,7 +441,7 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
          * @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' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [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 {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [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.
@@ -449,7 +449,7 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
+        listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
             return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
@@ -566,10 +566,10 @@ export interface CommissionsApiListCommissionsRequest {
 
     /**
      * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'}
+     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'
+    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'
 
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.

package/api.ts

@@ -29,6 +29,7 @@ import { CommissionAgreementRulesApi } from './api';
 import { CommissionAgreementVersionsApi } from './api';
 import { CommissionAgreementsApi } from './api';
 import { CommissionRecipientsApi } from './api';
+import { CommissionSettlementsApi } from './api';
 import { CommissionsApi } from './api';
 import { DefaultApi } from './api';
 
@@ -38,6 +39,7 @@ export * from './api/commission-agreement-rules-api';
 export * from './api/commission-agreement-versions-api';
 export * from './api/commission-agreements-api';
 export * from './api/commission-recipients-api';
+export * from './api/commission-settlements-api';
 export * from './api/commissions-api';
 export * from './api/default-api';
 

package/dist/api/commission-settlements-api.d.ts

@@ -0,0 +1,450 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CreateCommissionSettlementRequestDto } from '../models';
+import { CreateCommissionSettlementResponseClass } from '../models';
+import { GetCommissionSettlementResponseClass } from '../models';
+import { ListCommissionSettlementsResponseClass } from '../models';
+import { PublishCommissionSettlementsRequestDto } from '../models';
+import { PublishCommissionSettlementsResponseClass } from '../models';
+import { UpdateCommissionSettlementRequestDto } from '../models';
+import { UpdateCommissionSettlementResponseClass } from '../models';
+/**
+ * CommissionSettlementsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create commission settlement.
+     * @summary Create the commission settlement
+     * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionSettlement: (createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete commission settlement.
+     * @summary Delete the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionSettlement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get commission settlement.
+     * @summary Retrieve the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionSettlement: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of commission settlements.
+     * @summary List commission settlements
+     * @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' | '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 {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {'code' | 'settlementNumber' | '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.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will publish multiple commission settlements.
+     * @summary Create the commission settlement publish
+     * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    publishCommissionSettlements: (publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update commission settlement.
+     * @summary Update the commission settlement
+     * @param {string} code
+     * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionSettlement: (code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionSettlementsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionSettlementsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create commission settlement.
+     * @summary Create the commission settlement
+     * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionSettlement(createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionSettlementResponseClass>>;
+    /**
+     * This will delete commission settlement.
+     * @summary Delete the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get commission settlement.
+     * @summary Retrieve the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionSettlement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionSettlementResponseClass>>;
+    /**
+     * Retrieves a list of commission settlements.
+     * @summary List commission settlements
+     * @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' | '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 {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {'code' | 'settlementNumber' | '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.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
+    /**
+     * This will publish multiple commission settlements.
+     * @summary Create the commission settlement publish
+     * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublishCommissionSettlementsResponseClass>>;
+    /**
+     * This will update commission settlement.
+     * @summary Update the commission settlement
+     * @param {string} code
+     * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionSettlement(code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionSettlementResponseClass>>;
+};
+/**
+ * CommissionSettlementsApi - factory interface
+ * @export
+ */
+export declare const CommissionSettlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create commission settlement.
+     * @summary Create the commission settlement
+     * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionSettlement(createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionSettlementResponseClass>;
+    /**
+     * This will delete commission settlement.
+     * @summary Delete the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCommissionSettlement(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get commission settlement.
+     * @summary Retrieve the commission settlement
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionSettlement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionSettlementResponseClass>;
+    /**
+     * Retrieves a list of commission settlements.
+     * @summary List commission settlements
+     * @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' | '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 {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {'code' | 'settlementNumber' | '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.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
+    /**
+     * This will publish multiple commission settlements.
+     * @summary Create the commission settlement publish
+     * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass>;
+    /**
+     * This will update commission settlement.
+     * @summary Update the commission settlement
+     * @param {string} code
+     * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionSettlement(code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionSettlementResponseClass>;
+};
+/**
+ * Request parameters for createCommissionSettlement operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiCreateCommissionSettlementRequest
+ */
+export interface CommissionSettlementsApiCreateCommissionSettlementRequest {
+    /**
+     *
+     * @type {CreateCommissionSettlementRequestDto}
+     * @memberof CommissionSettlementsApiCreateCommissionSettlement
+     */
+    readonly createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiCreateCommissionSettlement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionSettlement operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiDeleteCommissionSettlementRequest
+ */
+export interface CommissionSettlementsApiDeleteCommissionSettlementRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionSettlementsApiDeleteCommissionSettlement
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiDeleteCommissionSettlement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionSettlement operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiGetCommissionSettlementRequest
+ */
+export interface CommissionSettlementsApiGetCommissionSettlementRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionSettlementsApiGetCommissionSettlement
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionSettlementsApiGetCommissionSettlement
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiGetCommissionSettlement
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionSettlements operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiListCommissionSettlementsRequest
+ */
+export interface CommissionSettlementsApiListCommissionSettlementsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly pageToken?: string;
+    /**
+     * 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' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly search?: string;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt';
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {'commissions'}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly expand?: 'commissions';
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof CommissionSettlementsApiListCommissionSettlements
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for publishCommissionSettlements operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiPublishCommissionSettlementsRequest
+ */
+export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
+    /**
+     *
+     * @type {PublishCommissionSettlementsRequestDto}
+     * @memberof CommissionSettlementsApiPublishCommissionSettlements
+     */
+    readonly publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiPublishCommissionSettlements
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
+ * @export
+ * @interface CommissionSettlementsApiUpdateCommissionSettlementRequest
+ */
+export interface CommissionSettlementsApiUpdateCommissionSettlementRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionSettlementsApiUpdateCommissionSettlement
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateCommissionSettlementRequestDto}
+     * @memberof CommissionSettlementsApiUpdateCommissionSettlement
+     */
+    readonly updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionSettlementsApiUpdateCommissionSettlement
+     */
+    readonly authorization?: string;
+}
+/**
+ * CommissionSettlementsApi - object-oriented interface
+ * @export
+ * @class CommissionSettlementsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionSettlementsApi extends BaseAPI {
+    /**
+     * This will create commission settlement.
+     * @summary Create the commission settlement
+     * @param {CommissionSettlementsApiCreateCommissionSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    createCommissionSettlement(requestParameters: CommissionSettlementsApiCreateCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionSettlementResponseClass, any, {}>>;
+    /**
+     * This will delete commission settlement.
+     * @summary Delete the commission settlement
+     * @param {CommissionSettlementsApiDeleteCommissionSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    deleteCommissionSettlement(requestParameters: CommissionSettlementsApiDeleteCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get commission settlement.
+     * @summary Retrieve the commission settlement
+     * @param {CommissionSettlementsApiGetCommissionSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    getCommissionSettlement(requestParameters: CommissionSettlementsApiGetCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionSettlementResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of commission settlements.
+     * @summary List commission settlements
+     * @param {CommissionSettlementsApiListCommissionSettlementsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    listCommissionSettlements(requestParameters?: CommissionSettlementsApiListCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionSettlementsResponseClass, any, {}>>;
+    /**
+     * This will publish multiple commission settlements.
+     * @summary Create the commission settlement publish
+     * @param {CommissionSettlementsApiPublishCommissionSettlementsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    publishCommissionSettlements(requestParameters: CommissionSettlementsApiPublishCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublishCommissionSettlementsResponseClass, any, {}>>;
+    /**
+     * This will update commission settlement.
+     * @summary Update the commission settlement
+     * @param {CommissionSettlementsApiUpdateCommissionSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionSettlementsApi
+     */
+    updateCommissionSettlement(requestParameters: CommissionSettlementsApiUpdateCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionSettlementResponseClass, any, {}>>;
+}