@emilgroup/commission-sdk-node 2.9.1-beta.3 → 2.9.1-beta.6
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 +7 -0
- package/README.md +2 -2
- package/api/commission-agreement-versions-api.ts +12 -12
- package/api/commission-settlements-api.ts +107 -0
- package/api/commissions-api.ts +240 -13
- package/dist/api/commission-agreement-versions-api.d.ts +12 -12
- package/dist/api/commission-agreement-versions-api.js +9 -9
- package/dist/api/commission-settlements-api.d.ts +57 -0
- package/dist/api/commission-settlements-api.js +93 -0
- package/dist/api/commissions-api.d.ts +136 -13
- package/dist/api/commissions-api.js +198 -6
- package/dist/models/clawback-config-dto.d.ts +36 -0
- package/dist/models/clawback-config-dto.js +15 -0
- package/dist/models/commission-agreement-version-class.d.ts +13 -0
- package/dist/models/commission-candidate-class.d.ts +12 -0
- package/dist/models/commission-class.d.ts +49 -0
- package/dist/models/commission-class.js +7 -0
- package/dist/models/commission-config-dto.d.ts +2 -1
- package/dist/models/commission-config-dto.js +2 -1
- package/dist/models/commission-estimate-class.d.ts +2 -1
- package/dist/models/commission-estimate-class.js +2 -1
- package/dist/models/create-commission-agreement-request-dto.d.ts +13 -0
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +13 -0
- package/dist/models/create-commission-candidate-request-dto.d.ts +2 -1
- package/dist/models/create-commission-candidate-request-dto.js +2 -1
- package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
- package/dist/models/create-commission-clawback-request-dto.js +15 -0
- package/dist/models/create-commission-clawback-response-class.d.ts +45 -0
- package/dist/models/create-commission-clawback-response-class.js +23 -0
- package/dist/models/create-commission-item-request-dto.d.ts +2 -1
- package/dist/models/create-commission-item-request-dto.js +2 -1
- package/dist/models/evaluated-commission-class.d.ts +2 -1
- package/dist/models/evaluated-commission-class.js +2 -1
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
- package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
- package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
- package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
- package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
- package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
- package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
- package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
- package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
- package/dist/models/update-commission-candidate-request-dto.js +2 -1
- package/models/clawback-config-dto.ts +42 -0
- package/models/commission-agreement-version-class.ts +13 -0
- package/models/commission-candidate-class.ts +12 -0
- package/models/commission-class.ts +52 -0
- package/models/commission-config-dto.ts +3 -2
- package/models/commission-estimate-class.ts +3 -2
- package/models/create-commission-agreement-request-dto.ts +13 -0
- package/models/create-commission-agreement-version-request-dto.ts +13 -0
- package/models/create-commission-candidate-request-dto.ts +3 -2
- package/models/create-commission-clawback-request-dto.ts +30 -0
- package/models/create-commission-clawback-response-class.ts +54 -0
- package/models/create-commission-item-request-dto.ts +3 -2
- package/models/evaluated-commission-class.ts +3 -2
- package/models/index.ts +7 -0
- package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
- package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
- package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
- package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
- package/models/update-commission-candidate-request-dto.ts +3 -2
- package/package.json +1 -1
|
@@ -39,7 +39,7 @@ export interface CreateCommissionCandidateRequestDto {
|
|
|
39
39
|
*/
|
|
40
40
|
'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
|
|
41
41
|
/**
|
|
42
|
-
* The type of commission. Valid values: sales, maintenance, other
|
|
42
|
+
* The type of commission. Valid values: sales, maintenance, other, clawback
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof CreateCommissionCandidateRequestDto
|
|
45
45
|
*/
|
|
@@ -67,7 +67,8 @@ export type CreateCommissionCandidateRequestDtoCandidateTypeEnum = typeof Create
|
|
|
67
67
|
export const CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
|
|
68
68
|
Sales: 'sales',
|
|
69
69
|
Maintenance: 'maintenance',
|
|
70
|
-
Other: 'other'
|
|
70
|
+
Other: 'other',
|
|
71
|
+
Clawback: 'clawback'
|
|
71
72
|
} as const;
|
|
72
73
|
|
|
73
74
|
export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];
|
|
@@ -0,0 +1,30 @@
|
|
|
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 CreateCommissionClawbackRequestDto
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateCommissionClawbackRequestDto {
|
|
23
|
+
/**
|
|
24
|
+
* Optional business effective date for the clawback calculation. If omitted, server processing time is used.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof CreateCommissionClawbackRequestDto
|
|
27
|
+
*/
|
|
28
|
+
'effectiveDate'?: string;
|
|
29
|
+
}
|
|
30
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
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 { CommissionClass } from './commission-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface CreateCommissionClawbackResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface CreateCommissionClawbackResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* Whether a new clawback commission was created.
|
|
26
|
+
* @type {boolean}
|
|
27
|
+
* @memberof CreateCommissionClawbackResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'created': boolean;
|
|
30
|
+
/**
|
|
31
|
+
* Reason why no clawback commission was created. Possible reasons: the original commission was not paid out, the calculated clawback amount was zero or positive, or the commission was already fully clawed back.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof CreateCommissionClawbackResponseClass
|
|
34
|
+
*/
|
|
35
|
+
'notCreatedReason'?: CreateCommissionClawbackResponseClassNotCreatedReasonEnum;
|
|
36
|
+
/**
|
|
37
|
+
* Created clawback commission. Set only when created is true.
|
|
38
|
+
* @type {CommissionClass}
|
|
39
|
+
* @memberof CreateCommissionClawbackResponseClass
|
|
40
|
+
*/
|
|
41
|
+
'commission'?: CommissionClass;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export const CreateCommissionClawbackResponseClassNotCreatedReasonEnum = {
|
|
45
|
+
NUMBER_0: 0,
|
|
46
|
+
NUMBER_1: 1,
|
|
47
|
+
NUMBER_2: 2,
|
|
48
|
+
NUMBER_3: 3,
|
|
49
|
+
NUMBER_MINUS_1: -1
|
|
50
|
+
} as const;
|
|
51
|
+
|
|
52
|
+
export type CreateCommissionClawbackResponseClassNotCreatedReasonEnum = typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum[keyof typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum];
|
|
53
|
+
|
|
54
|
+
|
|
@@ -39,7 +39,7 @@ export interface CreateCommissionItemRequestDto {
|
|
|
39
39
|
*/
|
|
40
40
|
'amount': number;
|
|
41
41
|
/**
|
|
42
|
-
* The type of commission item. Valid values: sales, maintenance, other
|
|
42
|
+
* The type of commission item. Valid values: sales, maintenance, other, clawback
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof CreateCommissionItemRequestDto
|
|
45
45
|
*/
|
|
@@ -49,7 +49,8 @@ export interface CreateCommissionItemRequestDto {
|
|
|
49
49
|
export const CreateCommissionItemRequestDtoTypeEnum = {
|
|
50
50
|
Sales: 'sales',
|
|
51
51
|
Maintenance: 'maintenance',
|
|
52
|
-
Other: 'other'
|
|
52
|
+
Other: 'other',
|
|
53
|
+
Clawback: 'clawback'
|
|
53
54
|
} as const;
|
|
54
55
|
|
|
55
56
|
export type CreateCommissionItemRequestDtoTypeEnum = typeof CreateCommissionItemRequestDtoTypeEnum[keyof typeof CreateCommissionItemRequestDtoTypeEnum];
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface EvaluatedCommissionClass {
|
|
23
23
|
/**
|
|
24
|
-
* Type of commission (e.g., sales, maintenance, other)
|
|
24
|
+
* Type of commission (e.g., sales, maintenance, other, clawback)
|
|
25
25
|
* @type {string}
|
|
26
26
|
* @memberof EvaluatedCommissionClass
|
|
27
27
|
*/
|
|
@@ -55,7 +55,8 @@ export interface EvaluatedCommissionClass {
|
|
|
55
55
|
export const EvaluatedCommissionClassTypeEnum = {
|
|
56
56
|
Sales: 'sales',
|
|
57
57
|
Maintenance: 'maintenance',
|
|
58
|
-
Other: 'other'
|
|
58
|
+
Other: 'other',
|
|
59
|
+
Clawback: 'clawback'
|
|
59
60
|
} as const;
|
|
60
61
|
|
|
61
62
|
export type EvaluatedCommissionClassTypeEnum = typeof EvaluatedCommissionClassTypeEnum[keyof typeof EvaluatedCommissionClassTypeEnum];
|
package/models/index.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from './clawback-config-dto';
|
|
1
2
|
export * from './commission-agreement-class';
|
|
2
3
|
export * from './commission-agreement-metadata-dto';
|
|
3
4
|
export * from './commission-agreement-metadata-partner-dto';
|
|
@@ -24,6 +25,8 @@ export * from './create-commission-agreement-version-request-dto';
|
|
|
24
25
|
export * from './create-commission-agreement-version-response-class';
|
|
25
26
|
export * from './create-commission-candidate-request-dto';
|
|
26
27
|
export * from './create-commission-candidate-response-class';
|
|
28
|
+
export * from './create-commission-clawback-request-dto';
|
|
29
|
+
export * from './create-commission-clawback-response-class';
|
|
27
30
|
export * from './create-commission-item-request-dto';
|
|
28
31
|
export * from './create-commission-recipient-for-products-request-dto';
|
|
29
32
|
export * from './create-commission-recipient-for-products-response-class';
|
|
@@ -61,6 +64,10 @@ export * from './patch-commission-agreement-status-request-dto';
|
|
|
61
64
|
export * from './patch-commission-agreement-status-response-class';
|
|
62
65
|
export * from './publish-commission-settlements-request-dto';
|
|
63
66
|
export * from './publish-commission-settlements-response-class';
|
|
67
|
+
export * from './trigger-commission-settlement-creation-request-dto';
|
|
68
|
+
export * from './trigger-commission-settlement-creation-response-class';
|
|
69
|
+
export * from './trigger-due-commission-clawbacks-request-dto';
|
|
70
|
+
export * from './trigger-due-commission-clawbacks-response-class';
|
|
64
71
|
export * from './update-commission-agreement-product-request-dto';
|
|
65
72
|
export * from './update-commission-agreement-product-response-class';
|
|
66
73
|
export * from './update-commission-agreement-request-dto';
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL CommissionService
|
|
5
|
+
* The EMIL CommissionService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface TriggerCommissionSettlementCreationRequestDto
|
|
21
|
+
*/
|
|
22
|
+
export interface TriggerCommissionSettlementCreationRequestDto {
|
|
23
|
+
/**
|
|
24
|
+
* Optional business execution timestamp used to evaluate the due date. The settlement window ends at the start of that due date. Defaults to the current timestamp when omitted.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof TriggerCommissionSettlementCreationRequestDto
|
|
27
|
+
*/
|
|
28
|
+
'executionDate'?: string;
|
|
29
|
+
/**
|
|
30
|
+
* When true, validates and logs what would be processed without creating settlements.
|
|
31
|
+
* @type {boolean}
|
|
32
|
+
* @memberof TriggerCommissionSettlementCreationRequestDto
|
|
33
|
+
*/
|
|
34
|
+
'dryRun'?: boolean;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
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 TriggerCommissionSettlementCreationResponseClass
|
|
21
|
+
*/
|
|
22
|
+
export interface TriggerCommissionSettlementCreationResponseClass {
|
|
23
|
+
/**
|
|
24
|
+
* Indicates that the commission settlement creation job was triggered.
|
|
25
|
+
* @type {boolean}
|
|
26
|
+
* @memberof TriggerCommissionSettlementCreationResponseClass
|
|
27
|
+
*/
|
|
28
|
+
'success': boolean;
|
|
29
|
+
}
|
|
30
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL CommissionService
|
|
5
|
+
* The EMIL CommissionService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface TriggerDueCommissionClawbacksRequestDto
|
|
21
|
+
*/
|
|
22
|
+
export interface TriggerDueCommissionClawbacksRequestDto {
|
|
23
|
+
/**
|
|
24
|
+
* Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof TriggerDueCommissionClawbacksRequestDto
|
|
27
|
+
*/
|
|
28
|
+
'processingDate'?: string;
|
|
29
|
+
/**
|
|
30
|
+
* When true, due triggers are counted but not enqueued or marked queued.
|
|
31
|
+
* @type {boolean}
|
|
32
|
+
* @memberof TriggerDueCommissionClawbacksRequestDto
|
|
33
|
+
*/
|
|
34
|
+
'dryRun'?: boolean;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
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 TriggerDueCommissionClawbacksResponseClass
|
|
21
|
+
*/
|
|
22
|
+
export interface TriggerDueCommissionClawbacksResponseClass {
|
|
23
|
+
/**
|
|
24
|
+
* Whether due scheduled clawback trigger processing completed.
|
|
25
|
+
* @type {boolean}
|
|
26
|
+
* @memberof TriggerDueCommissionClawbacksResponseClass
|
|
27
|
+
*/
|
|
28
|
+
'success': boolean;
|
|
29
|
+
}
|
|
30
|
+
|
|
@@ -45,7 +45,7 @@ export interface UpdateCommissionCandidateRequestDto {
|
|
|
45
45
|
*/
|
|
46
46
|
'status'?: UpdateCommissionCandidateRequestDtoStatusEnum;
|
|
47
47
|
/**
|
|
48
|
-
* The type of commission. Valid values: sales, maintenance, other
|
|
48
|
+
* The type of commission. Valid values: sales, maintenance, other, clawback
|
|
49
49
|
* @type {string}
|
|
50
50
|
* @memberof UpdateCommissionCandidateRequestDto
|
|
51
51
|
*/
|
|
@@ -73,7 +73,8 @@ export type UpdateCommissionCandidateRequestDtoStatusEnum = typeof UpdateCommiss
|
|
|
73
73
|
export const UpdateCommissionCandidateRequestDtoCommissionTypeEnum = {
|
|
74
74
|
Sales: 'sales',
|
|
75
75
|
Maintenance: 'maintenance',
|
|
76
|
-
Other: 'other'
|
|
76
|
+
Other: 'other',
|
|
77
|
+
Clawback: 'clawback'
|
|
77
78
|
} as const;
|
|
78
79
|
|
|
79
80
|
export type UpdateCommissionCandidateRequestDtoCommissionTypeEnum = typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum];
|