@emilgroup/commission-sdk-node 1.0.0-beta.15 → 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.
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-node@1.0.0-beta.15 --save
20
+ npm install @emilgroup/commission-sdk-node@1.0.0-beta.16 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@1.0.0-beta.15
24
+ yarn add @emilgroup/commission-sdk-node@1.0.0-beta.16
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -195,12 +195,12 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
195
195
  * @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.
196
196
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
197
197
  * @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.
198
- * @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.
198
+ * @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.
199
199
  * @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.
200
200
  * @param {*} [options] Override http request option.
201
201
  * @throws {RequiredError}
202
202
  */
203
- 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> => {
203
+ 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> => {
204
204
  const localVarPath = `/commissionservice/v1/commissions`;
205
205
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
206
206
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -369,12 +369,12 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
369
369
  * @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.
370
370
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
371
371
  * @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.
372
- * @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.
372
+ * @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.
373
373
  * @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.
374
374
  * @param {*} [options] Override http request option.
375
375
  * @throws {RequiredError}
376
376
  */
377
- 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>> {
377
+ 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>> {
378
378
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
379
379
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
380
380
  },
@@ -444,12 +444,12 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
444
444
  * @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.
445
445
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
446
446
  * @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.
447
- * @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.
447
+ * @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.
448
448
  * @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.
449
449
  * @param {*} [options] Override http request option.
450
450
  * @throws {RequiredError}
451
451
  */
452
- 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> {
452
+ 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> {
453
453
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
454
454
  },
455
455
  /**
@@ -587,10 +587,10 @@ export interface CommissionsApiListCommissionsRequest {
587
587
 
588
588
  /**
589
589
  * 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.
590
- * @type {'items'}
590
+ * @type {'items' | 'agreement'}
591
591
  * @memberof CommissionsApiListCommissions
592
592
  */
593
- readonly expand?: 'items'
593
+ readonly expand?: 'items' | 'agreement'
594
594
 
595
595
  /**
596
596
  * 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.
@@ -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}
@@ -256,7 +256,7 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
256
256
  * @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.
257
257
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
258
258
  * @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.
259
- * @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.
259
+ * @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.
260
260
  * @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.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
@@ -455,7 +455,7 @@ var CommissionsApiFp = function (configuration) {
455
455
  * @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.
456
456
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
457
457
  * @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.
458
- * @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.
458
+ * @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.
459
459
  * @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.
460
460
  * @param {*} [options] Override http request option.
461
461
  * @throws {RequiredError}
@@ -548,7 +548,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
548
548
  * @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.
549
549
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
550
550
  * @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.
551
- * @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.
551
+ * @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.
552
552
  * @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.
553
553
  * @param {*} [options] Override http request option.
554
554
  * @throws {RequiredError}
@@ -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}
@@ -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}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/commission-sdk-node",
3
- "version": "1.0.0-beta.15",
3
+ "version": "1.0.0-beta.16",
4
4
  "description": "OpenAPI client for @emilgroup/commission-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [