@emilgroup/commission-sdk-node 2.9.1-beta.8 → 2.9.1-beta.80

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.
Files changed (80) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +4 -4
  4. package/api/commission-agreement-rules-api.ts +20 -6
  5. package/api/commission-settlements-api.ts +8 -8
  6. package/api/commissions-api.ts +376 -0
  7. package/dist/api/commission-agreement-products-api.d.ts +4 -4
  8. package/dist/api/commission-agreement-products-api.js +3 -3
  9. package/dist/api/commission-agreement-rules-api.d.ts +12 -3
  10. package/dist/api/commission-agreement-rules-api.js +12 -6
  11. package/dist/api/commission-settlements-api.d.ts +8 -8
  12. package/dist/api/commission-settlements-api.js +3 -3
  13. package/dist/api/commissions-api.d.ts +220 -0
  14. package/dist/api/commissions-api.js +258 -0
  15. package/dist/models/clawback-config-class.d.ts +6 -0
  16. package/dist/models/clawback-config-dto.d.ts +6 -0
  17. package/dist/models/commission-agreement-class.d.ts +2 -2
  18. package/dist/models/commission-agreement-class.js +1 -1
  19. package/dist/models/commission-agreement-version-class.d.ts +4 -4
  20. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  21. package/dist/models/commission-agreement-version-config-class.js +15 -0
  22. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  23. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  24. package/dist/models/commission-class.d.ts +13 -6
  25. package/dist/models/commission-class.js +2 -1
  26. package/dist/models/commission-creation-config-class.d.ts +43 -0
  27. package/dist/models/commission-creation-config-class.js +20 -0
  28. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  29. package/dist/models/commission-creation-config-dto.js +20 -0
  30. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  31. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  32. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  33. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  34. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  35. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  36. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  37. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  38. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  39. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  40. package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
  41. package/dist/models/create-commission-agreement-request-dto.js +1 -1
  42. package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
  43. package/dist/models/index.d.ts +12 -0
  44. package/dist/models/index.js +12 -0
  45. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  46. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  47. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  48. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  49. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  50. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  51. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  52. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  53. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +1 -1
  54. package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
  55. package/dist/models/update-commission-agreement-request-dto.js +1 -1
  56. package/models/clawback-config-class.ts +6 -0
  57. package/models/clawback-config-dto.ts +6 -0
  58. package/models/commission-agreement-class.ts +2 -2
  59. package/models/commission-agreement-version-class.ts +4 -4
  60. package/models/commission-agreement-version-config-class.ts +38 -0
  61. package/models/commission-agreement-version-config-dto.ts +38 -0
  62. package/models/commission-class.ts +14 -7
  63. package/models/commission-creation-config-class.ts +52 -0
  64. package/models/commission-creation-config-dto.ts +52 -0
  65. package/models/commission-creation-invoice-config-class.ts +30 -0
  66. package/models/commission-creation-invoice-config-dto.ts +30 -0
  67. package/models/commission-creation-renewal-config-class.ts +38 -0
  68. package/models/commission-creation-renewal-config-dto.ts +38 -0
  69. package/models/commission-paid-invoice-entry-class.ts +124 -0
  70. package/models/create-commission-agreement-request-dto.ts +5 -5
  71. package/models/create-commission-agreement-version-request-dto.ts +4 -4
  72. package/models/index.ts +12 -0
  73. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  74. package/models/list-commission-agreements-response-class.ts +10 -10
  75. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  76. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  77. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  78. package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
  79. package/models/update-commission-agreement-request-dto.ts +2 -2
  80. package/package.json +1 -1
@@ -35,8 +35,12 @@ import { EstimateCommissionsResponseClass } from '../models';
35
35
  // @ts-ignore
36
36
  import { GetCommissionResponseClass } from '../models';
37
37
  // @ts-ignore
38
+ import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
39
+ // @ts-ignore
38
40
  import { ListCommissionsResponseClass } from '../models';
39
41
  // @ts-ignore
42
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
43
+ // @ts-ignore
40
44
  import { TriggerDueCommissionClawbacksRequestDto } from '../models';
41
45
  // @ts-ignore
42
46
  import { TriggerDueCommissionClawbacksResponseClass } from '../models';
@@ -287,6 +291,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
287
291
 
288
292
 
289
293
 
294
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
295
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
296
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
297
+
298
+ return {
299
+ url: toPathString(localVarUrlObj),
300
+ options: localVarRequestOptions,
301
+ };
302
+ },
303
+ /**
304
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
305
+ * @summary List commission paid invoice entries
306
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
307
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
308
+ * @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.
309
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
310
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
311
+ * @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: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
312
+ * @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/>
313
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
314
+ * @param {*} [options] Override http request option.
315
+ * @throws {RequiredError}
316
+ */
317
+ listCommissionPaidInvoiceEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
318
+ const localVarPath = `/commissionservice/v1/commissions/paid-invoice-entries`;
319
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
320
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
321
+ let baseOptions;
322
+ let baseAccessToken;
323
+ if (configuration) {
324
+ baseOptions = configuration.baseOptions;
325
+ baseAccessToken = configuration.accessToken;
326
+ }
327
+
328
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
329
+ const localVarHeaderParameter = {} as any;
330
+ const localVarQueryParameter = {} as any;
331
+
332
+ // authentication bearer required
333
+ // http bearer authentication required
334
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
335
+
336
+ if (pageSize !== undefined) {
337
+ localVarQueryParameter['pageSize'] = pageSize;
338
+ }
339
+
340
+ if (pageToken !== undefined) {
341
+ localVarQueryParameter['pageToken'] = pageToken;
342
+ }
343
+
344
+ if (filter !== undefined) {
345
+ localVarQueryParameter['filter'] = filter;
346
+ }
347
+
348
+ if (search !== undefined) {
349
+ localVarQueryParameter['search'] = search;
350
+ }
351
+
352
+ if (order !== undefined) {
353
+ localVarQueryParameter['order'] = order;
354
+ }
355
+
356
+ if (expand !== undefined) {
357
+ localVarQueryParameter['expand'] = expand;
358
+ }
359
+
360
+ if (filters !== undefined) {
361
+ localVarQueryParameter['filters'] = filters;
362
+ }
363
+
364
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
365
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
366
+ }
367
+
368
+
369
+
290
370
  setSearchParams(localVarUrlObj, localVarQueryParameter);
291
371
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
292
372
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -363,6 +443,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
363
443
 
364
444
 
365
445
 
446
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
447
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
448
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
449
+
450
+ return {
451
+ url: toPathString(localVarUrlObj),
452
+ options: localVarRequestOptions,
453
+ };
454
+ },
455
+ /**
456
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
457
+ * @summary List scheduled commission clawback triggers
458
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
459
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
460
+ * @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.
461
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
462
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
463
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
464
+ * @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;
465
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
466
+ * @param {*} [options] Override http request option.
467
+ * @throws {RequiredError}
468
+ */
469
+ listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
470
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
471
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
472
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
473
+ let baseOptions;
474
+ let baseAccessToken;
475
+ if (configuration) {
476
+ baseOptions = configuration.baseOptions;
477
+ baseAccessToken = configuration.accessToken;
478
+ }
479
+
480
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
481
+ const localVarHeaderParameter = {} as any;
482
+ const localVarQueryParameter = {} as any;
483
+
484
+ // authentication bearer required
485
+ // http bearer authentication required
486
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
487
+
488
+ if (pageSize !== undefined) {
489
+ localVarQueryParameter['pageSize'] = pageSize;
490
+ }
491
+
492
+ if (pageToken !== undefined) {
493
+ localVarQueryParameter['pageToken'] = pageToken;
494
+ }
495
+
496
+ if (filter !== undefined) {
497
+ localVarQueryParameter['filter'] = filter;
498
+ }
499
+
500
+ if (search !== undefined) {
501
+ localVarQueryParameter['search'] = search;
502
+ }
503
+
504
+ if (order !== undefined) {
505
+ localVarQueryParameter['order'] = order;
506
+ }
507
+
508
+ if (expand !== undefined) {
509
+ localVarQueryParameter['expand'] = expand;
510
+ }
511
+
512
+ if (filters !== undefined) {
513
+ localVarQueryParameter['filters'] = filters;
514
+ }
515
+
516
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
517
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
518
+ }
519
+
520
+
521
+
366
522
  setSearchParams(localVarUrlObj, localVarQueryParameter);
