@emilgroup/commission-sdk 2.10.1-beta.10 → 2.10.1-beta.12
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/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/commissions-api.ts +188 -0
- package/dist/api/commissions-api.d.ts +110 -0
- package/dist/api/commissions-api.js +129 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
- package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +109 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.js +27 -0
- package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +1 -1
- package/models/index.ts +2 -0
- package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
- package/models/scheduled-commission-clawback-trigger-class.ts +119 -0
- package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -81,10 +81,12 @@ models/list-commission-candidates-response-class.ts
|
|
|
81
81
|
models/list-commission-recipients-response-class.ts
|
|
82
82
|
models/list-commission-settlements-response-class.ts
|
|
83
83
|
models/list-commissions-response-class.ts
|
|
84
|
+
models/list-scheduled-commission-clawback-triggers-response-class.ts
|
|
84
85
|
models/patch-commission-agreement-status-request-dto.ts
|
|
85
86
|
models/patch-commission-agreement-status-response-class.ts
|
|
86
87
|
models/publish-commission-settlements-request-dto.ts
|
|
87
88
|
models/publish-commission-settlements-response-class.ts
|
|
89
|
+
models/scheduled-commission-clawback-trigger-class.ts
|
|
88
90
|
models/trigger-commission-settlement-creation-request-dto.ts
|
|
89
91
|
models/trigger-commission-settlement-creation-response-class.ts
|
|
90
92
|
models/trigger-due-commission-clawbacks-request-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@2.10.1-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk@2.10.1-beta.12 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk@2.10.1-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk@2.10.1-beta.12
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
package/api/commissions-api.ts
CHANGED
|
@@ -37,6 +37,8 @@ import { GetCommissionResponseClass } from '../models';
|
|
|
37
37
|
// @ts-ignore
|
|
38
38
|
import { ListCommissionsResponseClass } from '../models';
|
|
39
39
|
// @ts-ignore
|
|
40
|
+
import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
|
|
41
|
+
// @ts-ignore
|
|
40
42
|
import { TriggerDueCommissionClawbacksRequestDto } from '../models';
|
|
41
43
|
// @ts-ignore
|
|
42
44
|
import { TriggerDueCommissionClawbacksResponseClass } from '../models';
|
|
@@ -359,6 +361,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
359
361
|
|
|
360
362
|
|
|
361
363
|
|
|
364
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
365
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
366
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
367
|
+
|
|
368
|
+
return {
|
|
369
|
+
url: toPathString(localVarUrlObj),
|
|
370
|
+
options: localVarRequestOptions,
|
|
371
|
+
};
|
|
372
|
+
},
|
|
373
|
+
/**
|
|
374
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
375
|
+
* @summary List scheduled commission clawback triggers
|
|
376
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
377
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
378
|
+
* @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.
|
|
379
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
380
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
381
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
382
|
+
* @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/>
|
|
383
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
*/
|
|
387
|
+
listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
388
|
+
const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
|
|
389
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
390
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
391
|
+
let baseOptions;
|
|
392
|
+
let baseAccessToken;
|
|
393
|
+
if (configuration) {
|
|
394
|
+
baseOptions = configuration.baseOptions;
|
|
395
|
+
baseAccessToken = configuration.accessToken;
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
399
|
+
const localVarHeaderParameter = {} as any;
|
|
400
|
+
const localVarQueryParameter = {} as any;
|
|
401
|
+
|
|
402
|
+
// authentication bearer required
|
|
403
|
+
// http bearer authentication required
|
|
404
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
405
|
+
|
|
406
|
+
if (pageSize !== undefined) {
|
|
407
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
if (pageToken !== undefined) {
|
|
411
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
if (filter !== undefined) {
|
|
415
|
+
localVarQueryParameter['filter'] = filter;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
if (search !== undefined) {
|
|
419
|
+
localVarQueryParameter['search'] = search;
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
if (order !== undefined) {
|
|
423
|
+
localVarQueryParameter['order'] = order;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
if (expand !== undefined) {
|
|
427
|
+
localVarQueryParameter['expand'] = expand;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
if (filters !== undefined) {
|
|
431
|
+
localVarQueryParameter['filters'] = filters;
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
435
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
362
440
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
363
441
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
364
442
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -556,6 +634,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
556
634
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
557
635
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
558
636
|
},
|
|
637
|
+
/**
|
|
638
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
639
|
+
* @summary List scheduled commission clawback triggers
|
|
640
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
641
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
642
|
+
* @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.
|
|
643
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
644
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
645
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
646
|
+
* @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/>
|
|
647
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
648
|
+
* @param {*} [options] Override http request option.
|
|
649
|
+
* @throws {RequiredError}
|
|
650
|
+
*/
|
|
651
|
+
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>> {
|
|
652
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
653
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
654
|
+
},
|
|
559
655
|
/**
|
|
560
656
|
* 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.
|
|
561
657
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -665,6 +761,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
665
761
|
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> {
|
|
666
762
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
667
763
|
},
|
|
764
|
+
/**
|
|
765
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
766
|
+
* @summary List scheduled commission clawback triggers
|
|
767
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
768
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
769
|
+
* @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.
|
|
770
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
771
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
772
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
773
|
+
* @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/>
|
|
774
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
775
|
+
* @param {*} [options] Override http request option.
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
*/
|
|
778
|
+
listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
|
|
779
|
+
return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
780
|
+
},
|
|
668
781
|
/**
|
|
669
782
|
* 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.
|
|
670
783
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -873,6 +986,69 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
873
986
|
readonly filters?: string
|
|
874
987
|
}
|
|
875
988
|
|
|
989
|
+
/**
|
|
990
|
+
* Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
|
|
991
|
+
* @export
|
|
992
|
+
* @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
|
|
993
|
+
*/
|
|
994
|
+
export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
|
|
995
|
+
/**
|
|
996
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
997
|
+
* @type {string}
|
|
998
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
999
|
+
*/
|
|
1000
|
+
readonly authorization?: string
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1004
|
+
* @type {number}
|
|
1005
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1006
|
+
*/
|
|
1007
|
+
readonly pageSize?: number
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* 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.
|
|
1011
|
+
* @type {string}
|
|
1012
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1013
|
+
*/
|
|
1014
|
+
readonly pageToken?: string
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* 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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1018
|
+
* @type {string}
|
|
1019
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1020
|
+
*/
|
|
1021
|
+
readonly filter?: string
|
|
1022
|
+
|
|
1023
|
+
/**
|
|
1024
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1025
|
+
* @type {string}
|
|
1026
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1027
|
+
*/
|
|
1028
|
+
readonly search?: string
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* 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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
1032
|
+
* @type {string}
|
|
1033
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1034
|
+
*/
|
|
1035
|
+
readonly order?: string
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* 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/>
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1041
|
+
*/
|
|
1042
|
+
readonly expand?: string
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* 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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1046
|
+
* @type {string}
|
|
1047
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
1048
|
+
*/
|
|
1049
|
+
readonly filters?: string
|
|
1050
|
+
}
|
|
1051
|
+
|
|
876
1052
|
/**
|
|
877
1053
|
* Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
|
|
878
1054
|
* @export
|
|
@@ -1001,6 +1177,18 @@ export class CommissionsApi extends BaseAPI {
|
|
|
1001
1177
|
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));
|
|
1002
1178
|
}
|
|
1003
1179
|
|
|
1180
|
+
/**
|
|
1181
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
1182
|
+
* @summary List scheduled commission clawback triggers
|
|
1183
|
+
* @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
|
|
1184
|
+
* @param {*} [options] Override http request option.
|
|
1185
|
+
* @throws {RequiredError}
|
|
1186
|
+
* @memberof CommissionsApi
|
|
1187
|
+
*/
|
|
1188
|
+
public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
|
|
1189
|
+
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));
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1004
1192
|
/**
|
|
1005
1193
|
* 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.
|
|
1006
1194
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -20,6 +20,7 @@ import { EstimateCommissionsRequestDto } from '../models';
|
|
|
20
20
|
import { EstimateCommissionsResponseClass } from '../models';
|
|
21
21
|
import { GetCommissionResponseClass } from '../models';
|
|
22
22
|
import { ListCommissionsResponseClass } from '../models';
|
|
23
|
+
import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
|
|
23
24
|
import { TriggerDueCommissionClawbacksRequestDto } from '../models';
|
|
24
25
|
import { TriggerDueCommissionClawbacksResponseClass } from '../models';
|
|
25
26
|
import { UpdateCommissionRequestDto } from '../models';
|
|
@@ -91,6 +92,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
91
92
|
* @throws {RequiredError}
|
|
92
93
|
*/
|
|
93
94
|
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?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
|
+
/**
|
|
96
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
97
|
+
* @summary List scheduled commission clawback triggers
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
|
+
* @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.
|
|
101
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
102
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
103
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
104
|
+
* @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/>
|
|
105
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
listScheduledCommissionClawbackTriggers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
110
|
/**
|
|
95
111
|
* 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.
|
|
96
112
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -178,6 +194,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
178
194
|
* @throws {RequiredError}
|
|
179
195
|
*/
|
|
180
196
|
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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
|
|
197
|
+
/**
|
|
198
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
199
|
+
* @summary List scheduled commission clawback triggers
|
|
200
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
202
|
+
* @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.
|
|
203
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
204
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
205
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
206
|
+
* @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/>
|
|
207
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
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>>;
|
|
181
212
|
/**
|
|
182
213
|
* 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.
|
|
183
214
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -265,6 +296,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
265
296
|
* @throws {RequiredError}
|
|
266
297
|
*/
|
|
267
298
|
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>;
|
|
299
|
+
/**
|
|
300
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
301
|
+
* @summary List scheduled commission clawback triggers
|
|
302
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
304
|
+
* @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.
|
|
305
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
306
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
308
|
+
* @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/>
|
|
309
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
310
|
+
* @param {*} [options] Override http request option.
|
|
311
|
+
* @throws {RequiredError}
|
|
312
|
+
*/
|
|
313
|
+
listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>;
|
|
268
314
|
/**
|
|
269
315
|
* 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.
|
|
270
316
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -447,6 +493,61 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
447
493
|
*/
|
|
448
494
|
readonly filters?: string;
|
|
449
495
|
}
|
|
496
|
+
/**
|
|
497
|
+
* Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
|
|
498
|
+
* @export
|
|
499
|
+
* @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
|
|
500
|
+
*/
|
|
501
|
+
export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
|
|
502
|
+
/**
|
|
503
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
504
|
+
* @type {string}
|
|
505
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
506
|
+
*/
|
|
507
|
+
readonly authorization?: string;
|
|
508
|
+
/**
|
|
509
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
510
|
+
* @type {number}
|
|
511
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
512
|
+
*/
|
|
513
|
+
readonly pageSize?: number;
|
|
514
|
+
/**
|
|
515
|
+
* 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.
|
|
516
|
+
* @type {string}
|
|
517
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
518
|
+
*/
|
|
519
|
+
readonly pageToken?: string;
|
|
520
|
+
/**
|
|
521
|
+
* 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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
522
|
+
* @type {string}
|
|
523
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
524
|
+
*/
|
|
525
|
+
readonly filter?: string;
|
|
526
|
+
/**
|
|
527
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
530
|
+
*/
|
|
531
|
+
readonly search?: string;
|
|
532
|
+
/**
|
|
533
|
+
* 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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
536
|
+
*/
|
|
537
|
+
readonly order?: string;
|
|
538
|
+
/**
|
|
539
|
+
* 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/>
|
|
540
|
+
* @type {string}
|
|
541
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
542
|
+
*/
|
|
543
|
+
readonly expand?: string;
|
|
544
|
+
/**
|
|
545
|
+
* 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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
546
|
+
* @type {string}
|
|
547
|
+
* @memberof CommissionsApiListScheduledCommissionClawbackTriggers
|
|
548
|
+
*/
|
|
549
|
+
readonly filters?: string;
|
|
550
|
+
}
|
|
450
551
|
/**
|
|
451
552
|
* Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
|
|
452
553
|
* @export
|
|
@@ -552,6 +653,15 @@ export declare class CommissionsApi extends BaseAPI {
|
|
|
552
653
|
* @memberof CommissionsApi
|
|
553
654
|
*/
|
|
554
655
|
listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
|
|
656
|
+
/**
|
|
657
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
658
|
+
* @summary List scheduled commission clawback triggers
|
|
659
|
+
* @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
* @memberof CommissionsApi
|
|
663
|
+
*/
|
|
664
|
+
listScheduledCommissionClawbackTriggers(requestParameters?: CommissionsApiListScheduledCommissionClawbackTriggersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListScheduledCommissionClawbackTriggersResponseClass, any, {}>>;
|
|
555
665
|
/**
|
|
556
666
|
* 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.
|
|
557
667
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -417,6 +417,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
417
417
|
});
|
|
418
418
|
});
|
|
419
419
|
},
|
|
420
|
+
/**
|
|
421
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
422
|
+
* @summary List scheduled commission clawback triggers
|
|
423
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
424
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
425
|
+
* @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.
|
|
426
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
427
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
428
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
429
|
+
* @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/>
|
|
430
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
431
|
+
* @param {*} [options] Override http request option.
|
|
432
|
+
* @throws {RequiredError}
|
|
433
|
+
*/
|
|
434
|
+
listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
435
|
+
if (options === void 0) { options = {}; }
|
|
436
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
437
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
438
|
+
return __generator(this, function (_a) {
|
|
439
|
+
switch (_a.label) {
|
|
440
|
+
case 0:
|
|
441
|
+
localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
|
|
442
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
443
|
+
if (configuration) {
|
|
444
|
+
baseOptions = configuration.baseOptions;
|
|
445
|
+
baseAccessToken = configuration.accessToken;
|
|
446
|
+
}
|
|
447
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
448
|
+
localVarHeaderParameter = {};
|
|
449
|
+
localVarQueryParameter = {};
|
|
450
|
+
// authentication bearer required
|
|
451
|
+
// http bearer authentication required
|
|
452
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
453
|
+
case 1:
|
|
454
|
+
// authentication bearer required
|
|
455
|
+
// http bearer authentication required
|
|
456
|
+
_a.sent();
|
|
457
|
+
if (pageSize !== undefined) {
|
|
458
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
459
|
+
}
|
|
460
|
+
if (pageToken !== undefined) {
|
|
461
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
462
|
+
}
|
|
463
|
+
if (filter !== undefined) {
|
|
464
|
+
localVarQueryParameter['filter'] = filter;
|
|
465
|
+
}
|
|
466
|
+
if (search !== undefined) {
|
|
467
|
+
localVarQueryParameter['search'] = search;
|
|
468
|
+
}
|
|
469
|
+
if (order !== undefined) {
|
|
470
|
+
localVarQueryParameter['order'] = order;
|
|
471
|
+
}
|
|
472
|
+
if (expand !== undefined) {
|
|
473
|
+
localVarQueryParameter['expand'] = expand;
|
|
474
|
+
}
|
|
475
|
+
if (filters !== undefined) {
|
|
476
|
+
localVarQueryParameter['filters'] = filters;
|
|
477
|
+
}
|
|
478
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
479
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
480
|
+
}
|
|
481
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
482
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
483
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
484
|
+
return [2 /*return*/, {
|
|
485
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
486
|
+
options: localVarRequestOptions,
|
|
487
|
+
}];
|
|
488
|
+
}
|
|
489
|
+
});
|
|
490
|
+
});
|
|
491
|
+
},
|
|
420
492
|
/**
|
|
421
493
|
* 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.
|
|
422
494
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -663,6 +735,33 @@ var CommissionsApiFp = function (configuration) {
|
|
|
663
735
|
});
|
|
664
736
|
});
|
|
665
737
|
},
|
|
738
|
+
/**
|
|
739
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
740
|
+
* @summary List scheduled commission clawback triggers
|
|
741
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
742
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
743
|
+
* @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.
|
|
744
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
745
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
746
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
747
|
+
* @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/>
|
|
748
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
753
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
754
|
+
var localVarAxiosArgs;
|
|
755
|
+
return __generator(this, function (_a) {
|
|
756
|
+
switch (_a.label) {
|
|
757
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
758
|
+
case 1:
|
|
759
|
+
localVarAxiosArgs = _a.sent();
|
|
760
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
761
|
+
}
|
|
762
|
+
});
|
|
763
|
+
});
|
|
764
|
+
},
|
|
666
765
|
/**
|
|
667
766
|
* 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.
|
|
668
767
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -790,6 +889,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
790
889
|
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
791
890
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
792
891
|
},
|
|
892
|
+
/**
|
|
893
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
894
|
+
* @summary List scheduled commission clawback triggers
|
|
895
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
896
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
897
|
+
* @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.
|
|
898
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
899
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
900
|
+
* @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, effectiveDate, queuedAt, createdAt, updatedAt</i>
|
|
901
|
+
* @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/>
|
|
902
|
+
* @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, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
903
|
+
* @param {*} [options] Override http request option.
|
|
904
|
+
* @throws {RequiredError}
|
|
905
|
+
*/
|
|
906
|
+
listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
907
|
+
return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
908
|
+
},
|
|
793
909
|
/**
|
|
794
910
|
* 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.
|
|
795
911
|
* @summary Create the due commission clawbacks trigger
|
|
@@ -900,6 +1016,19 @@ var CommissionsApi = /** @class */ (function (_super) {
|
|
|
900
1016
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
901
1017
|
return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
902
1018
|
};
|
|
1019
|
+
/**
|
|
1020
|
+
* Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
|
|
1021
|
+
* @summary List scheduled commission clawback triggers
|
|
1022
|
+
* @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
|
|
1023
|
+
* @param {*} [options] Override http request option.
|
|
1024
|
+
* @throws {RequiredError}
|
|
1025
|
+
* @memberof CommissionsApi
|
|
1026
|
+
*/
|
|
1027
|
+
CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
|
|
1028
|
+
var _this = this;
|
|
1029
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1030
|
+
return (0, exports.CommissionsApiFp)(this.configuration).listScheduledCommissionClawbackTriggers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1031
|
+
};
|
|
903
1032
|
/**
|
|
904
1033
|
* 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.
|
|
905
1034
|
* @summary Create the due commission clawbacks trigger
|
package/dist/models/index.d.ts
CHANGED
|
@@ -61,10 +61,12 @@ export * from './list-commission-candidates-response-class';
|
|
|
61
61
|
export * from './list-commission-recipients-response-class';
|
|
62
62
|
export * from './list-commission-settlements-response-class';
|
|
63
63
|
export * from './list-commissions-response-class';
|
|
64
|
+
export * from './list-scheduled-commission-clawback-triggers-response-class';
|
|
64
65
|
export * from './patch-commission-agreement-status-request-dto';
|
|
65
66
|
export * from './patch-commission-agreement-status-response-class';
|
|
66
67
|
export * from './publish-commission-settlements-request-dto';
|
|
67
68
|
export * from './publish-commission-settlements-response-class';
|
|
69
|
+
export * from './scheduled-commission-clawback-trigger-class';
|
|
68
70
|
export * from './trigger-commission-settlement-creation-request-dto';
|
|
69
71
|
export * from './trigger-commission-settlement-creation-response-class';
|
|
70
72
|
export * from './trigger-due-commission-clawbacks-request-dto';
|
package/dist/models/index.js
CHANGED
|
@@ -77,10 +77,12 @@ __exportStar(require("./list-commission-candidates-response-class"), exports);
|
|
|
77
77
|
__exportStar(require("./list-commission-recipients-response-class"), exports);
|
|
78
78
|
__exportStar(require("./list-commission-settlements-response-class"), exports);
|
|
79
79
|
__exportStar(require("./list-commissions-response-class"), exports);
|
|
80
|
+
__exportStar(require("./list-scheduled-commission-clawback-triggers-response-class"), exports);
|
|
80
81
|
__exportStar(require("./patch-commission-agreement-status-request-dto"), exports);
|
|
81
82
|
__exportStar(require("./patch-commission-agreement-status-response-class"), exports);
|
|
82
83
|
__exportStar(require("./publish-commission-settlements-request-dto"), exports);
|
|
83
84
|
__exportStar(require("./publish-commission-settlements-response-class"), exports);
|
|
85
|
+
__exportStar(require("./scheduled-commission-clawback-trigger-class"), exports);
|
|
84
86
|
__exportStar(require("./trigger-commission-settlement-creation-request-dto"), exports);
|
|
85
87
|
__exportStar(require("./trigger-commission-settlement-creation-response-class"), exports);
|
|
86
88
|
__exportStar(require("./trigger-due-commission-clawbacks-request-dto"), exports);
|
|
@@ -0,0 +1,43 @@
|
|
|
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 { ScheduledCommissionClawbackTriggerClass } from './scheduled-commission-clawback-trigger-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListScheduledCommissionClawbackTriggersResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ListScheduledCommissionClawbackTriggersResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* The list of scheduled commission clawback triggerss.
|
|
21
|
+
* @type {Array<ScheduledCommissionClawbackTriggerClass>}
|
|
22
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'items': Array<ScheduledCommissionClawbackTriggerClass>;
|
|
25
|
+
/**
|
|
26
|
+
* Next page token.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
29
|
+
*/
|
|
30
|
+
'nextPageToken': string;
|
|
31
|
+
/**
|
|
32
|
+
* Items per page.
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
35
|
+
*/
|
|
36
|
+
'itemsPerPage': number;
|
|
37
|
+
/**
|
|
38
|
+
* Total amount of items.
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
41
|
+
*/
|
|
42
|
+
'totalItems': number;
|
|
43
|
+
}
|
|
@@ -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,109 @@
|
|
|
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 ScheduledCommissionClawbackTriggerClass
|
|
16
|
+
*/
|
|
17
|
+
export interface ScheduledCommissionClawbackTriggerClass {
|
|
18
|
+
/**
|
|
19
|
+
* The unique database identifier of the scheduled trigger
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
22
|
+
*/
|
|
23
|
+
'id': number;
|
|
24
|
+
/**
|
|
25
|
+
* Unique identifier for the object.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
28
|
+
*/
|
|
29
|
+
'code': string;
|
|
30
|
+
/**
|
|
31
|
+
* The policy this scheduled clawback trigger belongs to
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
34
|
+
*/
|
|
35
|
+
'policyCode': string;
|
|
36
|
+
/**
|
|
37
|
+
* The automatic clawback trigger type
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
40
|
+
*/
|
|
41
|
+
'triggerType': ScheduledCommissionClawbackTriggerClassTriggerTypeEnum;
|
|
42
|
+
/**
|
|
43
|
+
* The effective date when the scheduled clawback trigger becomes due
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
46
|
+
*/
|
|
47
|
+
'effectiveDate': string;
|
|
48
|
+
/**
|
|
49
|
+
* The current scheduled trigger status
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
52
|
+
*/
|
|
53
|
+
'status': ScheduledCommissionClawbackTriggerClassStatusEnum;
|
|
54
|
+
/**
|
|
55
|
+
* The time when the due job queued this trigger for processing
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
58
|
+
*/
|
|
59
|
+
'queuedAt'?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Failure reason when processing this scheduled trigger failed
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
64
|
+
*/
|
|
65
|
+
'errorMessage'?: string;
|
|
66
|
+
/**
|
|
67
|
+
* The time when this scheduled trigger was canceled
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
70
|
+
*/
|
|
71
|
+
'canceledAt'?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Time at which the object was created.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
76
|
+
*/
|
|
77
|
+
'createdAt': string;
|
|
78
|
+
/**
|
|
79
|
+
* Time at which the object was updated.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
82
|
+
*/
|
|
83
|
+
'updatedAt': string;
|
|
84
|
+
/**
|
|
85
|
+
* Identifier of the user who created the record.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
88
|
+
*/
|
|
89
|
+
'createdBy': string;
|
|
90
|
+
/**
|
|
91
|
+
* Identifier of the user who last updated the record.
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
94
|
+
*/
|
|
95
|
+
'updatedBy': string;
|
|
96
|
+
}
|
|
97
|
+
export declare const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum: {
|
|
98
|
+
readonly PolicyTermination: "policy_termination";
|
|
99
|
+
readonly PolicyWithdrawal: "policy_withdrawal";
|
|
100
|
+
readonly IntermediarySwitched: "intermediary_switched";
|
|
101
|
+
};
|
|
102
|
+
export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
|
|
103
|
+
export declare const ScheduledCommissionClawbackTriggerClassStatusEnum: {
|
|
104
|
+
readonly Scheduled: "scheduled";
|
|
105
|
+
readonly Queued: "queued";
|
|
106
|
+
readonly Canceled: "canceled";
|
|
107
|
+
readonly Failed: "failed";
|
|
108
|
+
};
|
|
109
|
+
export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];
|
|
@@ -0,0 +1,27 @@
|
|
|
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 });
|
|
16
|
+
exports.ScheduledCommissionClawbackTriggerClassStatusEnum = exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = void 0;
|
|
17
|
+
exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
|
|
18
|
+
PolicyTermination: 'policy_termination',
|
|
19
|
+
PolicyWithdrawal: 'policy_withdrawal',
|
|
20
|
+
IntermediarySwitched: 'intermediary_switched'
|
|
21
|
+
};
|
|
22
|
+
exports.ScheduledCommissionClawbackTriggerClassStatusEnum = {
|
|
23
|
+
Scheduled: 'scheduled',
|
|
24
|
+
Queued: 'queued',
|
|
25
|
+
Canceled: 'canceled',
|
|
26
|
+
Failed: 'failed'
|
|
27
|
+
};
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface TriggerDueCommissionClawbacksRequestDto {
|
|
18
18
|
/**
|
|
19
|
-
* Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
|
|
19
|
+
* Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used. Future dates are only allowed when dryRun is true.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof TriggerDueCommissionClawbacksRequestDto
|
|
22
22
|
*/
|
package/models/index.ts
CHANGED
|
@@ -61,10 +61,12 @@ export * from './list-commission-candidates-response-class';
|
|
|
61
61
|
export * from './list-commission-recipients-response-class';
|
|
62
62
|
export * from './list-commission-settlements-response-class';
|
|
63
63
|
export * from './list-commissions-response-class';
|
|
64
|
+
export * from './list-scheduled-commission-clawback-triggers-response-class';
|
|
64
65
|
export * from './patch-commission-agreement-status-request-dto';
|
|
65
66
|
export * from './patch-commission-agreement-status-response-class';
|
|
66
67
|
export * from './publish-commission-settlements-request-dto';
|
|
67
68
|
export * from './publish-commission-settlements-response-class';
|
|
69
|
+
export * from './scheduled-commission-clawback-trigger-class';
|
|
68
70
|
export * from './trigger-commission-settlement-creation-request-dto';
|
|
69
71
|
export * from './trigger-commission-settlement-creation-response-class';
|
|
70
72
|
export * from './trigger-due-commission-clawbacks-request-dto';
|
|
@@ -0,0 +1,49 @@
|
|
|
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 { ScheduledCommissionClawbackTriggerClass } from './scheduled-commission-clawback-trigger-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface ListScheduledCommissionClawbackTriggersResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface ListScheduledCommissionClawbackTriggersResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The list of scheduled commission clawback triggerss.
|
|
26
|
+
* @type {Array<ScheduledCommissionClawbackTriggerClass>}
|
|
27
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'items': Array<ScheduledCommissionClawbackTriggerClass>;
|
|
30
|
+
/**
|
|
31
|
+
* Next page token.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
34
|
+
*/
|
|
35
|
+
'nextPageToken': string;
|
|
36
|
+
/**
|
|
37
|
+
* Items per page.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
40
|
+
*/
|
|
41
|
+
'itemsPerPage': number;
|
|
42
|
+
/**
|
|
43
|
+
* Total amount of items.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof ListScheduledCommissionClawbackTriggersResponseClass
|
|
46
|
+
*/
|
|
47
|
+
'totalItems': number;
|
|
48
|
+
}
|
|
49
|
+
|
|
@@ -0,0 +1,119 @@
|
|
|
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 ScheduledCommissionClawbackTriggerClass
|
|
21
|
+
*/
|
|
22
|
+
export interface ScheduledCommissionClawbackTriggerClass {
|
|
23
|
+
/**
|
|
24
|
+
* The unique database identifier of the scheduled trigger
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
27
|
+
*/
|
|
28
|
+
'id': number;
|
|
29
|
+
/**
|
|
30
|
+
* Unique identifier for the object.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
33
|
+
*/
|
|
34
|
+
'code': string;
|
|
35
|
+
/**
|
|
36
|
+
* The policy this scheduled clawback trigger belongs to
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
39
|
+
*/
|
|
40
|
+
'policyCode': string;
|
|
41
|
+
/**
|
|
42
|
+
* The automatic clawback trigger type
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
45
|
+
*/
|
|
46
|
+
'triggerType': ScheduledCommissionClawbackTriggerClassTriggerTypeEnum;
|
|
47
|
+
/**
|
|
48
|
+
* The effective date when the scheduled clawback trigger becomes due
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
51
|
+
*/
|
|
52
|
+
'effectiveDate': string;
|
|
53
|
+
/**
|
|
54
|
+
* The current scheduled trigger status
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
57
|
+
*/
|
|
58
|
+
'status': ScheduledCommissionClawbackTriggerClassStatusEnum;
|
|
59
|
+
/**
|
|
60
|
+
* The time when the due job queued this trigger for processing
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
63
|
+
*/
|
|
64
|
+
'queuedAt'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Failure reason when processing this scheduled trigger failed
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
69
|
+
*/
|
|
70
|
+
'errorMessage'?: string;
|
|
71
|
+
/**
|
|
72
|
+
* The time when this scheduled trigger was canceled
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
75
|
+
*/
|
|
76
|
+
'canceledAt'?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Time at which the object was created.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
81
|
+
*/
|
|
82
|
+
'createdAt': string;
|
|
83
|
+
/**
|
|
84
|
+
* Time at which the object was updated.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
87
|
+
*/
|
|
88
|
+
'updatedAt': string;
|
|
89
|
+
/**
|
|
90
|
+
* Identifier of the user who created the record.
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
93
|
+
*/
|
|
94
|
+
'createdBy': string;
|
|
95
|
+
/**
|
|
96
|
+
* Identifier of the user who last updated the record.
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof ScheduledCommissionClawbackTriggerClass
|
|
99
|
+
*/
|
|
100
|
+
'updatedBy': string;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
|
|
104
|
+
PolicyTermination: 'policy_termination',
|
|
105
|
+
PolicyWithdrawal: 'policy_withdrawal',
|
|
106
|
+
IntermediarySwitched: 'intermediary_switched'
|
|
107
|
+
} as const;
|
|
108
|
+
|
|
109
|
+
export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
|
|
110
|
+
export const ScheduledCommissionClawbackTriggerClassStatusEnum = {
|
|
111
|
+
Scheduled: 'scheduled',
|
|
112
|
+
Queued: 'queued',
|
|
113
|
+
Canceled: 'canceled',
|
|
114
|
+
Failed: 'failed'
|
|
115
|
+
} as const;
|
|
116
|
+
|
|
117
|
+
export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];
|
|
118
|
+
|
|
119
|
+
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface TriggerDueCommissionClawbacksRequestDto {
|
|
23
23
|
/**
|
|
24
|
-
* Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
|
|
24
|
+
* Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used. Future dates are only allowed when dryRun is true.
|
|
25
25
|
* @type {string}
|
|
26
26
|
* @memberof TriggerDueCommissionClawbacksRequestDto
|
|
27
27
|
*/
|