@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.1-beta.21

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];
+
+

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-estimate-class.ts

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

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

@@ -0,0 +1,117 @@
+/* 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;
+    /**
+     * Current paid invoice entry status
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'status': CommissionPaidInvoiceEntryClassStatusEnum;
+    /**
+     * 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',
+    Discarded: 'discarded'
+} as const;
+
+export type CommissionPaidInvoiceEntryClassStatusEnum = typeof CommissionPaidInvoiceEntryClassStatusEnum[keyof typeof CommissionPaidInvoiceEntryClassStatusEnum];
+
+

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

@@ -14,6 +14,7 @@
 
 
 import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -75,6 +76,12 @@ export interface CreateCommissionAgreementRequestDto {
      * @memberof CreateCommissionAgreementRequestDto
      */
     'settlementCreationDate'?: string;
+    /**
+     * Initial version agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 
 export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {

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

@@ -13,6 +13,7 @@
  */
 
 
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -50,5 +51,11 @@ export interface CreateCommissionAgreementVersionRequestDto {
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
     'versionDescription'?: string;
+    /**
+     * Version-scoped agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 

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

@@ -39,7 +39,7 @@ export interface CreateCommissionCandidateRequestDto {
      */
     'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
     /**
-     * The type of commission. Valid values: sales, maintenance, other
+     * The type of commission. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof CreateCommissionCandidateRequestDto
      */
@@ -51,11 +51,23 @@ export interface CreateCommissionCandidateRequestDto {
      */
     'commissionCode'?: string;
     /**
-     * The date of the next policy renewal for this commission candidate
+     * The date of the next policy renewal for this commission candidate. Required when renewal clawback metadata is provided.
      * @type {string}
      * @memberof CreateCommissionCandidateRequestDto
      */
     'policyRenewalDate'?: string;
+    /**
+     * Exclusive end of the commission period. If provided, policyRenewalDate and expectedInvoiceEntryCount must also be provided.
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period. If provided, policyRenewalDate and commissionPeriodTo must also be provided.
+     * @type {number}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'expectedInvoiceEntryCount'?: number;
 }
 
 export const CreateCommissionCandidateRequestDtoCandidateTypeEnum = {
@@ -67,7 +79,8 @@ export type CreateCommissionCandidateRequestDtoCandidateTypeEnum = typeof Create
 export const CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];

package/models/create-commission-clawback-request-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 CreateCommissionClawbackRequestDto
+ */
+export interface CreateCommissionClawbackRequestDto {
+    /**
+     * Optional business effective date for the clawback calculation. If omitted, server processing time is used.
+     * @type {string}
+     * @memberof CreateCommissionClawbackRequestDto
+     */
+    'effectiveDate'?: string;
+}
+

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,15 +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-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 {
+    /**
+     * The list of commission paid invoice entriess.
+     * @type {Array<CommissionPaidInvoiceEntryClass>}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'items': Array<CommissionPaidInvoiceEntryClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'totalItems': number;
+}
+

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;
+}
+