@emilgroup/commission-sdk 2.10.1-beta.6 → 2.10.1-beta.61

package/dist/models/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./clawback-config-class"), exports);
 __exportStar(require("./clawback-config-dto"), exports);
 __exportStar(require("./commission-agreement-class"), exports);
 __exportStar(require("./commission-agreement-metadata-dto"), exports);
@@ -23,12 +24,21 @@ __exportStar(require("./commission-agreement-rule-class"), exports);
 __exportStar(require("./commission-agreement-rule-config-dto"), exports);
 __exportStar(require("./commission-agreement-rule-evaluation-class"), exports);
 __exportStar(require("./commission-agreement-version-class"), exports);
+__exportStar(require("./commission-agreement-version-config-class"), exports);
+__exportStar(require("./commission-agreement-version-config-dto"), exports);
 __exportStar(require("./commission-candidate-class"), exports);
 __exportStar(require("./commission-class"), exports);
 __exportStar(require("./commission-conditions-dto"), exports);
 __exportStar(require("./commission-config-dto"), exports);
+__exportStar(require("./commission-creation-config-class"), exports);
+__exportStar(require("./commission-creation-config-dto"), exports);
+__exportStar(require("./commission-creation-invoice-config-class"), exports);
+__exportStar(require("./commission-creation-invoice-config-dto"), exports);
+__exportStar(require("./commission-creation-renewal-config-class"), exports);
+__exportStar(require("./commission-creation-renewal-config-dto"), exports);
 __exportStar(require("./commission-estimate-class"), exports);
 __exportStar(require("./commission-item-class"), exports);
+__exportStar(require("./commission-paid-invoice-entry-class"), exports);
 __exportStar(require("./commission-recipient-class"), exports);
 __exportStar(require("./commission-settlement-class"), exports);
 __exportStar(require("./create-commission-agreement-product-request-dto"), exports);
@@ -73,13 +83,16 @@ __exportStar(require("./list-commission-agreement-rules-response-class"), export
 __exportStar(require("./list-commission-agreement-versions-response-class"), exports);
 __exportStar(require("./list-commission-agreements-response-class"), exports);
 __exportStar(require("./list-commission-candidates-response-class"), exports);
+__exportStar(require("./list-commission-paid-invoice-entries-response-class"), exports);
 __exportStar(require("./list-commission-recipients-response-class"), exports);
 __exportStar(require("./list-commission-settlements-response-class"), exports);
 __exportStar(require("./list-commissions-response-class"), exports);
+__exportStar(require("./list-scheduled-commission-clawback-triggers-response-class"), exports);
 __exportStar(require("./patch-commission-agreement-status-request-dto"), exports);
 __exportStar(require("./patch-commission-agreement-status-response-class"), exports);
 __exportStar(require("./publish-commission-settlements-request-dto"), exports);
 __exportStar(require("./publish-commission-settlements-response-class"), exports);
+__exportStar(require("./scheduled-commission-clawback-trigger-class"), exports);
 __exportStar(require("./trigger-commission-settlement-creation-request-dto"), exports);
 __exportStar(require("./trigger-commission-settlement-creation-response-class"), exports);
 __exportStar(require("./trigger-due-commission-clawbacks-request-dto"), exports);

package/dist/models/list-commission-agreement-versions-response-class.d.ts

@@ -17,27 +17,27 @@ import { CommissionAgreementVersionClass } from './commission-agreement-version-
  */
 export interface ListCommissionAgreementVersionsResponseClass {
     /**
-     * Array of commission agreement version objects
-     * @type {Array<CommissionAgreementVersionClass>}
+     * Next page token.
+     * @type {string}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'items': Array<CommissionAgreementVersionClass>;
+    'nextPageToken': string;
     /**
-     * Token for retrieving the next page of results
-     * @type {string}
+     * Total amount of items.
+     * @type {number}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'nextPageToken': string;
+    'totalItems': number;
     /**
-     * Number of items per page
+     * Items per page.
      * @type {number}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
     'itemsPerPage': number;
     /**
-     * Total number of items
-     * @type {number}
+     * Array of commission agreement version objects
+     * @type {Array<CommissionAgreementVersionClass>}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'totalItems': number;
+    'items': Array<CommissionAgreementVersionClass>;
 }

package/dist/models/list-commission-agreements-response-class.d.ts

@@ -17,27 +17,27 @@ import { CommissionAgreementClass } from './commission-agreement-class';
  */
 export interface ListCommissionAgreementsResponseClass {
     /**
-     * Array of commission agreement objects
-     * @type {Array<CommissionAgreementClass>}
+     * Next page token.
+     * @type {string}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'items': Array<CommissionAgreementClass>;
+    'nextPageToken': string;
     /**
-     * Token for pagination to retrieve the next page of results. Empty string indicates no more pages available
-     * @type {string}
+     * Total amount of items.
+     * @type {number}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'nextPageToken': string;
+    'totalItems': number;
     /**
-     * Number of items per page
+     * Items per page.
      * @type {number}
      * @memberof ListCommissionAgreementsResponseClass
      */
     'itemsPerPage': number;
     /**
-     * Total number of items
-     * @type {number}
+     * Array of commission agreement objects
+     * @type {Array<CommissionAgreementClass>}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'totalItems': number;
+    'items': Array<CommissionAgreementClass>;
 }

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-due-commission-clawbacks-request-dto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface TriggerDueCommissionClawbacksRequestDto {
     /**
-     * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
+     * 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
      */

package/dist/models/update-commission-agreement-request-dto.d.ts

@@ -34,14 +34,14 @@ export interface UpdateCommissionAgreementRequestDto {
      */
     'description'?: string;
     /**
-     * Updated frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
+     * Updated frequency at which commissions are billed (e.g., manual, monthly, quarterly, halfYearly, yearly)
      * @type {string}
      * @memberof UpdateCommissionAgreementRequestDto
      */
     'billingFrequency'?: UpdateCommissionAgreementRequestDtoBillingFrequencyEnum;
 }
 export declare const UpdateCommissionAgreementRequestDtoBillingFrequencyEnum: {
-    readonly Immediately: "immediately";
+    readonly Manual: "manual";
     readonly Monthly: "monthly";
     readonly Quarterly: "quarterly";
     readonly HalfYearly: "halfYearly";

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

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateCommissionAgreementRequestDtoBillingFrequencyEnum = void 0;
 exports.UpdateCommissionAgreementRequestDtoBillingFrequencyEnum = {
-    Immediately: 'immediately',
+    Manual: 'manual',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
     HalfYearly: 'halfYearly',

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

@@ -22,21 +22,27 @@
 export interface ClawbackConfigDto {
     /**
      * Allow manual commission clawback creation.
-     * @type {object}
+     * @type {boolean}
      * @memberof ClawbackConfigDto
      */
-    'manual': object;
+    'manual': boolean;
     /**
      * Allow automatic commission clawback creation for policy termination and withdrawal.
-     * @type {object}
+     * @type {boolean}
      * @memberof ClawbackConfigDto
      */
-    'policyCancellation': object;
+    'policyCancellation': boolean;
     /**
      * Allow automatic commission clawback creation for intermediary switches.
-     * @type {object}
+     * @type {boolean}
      * @memberof ClawbackConfigDto
      */
-    'intermediarySwitched': object;
+    'intermediarySwitched': boolean;
+    /**
+     * Allow automatic commission clawback creation for reopened invoices.
+     * @type {boolean}
+     * @memberof ClawbackConfigDto
+     */
+    'invoiceReopened': boolean;
 }
 

package/models/commission-agreement-class.ts

@@ -65,7 +65,7 @@ export interface CommissionAgreementClass {
      */
     'description'?: string;
     /**
-     * Frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
+     * Frequency at which commissions are billed (e.g., manual, monthly, quarterly, halfYearly, yearly)
      * @type {string}
      * @memberof CommissionAgreementClass
      */
@@ -111,7 +111,7 @@ export const CommissionAgreementClassStatusEnum = {
 
 export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
 export const CommissionAgreementClassBillingFrequencyEnum = {
-    Immediately: 'immediately',
+    Manual: 'manual',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
     HalfYearly: 'halfYearly',

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

@@ -13,9 +13,9 @@
  */
 
 
-import { ClawbackConfigDto } from './clawback-config-dto';
 import { CommissionAgreementClass } from './commission-agreement-class';
 import { CommissionAgreementProductClass } from './commission-agreement-product-class';
+import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
 
 /**
  * 
@@ -66,11 +66,11 @@ export interface CommissionAgreementVersionClass {
      */
     'settlementCreationDate'?: string;
     /**
-     * Version-scoped clawback creation configuration.
-     * @type {ClawbackConfigDto}
+     * Version-scoped agreement configuration.
+     * @type {CommissionAgreementVersionConfigClass}
      * @memberof CommissionAgreementVersionClass
      */
-    'clawbackConfig': ClawbackConfigDto;
+    '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;
+}
+