367
523
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
368
524
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -542,6 +698,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
542
698
  const localVarAxiosArgs = await localVarAxiosParamCreator.getCommission(code, expand, authorization, options);
543
699
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
544
700
  },
701
+ /**
702
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
703
+ * @summary List commission paid invoice entries
704
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
705
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
706
+ * @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.
707
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
708
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
709
+ * @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: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
710
+ * @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;
711
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
712
+ * @param {*} [options] Override http request option.
713
+ * @throws {RequiredError}
714
+ */
715
+ async listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>> {
716
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
717
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
718
+ },
545
719
  /**
546
720
  * Retrieves a list of commissions.
547
721
  * @summary List commissions
@@ -560,6 +734,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
560
734
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
561
735
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
562
736
  },
737
+ /**
738
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
739
+ * @summary List scheduled commission clawback triggers
740
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
741
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
742
+ * @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.
743
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
744
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
745
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
746
+ * @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;
747
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
748
+ * @param {*} [options] Override http request option.
749
+ * @throws {RequiredError}
750
+ */
751
+ async listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>> {
752
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
753
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
754
+ },
563
755
  /**
564
756
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
565
757
  * @summary Create the due commission clawbacks trigger
@@ -652,6 +844,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
652
844
  getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass> {
653
845
  return localVarFp.getCommission(code, expand, authorization, options).then((request) => request(axios, basePath));
654
846
  },
847
+ /**
848
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
849
+ * @summary List commission paid invoice entries
850
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
851
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
852
+ * @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.
853
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
854
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
855
+ * @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: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
856
+ * @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;
857
+ * @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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
858
+ * @param {*} [options] Override http request option.
859
+ * @throws {RequiredError}
860
+ */
861
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass> {
862
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
863
+ },
655
864
  /**
656
865
  * Retrieves a list of commissions.
657
866
  * @summary List commissions
@@ -669,6 +878,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
669
878
  listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
670
879
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
671
880
  },
881
+ /**
882
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
883
+ * @summary List scheduled commission clawback triggers
884
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
885
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
886
+ * @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.
887
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
888
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
889
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
890
+ * @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;
891
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
892
+ * @param {*} [options] Override http request option.
893
+ * @throws {RequiredError}
894
+ */
895
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
896
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
897
+ },
672
898
  /**
673
899
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
674
900
  * @summary Create the due commission clawbacks trigger
@@ -814,6 +1040,69 @@ export interface CommissionsApiGetCommissionRequest {
814
1040
  readonly authorization?: string
815
1041
  }
816
1042
 
1043
+ /**
1044
+ * Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
1045
+ * @export
1046
+ * @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
1047
+ */
1048
+ export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
1049
+ /**
1050
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1051
+ * @type {string}
1052
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1053
+ */
1054
+ readonly authorization?: string
1055
+
1056
+ /**
1057
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1058
+ * @type {number}
1059
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1060
+ */
1061
+ readonly pageSize?: number
1062
+
1063
+ /**
1064
+ * 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.
1065
+ * @type {string}
1066
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1067
+ */
1068
+ readonly pageToken?: string
1069
+
1070
+ /**
1071
+ * 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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1072
+ * @type {string}
1073
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1074
+ */
1075
+ readonly filter?: string
1076
+
1077
+ /**
1078
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1079
+ * @type {string}
1080
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1081
+ */
1082
+ readonly search?: string
1083
+
1084
+ /**
1085
+ * 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: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
1086
+ * @type {string}
1087
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1088
+ */
1089
+ readonly order?: string
1090
+
1091
+ /**
1092
+ * 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;
1093
+ * @type {string}
1094
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1095
+ */
1096
+ readonly expand?: string
1097
+
1098
+ /**
1099
+ * 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, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1100
+ * @type {string}
1101
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1102
+ */
1103
+ readonly filters?: string
1104
+ }
1105
+
817
1106
  /**
818
1107
  * Request parameters for listCommissions operation in CommissionsApi.
819
1108
  * @export
@@ -877,6 +1166,69 @@ export interface CommissionsApiListCommissionsRequest {
877
1166
  readonly filters?: string
878
1167
  }
879
1168
 
1169
+ /**
1170
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
1171
+ * @export
1172
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
1173
+ */
1174
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
1175
+ /**
1176
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1177
+ * @type {string}
1178
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1179
+ */
1180
+ readonly authorization?: string
1181
+
1182
+ /**
1183
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1184
+ * @type {number}
1185
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1186
+ */
1187
+ readonly pageSize?: number
1188
+
1189
+ /**
1190
+ * 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.
1191
+ * @type {string}
1192
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1193
+ */
1194
+ readonly pageToken?: string
1195
+
1196
+ /**
1197
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1198
+ * @type {string}
1199
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1200
+ */
1201
+ readonly filter?: string
1202
+
1203
+ /**
1204
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1205
+ * @type {string}
1206
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1207
+ */
1208
+ readonly search?: string
1209
+
1210
+ /**
1211
+ * 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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
1212
+ * @type {string}
1213
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1214
+ */
1215
+ readonly order?: string
1216
+
1217
+ /**
1218
+ * 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;
1219
+ * @type {string}
1220
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1221
+ */
1222
+ readonly expand?: string
1223
+
1224
+ /**
1225
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1226
+ * @type {string}
1227
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1228
+ */
1229
+ readonly filters?: string
1230
+ }
1231
+
880
1232
  /**
881
1233
  * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
882
1234
  * @export
@@ -993,6 +1345,18 @@ export class CommissionsApi extends BaseAPI {
993
1345
  return CommissionsApiFp(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
994
1346
  }
995
1347
 
1348
+ /**
1349
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1350
+ * @summary List commission paid invoice entries
1351
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1352
+ * @param {*} [options] Override http request option.
1353
+ * @throws {RequiredError}
1354
+ * @memberof CommissionsApi
1355
+ */
1356
+ public listCommissionPaidInvoiceEntries(requestParameters: CommissionsApiListCommissionPaidInvoiceEntriesRequest = {}, options?: AxiosRequestConfig) {
1357
+ return CommissionsApiFp(this.configuration).listCommissionPaidInvoiceEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1358
+ }
1359
+
996
1360
  /**
997
1361
  * Retrieves a list of commissions.
998
1362
  * @summary List commissions
@@ -1005,6 +1369,18 @@ export class CommissionsApi extends BaseAPI {
1005
1369
  return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1006
1370
  }
1007
1371
 
1372
+ /**
1373
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1374
+ * @summary List scheduled commission clawback triggers
1375
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1376
+ * @param {*} [options] Override http request option.
1377
+ * @throws {RequiredError}
1378
+ * @memberof CommissionsApi
1379
+ */
1380
+ public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
1381
+ return CommissionsApiFp(this.configuration).listScheduledCommissionClawbackTriggers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1382
+ }
1383
+
1008
1384
  /**
1009
1385
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
1010
1386
  * @summary Create the due commission clawbacks trigger
@@ -59,7 +59,7 @@ export declare const CommissionAgreementProductsApiAxiosParamCreator: (configura
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
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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
61
61
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
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, updatedAt, productSlug, status&lt;/i&gt;
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, updatedAt, productSlug, status, id&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: version&lt;i&gt;
64
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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
65
65
  * @param {*} [options] Override http request option.
@@ -118,7 +118,7 @@ export declare const CommissionAgreementProductsApiFp: (configuration?: Configur
118
118
  * @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.
119
119
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
120
120
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
121
- * @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, updatedAt, productSlug, status&lt;/i&gt;
121
+ * @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, updatedAt, productSlug, status, id&lt;/i&gt;
122
122
  * @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: version&lt;i&gt;
123
123
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
124
124
  * @param {*} [options] Override http request option.
@@ -177,7 +177,7 @@ export declare const CommissionAgreementProductsApiFactory: (configuration?: Con
177
177
  * @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.
178
178
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
179
179
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
180
- * @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, updatedAt, productSlug, status&lt;/i&gt;
180
+ * @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, updatedAt, productSlug, status, id&lt;/i&gt;
181
181
  * @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: version&lt;i&gt;
182
182
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
183
183
  * @param {*} [options] Override http request option.
@@ -295,7 +295,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
295
295
  */
296
296
  readonly search?: string;
297
297
  /**
298
- * 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, updatedAt, productSlug, status&lt;/i&gt;
298
+ * 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, updatedAt, productSlug, status, id&lt;/i&gt;
299
299
  * @type {string}
300
300
  * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
301
301
  */
@@ -255,7 +255,7 @@ var CommissionAgreementProductsApiAxiosParamCreator = function (configuration) {
255
255
  * @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.
256
256
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
257
257
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
258
- * @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, updatedAt, productSlug, status&lt;/i&gt;
258
+ * @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, updatedAt, productSlug, status, id&lt;/i&gt;
259
259
  * @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: version&lt;i&gt;
260
260
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
261
261
  * @param {*} [options] Override http request option.
@@ -454,7 +454,7 @@ var CommissionAgreementProductsApiFp = function (configuration) {
454
454
  * @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.
455
455
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
456
456
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
457
- * @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, updatedAt, productSlug, status&lt;/i&gt;
457
+ * @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, updatedAt, productSlug, status, id&lt;/i&gt;
458
458
  * @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: version&lt;i&gt;
459
459
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
460
460
  * @param {*} [options] Override http request option.
@@ -547,7 +547,7 @@ var CommissionAgreementProductsApiFactory = function (configuration, basePath, a
547
547
  * @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.
548
548
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
549
549
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, productSlug&lt;/i&gt;
550
- * @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, updatedAt, productSlug, status&lt;/i&gt;
550
+ * @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, updatedAt, productSlug, status, id&lt;/i&gt;
551
551
  * @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: version&lt;i&gt;
552
552
  * @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, commissionAgreementVersionId, productSlug, status, createdAt&lt;/i&gt;
553
553
  * @param {*} [options] Override http request option.
@@ -67,10 +67,11 @@ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuratio
67
67
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
68
68
  * @summary Retrieve the commission agreement rule evaluation default data
69
69
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
70
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
70
71
  * @param {*} [options] Override http request option.
71
72
  * @throws {RequiredError}
72
73
  */
73
- getEvaluationDefaultData: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
+ getEvaluationDefaultData: (authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
75
  /**
75
76
  * Retrieves a list of commission agreement rules.
76
77
  * @summary List commission agreement rules
@@ -143,10 +144,11 @@ export declare const CommissionAgreementRulesApiFp: (configuration?: Configurati
143
144
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
144
145
  * @summary Retrieve the commission agreement rule evaluation default data
145
146
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
146
148
  * @param {*} [options] Override http request option.
147
149
  * @throws {RequiredError}
148
150
  */
149
- getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
151
+ getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
150
152
  /**
151
153
  * Retrieves a list of commission agreement rules.
152
154
  * @summary List commission agreement rules
@@ -219,10 +221,11 @@ export declare const CommissionAgreementRulesApiFactory: (configuration?: Config
219
221
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
220
222
  * @summary Retrieve the commission agreement rule evaluation default data
221
223
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
224
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
222
225
  * @param {*} [options] Override http request option.
223
226
  * @throws {RequiredError}
224
227
  */
225
- getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
228
+ getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
226
229
  /**
227
230
  * Retrieves a list of commission agreement rules.
228
231
  * @summary List commission agreement rules
@@ -343,6 +346,12 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
343
346
  * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
344
347
  */
345
348
  readonly authorization?: string;
349
+ /**
350
+ * Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
351
+ * @type {string}
352
+ * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
353
+ */
354
+ readonly commissionAgreementProductCode?: string;
346
355
  }
347
356
  /**
348
357
  * Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.