@emilgroup/commission-sdk 2.10.1-beta.22 → 2.10.1-beta.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/commission-sdk@2.10.1-beta.22 --save
20
+ npm install @emilgroup/commission-sdk@2.10.1-beta.24 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk@2.10.1-beta.22
24
+ yarn add @emilgroup/commission-sdk@2.10.1-beta.24
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -196,7 +196,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
197
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
198
198
  * @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.
199
- * @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.
199
+ * @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.
200
200
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
201
201
  * @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.
202
202
  * @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.
@@ -204,7 +204,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
204
204
  * @param {*} [options] Override http request option.
205
205
  * @throws {RequiredError}
206
206
  */
207
- 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> => {
207
+ 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> => {
208
208
  const localVarPath = `/commissionservice/v1/commission-settlements`;
209
209
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
210
210
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -464,7 +464,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
464
464
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
465
465
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
466
466
  * @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.
467
- * @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.
467
+ * @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.
468
468
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
469
469
  * @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.
470
470
  * @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.
@@ -472,7 +472,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
472
472
  * @param {*} [options] Override http request option.
473
473
  * @throws {RequiredError}
474
474
  */
475
- 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>> {
475
+ 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>> {
476
476
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
477
477
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
478
478
  },
@@ -563,7 +563,7 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
563
563
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
564
564
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
565
565
  * @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.
566
- * @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.
566
+ * @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.
567
567
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
568
568
  * @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.
569
569
  * @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.
@@ -571,7 +571,7 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
571
571
  * @param {*} [options] Override http request option.
572
572
  * @throws {RequiredError}
573
573
  */
574
- 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> {
574
+ 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> {
575
575
  return localVarFp.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
576
576
  },
577
577
  /**
@@ -710,10 +710,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
710
710
 
711
711
  /**
712
712
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
713
- * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
713
+ * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
714
714
  * @memberof CommissionSettlementsApiListCommissionSettlements
715
715
  */
716
- readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
716
+ readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'
717
717
 
718
718
  /**
719
719
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -61,7 +61,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
61
61
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
62
62
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
63
63
  * @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.
64
- * @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.
64
+ * @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.
65
65
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
66
66
  * @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.
67
67
  * @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.
@@ -69,7 +69,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
69
69
  * @param {*} [options] Override http request option.
70
70
  * @throws {RequiredError}
71
71
  */
72
- 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<RequestArgs>;
72
+ 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<RequestArgs>;
73
73
  /**
74
74
  * This will publish multiple commission settlements.
75
75
  * @summary Create the commission settlement publish
@@ -138,7 +138,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
138
138
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
139
139
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
140
140
  * @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.
141
- * @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.
141
+ * @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.
142
142
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
143
143
  * @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.
144
144
  * @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.
@@ -146,7 +146,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
146
146
  * @param {*} [options] Override http request option.
147
147
  * @throws {RequiredError}
148
148
  */
149
- 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>>;
149
+ 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>>;
150
150
  /**
151
151
  * This will publish multiple commission settlements.
152
152
  * @summary Create the commission settlement publish
@@ -215,7 +215,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
215
215
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
216
216
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
217
217
  * @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.
218
- * @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.
218
+ * @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.
219
219
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
220
220
  * @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.
221
221
  * @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.
@@ -223,7 +223,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
223
223
  * @param {*} [options] Override http request option.
224
224
  * @throws {RequiredError}
225
225
  */
226
- 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>;
226
+ 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>;
227
227
  /**
228
228
  * This will publish multiple commission settlements.
229
229
  * @summary Create the commission settlement publish
@@ -342,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
342
342
  readonly pageToken?: string;
343
343
  /**
344
344
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
345
- * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
345
+ * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
346
346
  * @memberof CommissionSettlementsApiListCommissionSettlements
347
347
  */
348
- readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
348
+ readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
349
349
  /**
350
350
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
351
351
  * @type {string}
@@ -249,7 +249,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
249
249
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
250
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
251
  * @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.
252
- * @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.
252
+ * @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.
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
254
  * @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.
255
255
  * @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.
@@ -546,7 +546,7 @@ var CommissionSettlementsApiFp = function (configuration) {
546
546
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
547
547
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
548
548
  * @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.
549
- * @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.
549
+ * @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.
550
550
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
551
551
  * @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.
552
552
  * @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.
@@ -681,7 +681,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
681
681
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
682
682
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
683
683
  * @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.
684
- * @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.
684
+ * @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.
685
685
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
686
686
  * @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.
687
687
  * @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.
@@ -59,6 +59,12 @@ export interface CommissionClass {
59
59
  * @memberof CommissionClass
60
60
  */
61
61
  'commissionAgreementNumber': string;
62
+ /**
63
+ * The code of the commission agreement being used for this commission, stable across all of the agreement\'s versions
64
+ * @type {string}
65
+ * @memberof CommissionClass
66
+ */
67
+ 'commissionAgreementCode': string;
62
68
  /**
63
69
  * The unique code or identifier of the partner associated with this commission
64
70
  * @type {string}
@@ -64,6 +64,12 @@ export interface CommissionClass {
64
64
  * @memberof CommissionClass
65
65
  */
66
66
  'commissionAgreementNumber': string;
67
+ /**
68
+ * The code of the commission agreement being used for this commission, stable across all of the agreement\'s versions
69
+ * @type {string}
70
+ * @memberof CommissionClass
71
+ */
72
+ 'commissionAgreementCode': string;
67
73
  /**
68
74
  * The unique code or identifier of the partner associated with this commission
69
75
  * @type {string}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/commission-sdk",
3
- "version": "2.10.1-beta.22",
3
+ "version": "2.10.1-beta.24",
4
4
  "description": "OpenAPI client for @emilgroup/commission-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [