@emilgroup/commission-sdk-node 2.9.1-beta.8 → 2.9.1-beta.80

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

@@ -38,5 +38,11 @@ export interface ClawbackConfigClass {
      * @memberof ClawbackConfigClass
      */
     'intermediarySwitched': boolean;
+    /**
+     * Allow automatic commission clawback creation for reopened invoices.
+     * @type {boolean}
+     * @memberof ClawbackConfigClass
+     */
+    'invoiceReopened': boolean;
 }
 

package/models/clawback-config-dto.ts

@@ -38,5 +38,11 @@ export interface ClawbackConfigDto {
      * @memberof ClawbackConfigDto
      */
     '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 { ClawbackConfigClass } from './clawback-config-class';
 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 {ClawbackConfigClass}
+     * Version-scoped agreement configuration.
+     * @type {CommissionAgreementVersionConfigClass}
      * @memberof CommissionAgreementVersionClass
      */
-    'clawbackConfig': ClawbackConfigClass;
+    '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;
+}
+

package/models/commission-class.ts

@@ -64,6 +64,12 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'commissionAgreementNumber': string;
+    /**
+     * The code of the commission agreement being used for this commission, stable across all of the agreement\'s versions
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionAgreementCode': string;
     /**
      * The unique code or identifier of the partner associated with this commission
      * @type {string}
@@ -112,12 +118,6 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'settlementCode'?: string;
-    /**
-     * The source invoice code for invoice-driven commissions
-     * @type {string}
-     * @memberof CommissionClass
-     */
-    'invoiceCode'?: string;
     /**
      * Start of the period the commission was originally created for
      * @type {string}
@@ -148,6 +148,12 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'clawbackTriggerType'?: CommissionClassClawbackTriggerTypeEnum;
+    /**
+     * Whether the commission was created manually through the REST API rather than by the system. Manual commissions are clawed back in full, system commissions are clawed back using pro rata
+     * @type {boolean}
+     * @memberof CommissionClass
+     */
+    'manual': boolean;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -184,7 +190,8 @@ export const CommissionClassClawbackTriggerTypeEnum = {
     Manual: 'manual',
     PolicyTermination: 'policy_termination',
     PolicyWithdrawal: 'policy_withdrawal',
-    IntermediarySwitched: 'intermediary_switched'
+    IntermediarySwitched: 'intermediary_switched',
+    InvoiceReopened: 'invoice_reopened'
 } as const;
 
 export type CommissionClassClawbackTriggerTypeEnum = typeof CommissionClassClawbackTriggerTypeEnum[keyof typeof CommissionClassClawbackTriggerTypeEnum];

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

@@ -0,0 +1,52 @@
+/* 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 { 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 const CommissionCreationConfigClassModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+} as const;
+
+export type CommissionCreationConfigClassModeEnum = typeof CommissionCreationConfigClassModeEnum[keyof typeof CommissionCreationConfigClassModeEnum];
+
+

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

@@ -0,0 +1,52 @@
+/* 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 { 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 const CommissionCreationConfigDtoModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+} as const;
+
+export type CommissionCreationConfigDtoModeEnum = typeof CommissionCreationConfigDtoModeEnum[keyof typeof CommissionCreationConfigDtoModeEnum];
+
+

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

@@ -0,0 +1,30 @@
+/* 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 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/models/commission-creation-invoice-config-dto.ts

@@ -0,0 +1,30 @@
+/* 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 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/models/commission-creation-renewal-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.
+ */
+
+
+
+/**
+ * 
+ * @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 const CommissionCreationRenewalConfigClassFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionCreationRenewalConfigClassFrequencyEnum = typeof CommissionCreationRenewalConfigClassFrequencyEnum[keyof typeof CommissionCreationRenewalConfigClassFrequencyEnum];
+
+