@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.1-beta.21

package/dist/models/clawback-config-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/commission-agreement-version-class.d.ts

@@ -11,6 +11,7 @@
  */
 import { CommissionAgreementClass } from './commission-agreement-class';
 import { CommissionAgreementProductClass } from './commission-agreement-product-class';
+import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
 /**
  *
  * @export
@@ -59,6 +60,12 @@ export interface CommissionAgreementVersionClass {
      * @memberof CommissionAgreementVersionClass
      */
     'settlementCreationDate'?: string;
+    /**
+     * Version-scoped agreement configuration.
+     * @type {CommissionAgreementVersionConfigClass}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'config': CommissionAgreementVersionConfigClass;
     /**
      * Description explaining what changed in this version or version notes
      * @type {string}

package/dist/models/commission-agreement-version-config-class.d.ts

@@ -0,0 +1,32 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ClawbackConfigClass } from './clawback-config-class';
+import { CommissionCreationConfigClass } from './commission-creation-config-class';
+/**
+ *
+ * @export
+ * @interface CommissionAgreementVersionConfigClass
+ */
+export interface CommissionAgreementVersionConfigClass {
+    /**
+     * Controls which clawback triggers are enabled for this commission agreement version.      Missing values are treated as disabled by default.
+     * @type {ClawbackConfigClass}
+     * @memberof CommissionAgreementVersionConfigClass
+     */
+    'clawback'?: ClawbackConfigClass;
+    /**
+     * Controls when recurring commission work is created for this commission agreement version.      Missing values are treated as renewal mode by default.
+     * @type {CommissionCreationConfigClass}
+     * @memberof CommissionAgreementVersionConfigClass
+     */
+    'commissionCreation'?: CommissionCreationConfigClass;
+}

package/dist/models/commission-agreement-version-config-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/commission-agreement-version-config-dto.d.ts

@@ -0,0 +1,32 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ClawbackConfigDto } from './clawback-config-dto';
+import { CommissionCreationConfigDto } from './commission-creation-config-dto';
+/**
+ *
+ * @export
+ * @interface CommissionAgreementVersionConfigDto
+ */
+export interface CommissionAgreementVersionConfigDto {
+    /**
+     * Controls which clawback triggers are enabled for this commission agreement version.      Missing values are treated as disabled by default.
+     * @type {ClawbackConfigDto}
+     * @memberof CommissionAgreementVersionConfigDto
+     */
+    'clawback'?: ClawbackConfigDto;
+    /**
+     * Controls when recurring commission work is created for this commission agreement version.      Missing values are treated as renewal mode by default.
+     * @type {CommissionCreationConfigDto}
+     * @memberof CommissionAgreementVersionConfigDto
+     */
+    'commissionCreation'?: CommissionCreationConfigDto;
+}

package/dist/models/commission-agreement-version-config-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/commission-candidate-class.d.ts

@@ -63,6 +63,18 @@ export interface CommissionCandidateClass {
      * @memberof CommissionCandidateClass
      */
     'policyRenewalDate'?: string;
+    /**
+     * Exclusive end of the period the commission will be created for
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period, used as the pro rata denominator
+     * @type {number}
+     * @memberof CommissionCandidateClass
+     */
+    'expectedInvoiceEntryCount'?: number;
     /**
      * Time at which the object was created.
      * @type {string}

package/dist/models/commission-class.d.ts

@@ -107,6 +107,36 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'settlementCode'?: string;
+    /**
+     * Start of the period the commission was originally created for
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionPeriodFrom'?: string;
+    /**
+     * Exclusive end of the period the commission was originally created for
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period, used as the pro rata denominator
+     * @type {number}
+     * @memberof CommissionClass
+     */
+    'expectedInvoiceEntryCount'?: number;
+    /**
+     * For clawback commissions, the original commission being clawed back
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'originalCommissionCode'?: string;
+    /**
+     * The trigger type that created this clawback commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'clawbackTriggerType'?: CommissionClassClawbackTriggerTypeEnum;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -138,3 +168,11 @@ export interface CommissionClass {
      */
     'items': Array<CommissionItemClass>;
 }
+export declare const CommissionClassClawbackTriggerTypeEnum: {
+    readonly Manual: "manual";
+    readonly PolicyTermination: "policy_termination";
+    readonly PolicyWithdrawal: "policy_withdrawal";
+    readonly IntermediarySwitched: "intermediary_switched";
+    readonly InvoiceReopened: "invoice_reopened";
+};
+export type CommissionClassClawbackTriggerTypeEnum = typeof CommissionClassClawbackTriggerTypeEnum[keyof typeof CommissionClassClawbackTriggerTypeEnum];

package/dist/models/commission-class.js

@@ -13,3 +13,11 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionClassClawbackTriggerTypeEnum = void 0;
+exports.CommissionClassClawbackTriggerTypeEnum = {
+    Manual: 'manual',
+    PolicyTermination: 'policy_termination',
+    PolicyWithdrawal: 'policy_withdrawal',
+    IntermediarySwitched: 'intermediary_switched',
+    InvoiceReopened: 'invoice_reopened'
+};

package/dist/models/commission-config-dto.d.ts

@@ -17,7 +17,7 @@ import { CommissionConditionsDto } from './commission-conditions-dto';
  */
 export interface CommissionConfigDto {
     /**
-     * Type of commission (e.g., sales, maintenance, other)
+     * Type of commission (e.g., sales, maintenance, other, clawback)
      * @type {string}
      * @memberof CommissionConfigDto
      */
@@ -45,6 +45,7 @@ export declare const CommissionConfigDtoTypeEnum: {
     readonly Sales: "sales";
     readonly Maintenance: "maintenance";
     readonly Other: "other";
+    readonly Clawback: "clawback";
 };
 export type CommissionConfigDtoTypeEnum = typeof CommissionConfigDtoTypeEnum[keyof typeof CommissionConfigDtoTypeEnum];
 export declare const CommissionConfigDtoCurrencyEnum: {

package/dist/models/commission-config-dto.js

@@ -17,7 +17,8 @@ exports.CommissionConfigDtoCurrencyEnum = exports.CommissionConfigDtoTypeEnum =
 exports.CommissionConfigDtoTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 };
 exports.CommissionConfigDtoCurrencyEnum = {
     Eur: 'EUR',

package/dist/models/commission-creation-config-class.d.ts

@@ -0,0 +1,43 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CommissionCreationInvoiceConfigClass } from './commission-creation-invoice-config-class';
+import { CommissionCreationRenewalConfigClass } from './commission-creation-renewal-config-class';
+/**
+ *
+ * @export
+ * @interface CommissionCreationConfigClass
+ */
+export interface CommissionCreationConfigClass {
+    /**
+     * Determines which event drives recurring commission creation: renewal dates or paid invoices.
+     * @type {string}
+     * @memberof CommissionCreationConfigClass
+     */
+    'mode': CommissionCreationConfigClassModeEnum;
+    /**
+     * Required when mode is renewal.      Defines whether commission work is created only at renewal or yearly inside long policy periods.
+     * @type {CommissionCreationRenewalConfigClass}
+     * @memberof CommissionCreationConfigClass
+     */
+    'renewal'?: CommissionCreationRenewalConfigClass;
+    /**
+     * Required when mode is invoice.     Defines how many paid invoices must be counted before commission work is created.
+     * @type {CommissionCreationInvoiceConfigClass}
+     * @memberof CommissionCreationConfigClass
+     */
+    'invoice'?: CommissionCreationInvoiceConfigClass;
+}
+export declare const CommissionCreationConfigClassModeEnum: {
+    readonly Renewal: "renewal";
+    readonly Invoice: "invoice";
+};
+export type CommissionCreationConfigClassModeEnum = typeof CommissionCreationConfigClassModeEnum[keyof typeof CommissionCreationConfigClassModeEnum];

package/dist/models/commission-creation-config-class.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionCreationConfigClassModeEnum = void 0;
+exports.CommissionCreationConfigClassModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+};

package/dist/models/commission-creation-config-dto.d.ts

@@ -0,0 +1,43 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CommissionCreationInvoiceConfigDto } from './commission-creation-invoice-config-dto';
+import { CommissionCreationRenewalConfigDto } from './commission-creation-renewal-config-dto';
+/**
+ *
+ * @export
+ * @interface CommissionCreationConfigDto
+ */
+export interface CommissionCreationConfigDto {
+    /**
+     * Determines which event drives recurring commission creation: renewal dates or paid invoices.
+     * @type {string}
+     * @memberof CommissionCreationConfigDto
+     */
+    'mode': CommissionCreationConfigDtoModeEnum;
+    /**
+     * Required when mode is renewal.      Defines whether commission work is created only at renewal or yearly inside long policy periods.
+     * @type {CommissionCreationRenewalConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'renewal'?: CommissionCreationRenewalConfigDto;
+    /**
+     * Required when mode is invoice.     Defines how many paid invoices must be counted before commission work is created.
+     * @type {CommissionCreationInvoiceConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'invoice'?: CommissionCreationInvoiceConfigDto;
+}
+export declare const CommissionCreationConfigDtoModeEnum: {
+    readonly Renewal: "renewal";
+    readonly Invoice: "invoice";
+};
+export type CommissionCreationConfigDtoModeEnum = typeof CommissionCreationConfigDtoModeEnum[keyof typeof CommissionCreationConfigDtoModeEnum];

package/dist/models/commission-creation-config-dto.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionCreationConfigDtoModeEnum = void 0;
+exports.CommissionCreationConfigDtoModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+};

package/dist/models/commission-creation-invoice-config-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CommissionCreationInvoiceConfigClass
+ */
+export interface CommissionCreationInvoiceConfigClass {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigClass
+     */
+    'paidInvoiceInterval': number;
+}

package/dist/models/commission-creation-invoice-config-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/commission-creation-invoice-config-dto.d.ts

@@ -0,0 +1,24 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CommissionCreationInvoiceConfigDto
+ */
+export interface CommissionCreationInvoiceConfigDto {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigDto
+     */
+    'paidInvoiceInterval': number;
+}

package/dist/models/commission-creation-invoice-config-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/commission-creation-renewal-config-class.d.ts

@@ -0,0 +1,29 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CommissionCreationRenewalConfigClass
+ */
+export interface CommissionCreationRenewalConfigClass {
+    /**
+     * Renewal mode frequency.      Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigClass
+     */
+    'frequency': CommissionCreationRenewalConfigClassFrequencyEnum;
+}
+export declare const CommissionCreationRenewalConfigClassFrequencyEnum: {
+    readonly Renewal: "renewal";
+    readonly Yearly: "yearly";
+};
+export type CommissionCreationRenewalConfigClassFrequencyEnum = typeof CommissionCreationRenewalConfigClassFrequencyEnum[keyof typeof CommissionCreationRenewalConfigClassFrequencyEnum];

package/dist/models/commission-creation-renewal-config-class.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionCreationRenewalConfigClassFrequencyEnum = void 0;
+exports.CommissionCreationRenewalConfigClassFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+};

package/dist/models/commission-creation-renewal-config-dto.d.ts

@@ -0,0 +1,29 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CommissionCreationRenewalConfigDto
+ */
+export interface CommissionCreationRenewalConfigDto {
+    /**
+     * Renewal mode frequency.      Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigDto
+     */
+    'frequency': CommissionCreationRenewalConfigDtoFrequencyEnum;
+}
+export declare const CommissionCreationRenewalConfigDtoFrequencyEnum: {
+    readonly Renewal: "renewal";
+    readonly Yearly: "yearly";
+};
+export type CommissionCreationRenewalConfigDtoFrequencyEnum = typeof CommissionCreationRenewalConfigDtoFrequencyEnum[keyof typeof CommissionCreationRenewalConfigDtoFrequencyEnum];

package/dist/models/commission-creation-renewal-config-dto.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionCreationRenewalConfigDtoFrequencyEnum = void 0;
+exports.CommissionCreationRenewalConfigDtoFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+};

package/dist/models/commission-estimate-class.d.ts

@@ -34,7 +34,7 @@ export interface CommissionEstimateClass {
      */
     'amount': number;
     /**
-     * Type of commission. Valid values: sales, maintenance, other
+     * Type of commission. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof CommissionEstimateClass
      */
@@ -50,6 +50,7 @@ export declare const CommissionEstimateClassTypeEnum: {
     readonly Sales: "sales";
     readonly Maintenance: "maintenance";
     readonly Other: "other";
+    readonly Clawback: "clawback";
 };
 export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
 export declare const CommissionEstimateClassGroupEnum: {

package/dist/models/commission-estimate-class.js

@@ -17,7 +17,8 @@ exports.CommissionEstimateClassGroupEnum = exports.CommissionEstimateClassTypeEn
 exports.CommissionEstimateClassTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 };
 exports.CommissionEstimateClassGroupEnum = {
     FirstYear: 'firstYear',