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

package/models/create-commission-clawback-response-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 { CommissionClass } from './commission-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionClawbackResponseClass
+ */
+export interface CreateCommissionClawbackResponseClass {
+    /**
+     * Whether a new clawback commission was created.
+     * @type {boolean}
+     * @memberof CreateCommissionClawbackResponseClass
+     */
+    'created': boolean;
+    /**
+     * Reason why no clawback commission was created. Possible reasons: the original commission was not paid out, the calculated clawback amount was zero or positive, or the commission was already fully clawed back.
+     * @type {string}
+     * @memberof CreateCommissionClawbackResponseClass
+     */
+    'notCreatedReason'?: CreateCommissionClawbackResponseClassNotCreatedReasonEnum;
+    /**
+     * Created clawback commission. Set only when created is true.
+     * @type {CommissionClass}
+     * @memberof CreateCommissionClawbackResponseClass
+     */
+    'commission'?: CommissionClass;
+}
+
+export const CreateCommissionClawbackResponseClassNotCreatedReasonEnum = {
+    CommissionNotPaidOut: 'commission_not_paid_out',
+    ClawbackAmountNotNegative: 'clawback_amount_not_negative',
+    CommissionAlreadyFullyClawedBack: 'commission_already_fully_clawed_back'
+} as const;
+
+export type CreateCommissionClawbackResponseClassNotCreatedReasonEnum = typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum[keyof typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum];
+
+

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

@@ -39,7 +39,7 @@ export interface CreateCommissionItemRequestDto {
      */
     'amount': number;
     /**
-     * The type of commission item. Valid values: sales, maintenance, other
+     * The type of commission item. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof CreateCommissionItemRequestDto
      */
@@ -49,7 +49,8 @@ export interface CreateCommissionItemRequestDto {
 export const CreateCommissionItemRequestDtoTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type CreateCommissionItemRequestDtoTypeEnum = typeof CreateCommissionItemRequestDtoTypeEnum[keyof typeof CreateCommissionItemRequestDtoTypeEnum];

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

@@ -51,5 +51,11 @@ export interface CreateCommissionRequestDto {
      * @memberof CreateCommissionRequestDto
      */
     'items': Array<CreateCommissionItemRequestDto>;
+    /**
+     * Commission candidate code linked to this commission.
+     * @type {string}
+     * @memberof CreateCommissionRequestDto
+     */
+    'commissionCandidateCode'?: string;
 }
 

package/models/evaluated-commission-class.ts

@@ -21,7 +21,7 @@
  */
 export interface EvaluatedCommissionClass {
     /**
-     * Type of commission (e.g., sales, maintenance, other)
+     * Type of commission (e.g., sales, maintenance, other, clawback)
      * @type {string}
      * @memberof EvaluatedCommissionClass
      */
@@ -55,7 +55,8 @@ export interface EvaluatedCommissionClass {
 export const EvaluatedCommissionClassTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type EvaluatedCommissionClassTypeEnum = typeof EvaluatedCommissionClassTypeEnum[keyof typeof EvaluatedCommissionClassTypeEnum];

package/models/index.ts

@@ -1,3 +1,5 @@
+export * from './clawback-config-class';
+export * from './clawback-config-dto';
 export * from './commission-agreement-class';
 export * from './commission-agreement-metadata-dto';
 export * from './commission-agreement-metadata-partner-dto';
@@ -6,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';
@@ -24,6 +35,8 @@ export * from './create-commission-agreement-version-request-dto';
 export * from './create-commission-agreement-version-response-class';
 export * from './create-commission-candidate-request-dto';
 export * from './create-commission-candidate-response-class';
+export * from './create-commission-clawback-request-dto';
+export * from './create-commission-clawback-response-class';
 export * from './create-commission-item-request-dto';
 export * from './create-commission-recipient-for-products-request-dto';
 export * from './create-commission-recipient-for-products-response-class';
@@ -54,13 +67,20 @@ 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';
+export * from './trigger-due-commission-clawbacks-response-class';
 export * from './update-commission-agreement-product-request-dto';
 export * from './update-commission-agreement-product-response-class';
 export * from './update-commission-agreement-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-commission-settlement-creation-request-dto.ts

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

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

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

package/models/update-commission-candidate-request-dto.ts

@@ -45,7 +45,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
      */
@@ -73,7 +73,8 @@ export type UpdateCommissionCandidateRequestDtoStatusEnum = typeof UpdateCommiss
 export const UpdateCommissionCandidateRequestDtoCommissionTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type UpdateCommissionCandidateRequestDtoCommissionTypeEnum = typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof UpdateCommissionCandidateRequestDtoCommissionTypeEnum];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/commission-sdk",
-  "version": "2.10.1-beta.5",
+  "version": "2.10.1-beta.51",
   "description": "OpenAPI client for @emilgroup/commission-sdk",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [