@emilgroup/commission-sdk 1.0.0-beta.14 → 1.0.0-beta.16

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.
@@ -16,6 +16,8 @@ configuration.ts
16
16
  git_push.sh
17
17
  index.ts
18
18
  models/commission-agreement-class.ts
19
+ models/commission-agreement-metadata-dto.ts
20
+ models/commission-agreement-metadata-partner-dto.ts
19
21
  models/commission-agreement-product-class.ts
20
22
  models/commission-agreement-rule-class.ts
21
23
  models/commission-agreement-rule-config-dto.ts
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@1.0.0-beta.14 --save
20
+ npm install @emilgroup/commission-sdk@1.0.0-beta.16 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk@1.0.0-beta.14
24
+ yarn add @emilgroup/commission-sdk@1.0.0-beta.16
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -188,11 +188,11 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
189
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
190
  * @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.
191
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
191
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
192
192
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
193
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
194
194
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
195
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
195
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
@@ -358,11 +358,11 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
358
358
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
359
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
360
360
  * @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.
361
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
361
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
362
362
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
363
363
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
364
364
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
365
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
365
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
366
366
  * @param {*} [options] Override http request option.
367
367
  * @throws {RequiredError}
368
368
  */
@@ -432,11 +432,11 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
432
432
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
433
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
434
  * @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.
435
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
435
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
436
436
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
437
437
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
438
438
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
439
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
439
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
440
440
  * @param {*} [options] Override http request option.
441
441
  * @throws {RequiredError}
442
442
  */
@@ -555,7 +555,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
555
555
  readonly pageToken?: string
556
556
 
557
557
  /**
558
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
558
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
559
559
  * @type {string}
560
560
  * @memberof CommissionAgreementsApiListCommissionAgreements
561
561
  */
@@ -583,7 +583,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
583
583
  readonly expand?: string
584
584
 
585
585
  /**
586
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
586
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, mainPartnerCode</i>
587
587
  * @type {string}
588
588
  * @memberof CommissionAgreementsApiListCommissionAgreements
589
589
  */
@@ -191,12 +191,12 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
191
191
  * @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.
192
192
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
193
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
194
- * @param {'items'} [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.
194
+ * @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.
195
195
  * @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.
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
199
- 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', expand?: 'items', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ 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', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
200
  const localVarPath = `/commissionservice/v1/commissions`;
201
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -365,12 +365,12 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
365
365
  * @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.
366
366
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
367
367
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
368
- * @param {'items'} [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.
368
+ * @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.
369
369
  * @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.
370
370
  * @param {*} [options] Override http request option.
371
371
  * @throws {RequiredError}
372
372
  */
373
- 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', expand?: 'items', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
373
+ 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', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
374
374
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
376
  },
@@ -440,12 +440,12 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
440
440
  * @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.
441
441
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
442
442
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
443
- * @param {'items'} [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.
443
+ * @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.
444
444
  * @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.
445
445
  * @param {*} [options] Override http request option.
446
446
  * @throws {RequiredError}
447
447
  */
448
- 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', expand?: 'items', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
448
+ 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', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
449
449
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
450
450
  },
451
451
  /**
@@ -583,10 +583,10 @@ export interface CommissionsApiListCommissionsRequest {
583
583
 
584
584
  /**
585
585
  * 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.
586
- * @type {'items'}
586
+ * @type {'items' | 'agreement'}
587
587
  * @memberof CommissionsApiListCommissions
588
588
  */
589
- readonly expand?: 'items'
589
+ readonly expand?: 'items' | 'agreement'
590
590
 
591
591
  /**
592
592
  * 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.
@@ -57,11 +57,11 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
57
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
59
  * @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.
60
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
60
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
61
61
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
62
62
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
63
63
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
64
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
64
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  */
@@ -115,11 +115,11 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
115
115
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
116
116
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
117
117
  * @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.
118
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
118
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
119
119
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
120
120
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
121
121
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
122
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
122
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
123
123
  * @param {*} [options] Override http request option.
124
124
  * @throws {RequiredError}
125
125
  */
@@ -173,11 +173,11 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
173
173
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
174
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
175
  * @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.
176
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
176
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
177
177
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
178
178
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
179
179
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
180
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
180
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
181
181
  * @param {*} [options] Override http request option.
182
182
  * @throws {RequiredError}
183
183
  */
@@ -280,7 +280,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
280
280
  */
281
281
  readonly pageToken?: string;
282
282
  /**
283
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
283
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
284
284
  * @type {string}
285
285
  * @memberof CommissionAgreementsApiListCommissionAgreements
286
286
  */
@@ -304,7 +304,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
304
304
  */
305
305
  readonly expand?: string;
306
306
  /**
307
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
307
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
308
308
  * @type {string}
309
309
  * @memberof CommissionAgreementsApiListCommissionAgreements
310
310
  */
@@ -249,11 +249,11 @@ var CommissionAgreementsApiAxiosParamCreator = 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 {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
252
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
254
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
255
255
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
256
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
256
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
257
257
  * @param {*} [options] Override http request option.
258
258
  * @throws {RequiredError}
259
259
  */
@@ -444,11 +444,11 @@ var CommissionAgreementsApiFp = function (configuration) {
444
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
445
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
446
  * @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.
447
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
447
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
448
448
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
449
449
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
450
450
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
451
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
451
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
452
452
  * @param {*} [options] Override http request option.
453
453
  * @throws {RequiredError}
454
454
  */
@@ -536,11 +536,11 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
536
536
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
537
537
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
538
538
  * @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.
539
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
539
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
540
540
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
541
541
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
542
542
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
543
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
543
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt, mainPartnerCode&lt;/i&gt;
544
544
  * @param {*} [options] Override http request option.
545
545
  * @throws {RequiredError}
546
546
  */
@@ -60,12 +60,12 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
60
60
  * @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.
61
61
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
62
62
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
63
- * @param {'items'} [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.
63
+ * @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.
64
64
  * @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.
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  */
68
- 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', expand?: 'items', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ 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', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
69
  /**
70
70
  * This will update commission.
71
71
  * @summary Update the commission
@@ -119,12 +119,12 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
119
119
  * @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.
120
120
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
121
121
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
122
- * @param {'items'} [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.
122
+ * @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.
123
123
  * @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.
124
124
  * @param {*} [options] Override http request option.
125
125
  * @throws {RequiredError}
126
126
  */
127
- 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', expand?: 'items', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
127
+ 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', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
128
128
  /**
129
129
  * This will update commission.
130
130
  * @summary Update the commission
@@ -178,12 +178,12 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
178
178
  * @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.
179
179
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
180
180
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
181
- * @param {'items'} [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.
181
+ * @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.
182
182
  * @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.
183
183
  * @param {*} [options] Override http request option.
184
184
  * @throws {RequiredError}
185
185
  */
186
- 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', expand?: 'items', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
186
+ 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', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
187
187
  /**
188
188
  * This will update commission.
189
189
  * @summary Update the commission
@@ -302,10 +302,10 @@ export interface CommissionsApiListCommissionsRequest {
302
302
  readonly order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status';
303
303
  /**
304
304
  * 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.
305
- * @type {'items'}
305
+ * @type {'items' | 'agreement'}
306
306
  * @memberof CommissionsApiListCommissions
307
307
  */
308
- readonly expand?: 'items';
308
+ readonly expand?: 'items' | 'agreement';
309
309
  /**
310
310
  * 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.
311
311
  * @type {string}
@@ -252,7 +252,7 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
252
252
  * @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.
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
254
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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
- * @param {'items'} [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.
255
+ * @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.
256
256
  * @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.
257
257
  * @param {*} [options] Override http request option.
258
258
  * @throws {RequiredError}
@@ -451,7 +451,7 @@ var CommissionsApiFp = function (configuration) {
451
451
  * @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.
452
452
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
453
453
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
454
- * @param {'items'} [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.
454
+ * @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.
455
455
  * @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.
456
456
  * @param {*} [options] Override http request option.
457
457
  * @throws {RequiredError}
@@ -544,7 +544,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
544
544
  * @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.
545
545
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
546
546
  * @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status'} [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.
547
- * @param {'items'} [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.
547
+ * @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.
548
548
  * @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.
549
549
  * @param {*} [options] Override http request option.
550
550
  * @throws {RequiredError}
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
12
13
  import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
13
14
  /**
14
15
  *
@@ -58,6 +59,12 @@ export interface CommissionAgreementClass {
58
59
  * @memberof CommissionAgreementClass
59
60
  */
60
61
  'billingFrequency'?: CommissionAgreementClassBillingFrequencyEnum;
62
+ /**
63
+ * Metadata associated with the commission agreement
64
+ * @type {CommissionAgreementMetadataDto}
65
+ * @memberof CommissionAgreementClass
66
+ */
67
+ 'metadata'?: CommissionAgreementMetadataDto;
61
68
  /**
62
69
  * Timestamp when the commission agreement was created
63
70
  * @type {string}
@@ -0,0 +1,25 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CommissionAgreementMetadataPartnerDto } from './commission-agreement-metadata-partner-dto';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface CommissionAgreementMetadataDto
17
+ */
18
+ export interface CommissionAgreementMetadataDto {
19
+ /**
20
+ * Main partner of the commission agreement
21
+ * @type {CommissionAgreementMetadataPartnerDto}
22
+ * @memberof CommissionAgreementMetadataDto
23
+ */
24
+ 'mainPartner'?: CommissionAgreementMetadataPartnerDto;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL CommissionService
6
+ * The EMIL CommissionService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,30 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CommissionAgreementMetadataPartnerDto
16
+ */
17
+ export interface CommissionAgreementMetadataPartnerDto {
18
+ /**
19
+ * Code of the partner
20
+ * @type {string}
21
+ * @memberof CommissionAgreementMetadataPartnerDto
22
+ */
23
+ 'code': string;
24
+ /**
25
+ * Name of the partner
26
+ * @type {string}
27
+ * @memberof CommissionAgreementMetadataPartnerDto
28
+ */
29
+ 'name': string;
30
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL CommissionService
6
+ * The EMIL CommissionService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { CommissionAgreementClass } from './commission-agreement-class';
12
13
  import { CommissionItemClass } from './commission-item-class';
13
14
  /**
14
15
  *
@@ -23,11 +24,11 @@ export interface CommissionClass {
23
24
  */
24
25
  'id': number;
25
26
  /**
26
- * The unique code or identifier of the commission agreement this commission is based on
27
- * @type {string}
27
+ * The commission agreement this commission is based on
28
+ * @type {CommissionAgreementClass}
28
29
  * @memberof CommissionClass
29
30
  */
30
- 'commissionAgreementCode': string;
31
+ 'agreement': CommissionAgreementClass;
31
32
  /**
32
33
  * Unique identifier for the object.
33
34
  * @type {string}
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -39,6 +40,12 @@ export interface CreateCommissionAgreementRequestDto {
39
40
  * @memberof CreateCommissionAgreementRequestDto
40
41
  */
41
42
  'productSlugs': Array<string>;
43
+ /**
44
+ * Metadata associated with the commission agreement
45
+ * @type {CommissionAgreementMetadataDto}
46
+ * @memberof CreateCommissionAgreementRequestDto
47
+ */
48
+ 'metadata': CommissionAgreementMetadataDto;
42
49
  /**
43
50
  * Detailed description of the commission agreement terms and conditions
44
51
  * @type {string}
@@ -1,4 +1,6 @@
1
1
  export * from './commission-agreement-class';
2
+ export * from './commission-agreement-metadata-dto';
3
+ export * from './commission-agreement-metadata-partner-dto';
2
4
  export * from './commission-agreement-product-class';
3
5
  export * from './commission-agreement-rule-class';
4
6
  export * from './commission-agreement-rule-config-dto';
@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./commission-agreement-class"), exports);
18
+ __exportStar(require("./commission-agreement-metadata-dto"), exports);
19
+ __exportStar(require("./commission-agreement-metadata-partner-dto"), exports);
18
20
  __exportStar(require("./commission-agreement-product-class"), exports);
19
21
  __exportStar(require("./commission-agreement-rule-class"), exports);
20
22
  __exportStar(require("./commission-agreement-rule-config-dto"), exports);
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
16
17
  import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
17
18
 
18
19
  /**
@@ -63,6 +64,12 @@ export interface CommissionAgreementClass {
63
64
  * @memberof CommissionAgreementClass
64
65
  */
65
66
  'billingFrequency'?: CommissionAgreementClassBillingFrequencyEnum;
67
+ /**
68
+ * Metadata associated with the commission agreement
69
+ * @type {CommissionAgreementMetadataDto}
70
+ * @memberof CommissionAgreementClass
71
+ */
72
+ 'metadata'?: CommissionAgreementMetadataDto;
66
73
  /**
67
74
  * Timestamp when the commission agreement was created
68
75
  * @type {string}
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CommissionAgreementMetadataPartnerDto } from './commission-agreement-metadata-partner-dto';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface CommissionAgreementMetadataDto
22
+ */
23
+ export interface CommissionAgreementMetadataDto {
24
+ /**
25
+ * Main partner of the commission agreement
26
+ * @type {CommissionAgreementMetadataPartnerDto}
27
+ * @memberof CommissionAgreementMetadataDto
28
+ */
29
+ 'mainPartner'?: CommissionAgreementMetadataPartnerDto;
30
+ }
31
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionAgreementMetadataPartnerDto
21
+ */
22
+ export interface CommissionAgreementMetadataPartnerDto {
23
+ /**
24
+ * Code of the partner
25
+ * @type {string}
26
+ * @memberof CommissionAgreementMetadataPartnerDto
27
+ */
28
+ 'code': string;
29
+ /**
30
+ * Name of the partner
31
+ * @type {string}
32
+ * @memberof CommissionAgreementMetadataPartnerDto
33
+ */
34
+ 'name': string;
35
+ }
36
+
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { CommissionAgreementClass } from './commission-agreement-class';
16
17
  import { CommissionItemClass } from './commission-item-class';
17
18
 
18
19
  /**
@@ -28,11 +29,11 @@ export interface CommissionClass {
28
29
  */
29
30
  'id': number;
30
31
  /**
31
- * The unique code or identifier of the commission agreement this commission is based on
32
- * @type {string}
32
+ * The commission agreement this commission is based on
33
+ * @type {CommissionAgreementClass}
33
34
  * @memberof CommissionClass
34
35
  */
35
- 'commissionAgreementCode': string;
36
+ 'agreement': CommissionAgreementClass;
36
37
  /**
37
38
  * Unique identifier for the object.
38
39
  * @type {string}
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
16
17
 
17
18
  /**
18
19
  *
@@ -44,6 +45,12 @@ export interface CreateCommissionAgreementRequestDto {
44
45
  * @memberof CreateCommissionAgreementRequestDto
45
46
  */
46
47
  'productSlugs': Array<string>;
48
+ /**
49
+ * Metadata associated with the commission agreement
50
+ * @type {CommissionAgreementMetadataDto}
51
+ * @memberof CreateCommissionAgreementRequestDto
52
+ */
53
+ 'metadata': CommissionAgreementMetadataDto;
47
54
  /**
48
55
  * Detailed description of the commission agreement terms and conditions
49
56
  * @type {string}
package/models/index.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  export * from './commission-agreement-class';
2
+ export * from './commission-agreement-metadata-dto';
3
+ export * from './commission-agreement-metadata-partner-dto';
2
4
  export * from './commission-agreement-product-class';
3
5
  export * from './commission-agreement-rule-class';
4
6
  export * from './commission-agreement-rule-config-dto';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/commission-sdk",
3
- "version": "1.0.0-beta.14",
3
+ "version": "1.0.0-beta.16",
4
4
  "description": "OpenAPI client for @emilgroup/commission-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [