@emilgroup/commission-sdk 2.10.1-beta.5 → 2.10.1-beta.50

package/dist/models/list-commission-paid-invoice-entries-response-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 { CommissionPaidInvoiceEntryClass } from './commission-paid-invoice-entry-class';
+/**
+ *
+ * @export
+ * @interface ListCommissionPaidInvoiceEntriesResponseClass
+ */
+export interface ListCommissionPaidInvoiceEntriesResponseClass {
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of commission paid invoice entriess.
+     * @type {Array<CommissionPaidInvoiceEntryClass>}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'items': Array<CommissionPaidInvoiceEntryClass>;
+}

package/dist/models/list-commission-paid-invoice-entries-response-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/list-scheduled-commission-clawback-triggers-response-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 { ScheduledCommissionClawbackTriggerClass } from './scheduled-commission-clawback-trigger-class';
+/**
+ *
+ * @export
+ * @interface ListScheduledCommissionClawbackTriggersResponseClass
+ */
+export interface ListScheduledCommissionClawbackTriggersResponseClass {
+    /**
+     * The list of scheduled commission clawback triggerss.
+     * @type {Array<ScheduledCommissionClawbackTriggerClass>}
+     * @memberof ListScheduledCommissionClawbackTriggersResponseClass
+     */
+    'items': Array<ScheduledCommissionClawbackTriggerClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListScheduledCommissionClawbackTriggersResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListScheduledCommissionClawbackTriggersResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListScheduledCommissionClawbackTriggersResponseClass
+     */
+    'totalItems': number;
+}

package/dist/models/list-scheduled-commission-clawback-triggers-response-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/scheduled-commission-clawback-trigger-class.d.ts

@@ -0,0 +1,110 @@
+/**
+ * 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 ScheduledCommissionClawbackTriggerClass
+ */
+export interface ScheduledCommissionClawbackTriggerClass {
+    /**
+     * The unique database identifier of the scheduled trigger
+     * @type {number}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'code': string;
+    /**
+     * The policy this scheduled clawback trigger belongs to
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'policyCode': string;
+    /**
+     * The automatic clawback trigger type
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'triggerType': ScheduledCommissionClawbackTriggerClassTriggerTypeEnum;
+    /**
+     * The effective date when the scheduled clawback trigger becomes due
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'effectiveDate': string;
+    /**
+     * The current scheduled trigger status
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'status': ScheduledCommissionClawbackTriggerClassStatusEnum;
+    /**
+     * The time when the due job queued this trigger for processing
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'queuedAt'?: string;
+    /**
+     * Failure reason when processing this scheduled trigger failed
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'errorMessage'?: string;
+    /**
+     * The time when this scheduled trigger was canceled
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'canceledAt'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof ScheduledCommissionClawbackTriggerClass
+     */
+    'updatedBy': string;
+}
+export declare const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum: {
+    readonly PolicyTermination: "policy_termination";
+    readonly PolicyWithdrawal: "policy_withdrawal";
+    readonly IntermediarySwitched: "intermediary_switched";
+    readonly InvoiceReopened: "invoice_reopened";
+};
+export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
+export declare const ScheduledCommissionClawbackTriggerClassStatusEnum: {
+    readonly Scheduled: "scheduled";
+    readonly Queued: "queued";
+    readonly Canceled: "canceled";
+    readonly Failed: "failed";
+};
+export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];

package/dist/models/scheduled-commission-clawback-trigger-class.js

@@ -0,0 +1,28 @@
+"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.ScheduledCommissionClawbackTriggerClassStatusEnum = exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = void 0;
+exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
+    PolicyTermination: 'policy_termination',
+    PolicyWithdrawal: 'policy_withdrawal',
+    IntermediarySwitched: 'intermediary_switched',
+    InvoiceReopened: 'invoice_reopened'
+};
+exports.ScheduledCommissionClawbackTriggerClassStatusEnum = {
+    Scheduled: 'scheduled',
+    Queued: 'queued',
+    Canceled: 'canceled',
+    Failed: 'failed'
+};

package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 TriggerCommissionSettlementCreationRequestDto
+ */
+export interface TriggerCommissionSettlementCreationRequestDto {
+    /**
+     * 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.
+     * @type {string}
+     * @memberof TriggerCommissionSettlementCreationRequestDto
+     */
+    'executionDate'?: string;
+    /**
+     * When true, validates and logs what would be processed without creating settlements.
+     * @type {boolean}
+     * @memberof TriggerCommissionSettlementCreationRequestDto
+     */
+    'dryRun'?: boolean;
+}

package/dist/models/trigger-commission-settlement-creation-request-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/trigger-commission-settlement-creation-response-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 TriggerCommissionSettlementCreationResponseClass
+ */
+export interface TriggerCommissionSettlementCreationResponseClass {
+    /**
+     * Indicates that the commission settlement creation job was triggered.
+     * @type {boolean}
+     * @memberof TriggerCommissionSettlementCreationResponseClass
+     */
+    'success': boolean;
+}

package/dist/models/trigger-commission-settlement-creation-response-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/trigger-due-commission-clawbacks-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 TriggerDueCommissionClawbacksRequestDto
+ */
+export interface TriggerDueCommissionClawbacksRequestDto {
+    /**
+     * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used. Future dates are only allowed when dryRun is true.
+     * @type {string}
+     * @memberof TriggerDueCommissionClawbacksRequestDto
+     */
+    'processingDate'?: string;
+    /**
+     * When true, due triggers are counted but not enqueued or marked queued.
+     * @type {boolean}
+     * @memberof TriggerDueCommissionClawbacksRequestDto
+     */
+    'dryRun'?: boolean;
+}

package/dist/models/trigger-due-commission-clawbacks-request-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/trigger-due-commission-clawbacks-response-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 TriggerDueCommissionClawbacksResponseClass
+ */
+export interface TriggerDueCommissionClawbacksResponseClass {
+    /**
+     * Whether due scheduled clawback trigger processing completed.
+     * @type {boolean}
+     * @memberof TriggerDueCommissionClawbacksResponseClass
+     */
+    'success': boolean;
+}

package/dist/models/trigger-due-commission-clawbacks-response-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/update-commission-candidate-request-dto.d.ts

@@ -40,7 +40,7 @@ export interface UpdateCommissionCandidateRequestDto {
      */
     'status'?: UpdateCommissionCandidateRequestDtoStatusEnum;
     /**
-     * The type of commission. Valid values: sales, maintenance, other
+     * The type of commission. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof UpdateCommissionCandidateRequestDto
      */
@@ -67,5 +67,6 @@ export declare const UpdateCommissionCandidateRequestDtoCommissionTypeEnum: {
     readonly Sales: "sales";
     readonly Maintenance: "maintenance";
     readonly Other: "other";
+    readonly Clawback: "clawback";
 };
 export type UpdateCommissionCandidateRequestDtoCommissionTypeEnum = typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum];

package/dist/models/update-commission-candidate-request-dto.js

@@ -21,5 +21,6 @@ exports.UpdateCommissionCandidateRequestDtoStatusEnum = {
 exports.UpdateCommissionCandidateRequestDtoCommissionTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 };

package/models/clawback-config-class.ts

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClawbackConfigClass
+ */
+export interface ClawbackConfigClass {
+    /**
+     * Allow manual commission clawback creation.
+     * @type {boolean}
+     * @memberof ClawbackConfigClass
+     */
+    'manual': boolean;
+    /**
+     * Allow automatic commission clawback creation for policy termination and withdrawal.
+     * @type {boolean}
+     * @memberof ClawbackConfigClass
+     */
+    'policyCancellation': boolean;
+    /**
+     * Allow automatic commission clawback creation for intermediary switches.
+     * @type {boolean}
+     * @memberof ClawbackConfigClass
+     */
+    'intermediarySwitched': boolean;
+    /**
+     * Allow automatic commission clawback creation for reopened invoices.
+     * @type {boolean}
+     * @memberof ClawbackConfigClass
+     */
+    'invoiceReopened': boolean;
+}
+

package/models/clawback-config-dto.ts

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClawbackConfigDto
+ */
+export interface ClawbackConfigDto {
+    /**
+     * Allow manual commission clawback creation.
+     * @type {boolean}
+     * @memberof ClawbackConfigDto
+     */
+    'manual': boolean;
+    /**
+     * Allow automatic commission clawback creation for policy termination and withdrawal.
+     * @type {boolean}
+     * @memberof ClawbackConfigDto
+     */
+    'policyCancellation': boolean;
+    /**
+     * Allow automatic commission clawback creation for intermediary switches.
+     * @type {boolean}
+     * @memberof ClawbackConfigDto
+     */
+    'intermediarySwitched': boolean;
+    /**
+     * Allow automatic commission clawback creation for reopened invoices.
+     * @type {boolean}
+     * @memberof ClawbackConfigDto
+     */
+    'invoiceReopened': boolean;
+}
+

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

@@ -15,6 +15,7 @@
 
 import { CommissionAgreementClass } from './commission-agreement-class';
 import { CommissionAgreementProductClass } from './commission-agreement-product-class';
+import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
 
 /**
  * 
@@ -58,6 +59,18 @@ export interface CommissionAgreementVersionClass {
      * @memberof CommissionAgreementVersionClass
      */
     'endDate'?: string;
+    /**
+     * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
+     * @type {string}
+     * @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/models/commission-agreement-version-config-class.ts

@@ -0,0 +1,38 @@
+/* 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.
+ */
+
+
+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/models/commission-agreement-version-config-dto.ts

@@ -0,0 +1,38 @@
+/* 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.
+ */
+
+
+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;
+}
+