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

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

package/models/commission-paid-invoice-entry-class.ts

@@ -0,0 +1,124 @@
+/* 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 CommissionPaidInvoiceEntryClass
+ */
+export interface CommissionPaidInvoiceEntryClass {
+    /**
+     * The unique database identifier of the paid invoice entry
+     * @type {number}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'code': string;
+    /**
+     * Policy whose paid invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyCode': string;
+    /**
+     * Paid invoice counted for invoice-mode commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'invoiceCode': string;
+    /**
+     * Commission agreement version used when this invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Start of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceFrom': string;
+    /**
+     * End of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceTo': string;
+    /**
+     * The status of the paid invoice entry. Valid values: counted, consumed, settled_no_commission, discarded
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'status': CommissionPaidInvoiceEntryClassStatusEnum;
+    /**
+     * Whether this entry advances the interval counter. False for a premium correction, which is paid out on its own commission when it is paid.
+     * @type {boolean}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'countsTowardInterval': boolean;
+    /**
+     * Candidate created when this entry was reserved for commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCandidateCode'?: string;
+    /**
+     * Commission created from this counted invoice entry
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCode'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedBy': string;
+}
+
+export const CommissionPaidInvoiceEntryClassStatusEnum = {
+    Counted: 'counted',
+    Consumed: 'consumed',
+    SettledNoCommission: 'settled_no_commission',
+    Discarded: 'discarded'
+} as const;
+
+export type CommissionPaidInvoiceEntryClassStatusEnum = typeof CommissionPaidInvoiceEntryClassStatusEnum[keyof typeof CommissionPaidInvoiceEntryClassStatusEnum];
+
+

package/models/create-commission-agreement-request-dto.ts

@@ -13,8 +13,8 @@
  */
 
 
-import { ClawbackConfigDto } from './clawback-config-dto';
 import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -77,15 +77,15 @@ export interface CreateCommissionAgreementRequestDto {
      */
     'settlementCreationDate'?: string;
     /**
-     * Initial version clawback creation configuration. Missing config defaults to all triggers disabled.
-     * @type {ClawbackConfigDto}
+     * Initial version agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
      * @memberof CreateCommissionAgreementRequestDto
      */
-    'clawbackConfig'?: ClawbackConfigDto;
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 
 export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
-    Immediately: 'immediately',
+    Manual: 'manual',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
     HalfYearly: 'halfYearly',

package/models/create-commission-agreement-version-request-dto.ts

@@ -13,7 +13,7 @@
  */
 
 
-import { ClawbackConfigDto } from './clawback-config-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -52,10 +52,10 @@ export interface CreateCommissionAgreementVersionRequestDto {
      */
     'versionDescription'?: string;
     /**
-     * Version-scoped clawback creation configuration. Missing config defaults to all triggers disabled.
-     * @type {ClawbackConfigDto}
+     * Version-scoped agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
-    'clawbackConfig'?: ClawbackConfigDto;
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 

package/models/index.ts

@@ -8,12 +8,21 @@ export * from './commission-agreement-rule-class';
 export * from './commission-agreement-rule-config-dto';
 export * from './commission-agreement-rule-evaluation-class';
 export * from './commission-agreement-version-class';
+export * from './commission-agreement-version-config-class';
+export * from './commission-agreement-version-config-dto';
 export * from './commission-candidate-class';
 export * from './commission-class';
 export * from './commission-conditions-dto';
 export * from './commission-config-dto';
+export * from './commission-creation-config-class';
+export * from './commission-creation-config-dto';
+export * from './commission-creation-invoice-config-class';
+export * from './commission-creation-invoice-config-dto';
+export * from './commission-creation-renewal-config-class';
+export * from './commission-creation-renewal-config-dto';
 export * from './commission-estimate-class';
 export * from './commission-item-class';
+export * from './commission-paid-invoice-entry-class';
 export * from './commission-recipient-class';
 export * from './commission-settlement-class';
 export * from './create-commission-agreement-product-request-dto';
@@ -58,13 +67,16 @@ export * from './list-commission-agreement-rules-response-class';
 export * from './list-commission-agreement-versions-response-class';
 export * from './list-commission-agreements-response-class';
 export * from './list-commission-candidates-response-class';
+export * from './list-commission-paid-invoice-entries-response-class';
 export * from './list-commission-recipients-response-class';
 export * from './list-commission-settlements-response-class';
 export * from './list-commissions-response-class';
+export * from './list-scheduled-commission-clawback-triggers-response-class';
 export * from './patch-commission-agreement-status-request-dto';
 export * from './patch-commission-agreement-status-response-class';
 export * from './publish-commission-settlements-request-dto';
 export * from './publish-commission-settlements-response-class';
+export * from './scheduled-commission-clawback-trigger-class';
 export * from './trigger-commission-settlement-creation-request-dto';
 export * from './trigger-commission-settlement-creation-response-class';
 export * from './trigger-due-commission-clawbacks-request-dto';

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

@@ -22,28 +22,28 @@ 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/models/list-commission-agreements-response-class.ts

@@ -22,28 +22,28 @@ 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/models/list-commission-paid-invoice-entries-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { 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/models/list-scheduled-commission-clawback-triggers-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { 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/models/scheduled-commission-clawback-trigger-class.ts

@@ -0,0 +1,120 @@
+/* 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 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 const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
+    PolicyTermination: 'policy_termination',
+    PolicyWithdrawal: 'policy_withdrawal',
+    IntermediarySwitched: 'intermediary_switched',
+    InvoiceReopened: 'invoice_reopened'
+} as const;
+
+export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
+export const ScheduledCommissionClawbackTriggerClassStatusEnum = {
+    Scheduled: 'scheduled',
+    Queued: 'queued',
+    Canceled: 'canceled',
+    Failed: 'failed'
+} as const;
+
+export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];
+
+

package/models/trigger-due-commission-clawbacks-request-dto.ts

@@ -21,7 +21,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/models/update-commission-agreement-request-dto.ts

@@ -39,7 +39,7 @@ 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
      */
@@ -47,7 +47,7 @@ export interface UpdateCommissionAgreementRequestDto {
 }
 
 export const UpdateCommissionAgreementRequestDtoBillingFrequencyEnum = {
-    Immediately: 'immediately',
+    Manual: 'manual',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
     HalfYearly: 'halfYearly',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/commission-sdk-node",
-  "version": "2.9.1-beta.8",
+  "version": "2.9.1-beta.80",
   "description": "OpenAPI client for @emilgroup/commission-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [