@emilgroup/commission-sdk-node 1.0.0-beta.9 → 2.1.0

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

@@ -0,0 +1,22 @@
+"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.UpdateCommissionSettlementRequestDtoStatusEnum = void 0;
+exports.UpdateCommissionSettlementRequestDtoStatusEnum = {
+    Draft: 'draft',
+    Processing: 'processing',
+    Published: 'published',
+    Closed: 'closed'
+};

package/dist/models/update-commission-settlement-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { CommissionSettlementClass } from './commission-settlement-class';
+/**
+ *
+ * @export
+ * @interface UpdateCommissionSettlementResponseClass
+ */
+export interface UpdateCommissionSettlementResponseClass {
+    /**
+     * The commission settlement that was updated
+     * @type {CommissionSettlementClass}
+     * @memberof UpdateCommissionSettlementResponseClass
+     */
+    'commissionSettlement'?: CommissionSettlementClass;
+}

package/dist/models/update-commission-settlement-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/models/commission-agreement-class.ts

@@ -13,6 +13,8 @@
  */
 
 
+import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
 
 /**
  * 
@@ -39,11 +41,23 @@ export interface CommissionAgreementClass {
      */
     'code': string;
     /**
-     * Current status of the commission agreement (e.g., active, inactive)
+     * Unique number identifier for the commission agreement
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'commissionAgreementNumber': string;
+    /**
+     * Current status of the commission agreement (e.g., draft, active, processing, archived)
      * @type {string}
      * @memberof CommissionAgreementClass
      */
     'status': CommissionAgreementClassStatusEnum;
+    /**
+     * Array of commission agreement versions
+     * @type {Array<CommissionAgreementVersionClass>}
+     * @memberof CommissionAgreementClass
+     */
+    'versions'?: Array<CommissionAgreementVersionClass>;
     /**
      * Detailed description of the commission agreement terms and conditions
      * @type {string}
@@ -51,11 +65,17 @@ export interface CommissionAgreementClass {
      */
     'description'?: string;
     /**
-     * Frequency at which commissions are billed (e.g., monthly, quarterly, yearly)
+     * Frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
      * @type {string}
      * @memberof CommissionAgreementClass
      */
     'billingFrequency'?: CommissionAgreementClassBillingFrequencyEnum;
+    /**
+     * Metadata associated with the commission agreement
+     * @type {CommissionAgreementMetadataDto}
+     * @memberof CommissionAgreementClass
+     */
+    'metadata'?: CommissionAgreementMetadataDto;
     /**
      * Timestamp when the commission agreement was created
      * @type {string}
@@ -83,14 +103,18 @@ export interface CommissionAgreementClass {
 }
 
 export const CommissionAgreementClassStatusEnum = {
+    Draft: 'draft',
     Active: 'active',
-    Inactive: 'inactive'
+    Processing: 'processing',
+    Archived: 'archived'
 } as const;
 
 export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
 export const CommissionAgreementClassBillingFrequencyEnum = {
+    Immediately: 'immediately',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
+    HalfYearly: 'halfYearly',
     Yearly: 'yearly'
 } as const;
 

package/models/commission-agreement-metadata-dto.ts

@@ -0,0 +1,31 @@
+/* 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 { CommissionAgreementMetadataPartnerDto } from './commission-agreement-metadata-partner-dto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementMetadataDto
+ */
+export interface CommissionAgreementMetadataDto {
+    /**
+     * Main partner of the commission agreement
+     * @type {CommissionAgreementMetadataPartnerDto}
+     * @memberof CommissionAgreementMetadataDto
+     */
+    'mainPartner'?: CommissionAgreementMetadataPartnerDto;
+}
+

package/models/commission-agreement-metadata-partner-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 CommissionAgreementMetadataPartnerDto
+ */
+export interface CommissionAgreementMetadataPartnerDto {
+    /**
+     * Code of the partner
+     * @type {string}
+     * @memberof CommissionAgreementMetadataPartnerDto
+     */
+    'code': string;
+    /**
+     * Name of the partner
+     * @type {string}
+     * @memberof CommissionAgreementMetadataPartnerDto
+     */
+    'name': string;
+}
+

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

@@ -13,7 +13,6 @@
  */
 
 
-import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
 
 /**
  * 
@@ -27,12 +26,6 @@ export interface CommissionAgreementProductClass {
      * @memberof CommissionAgreementProductClass
      */
     'id': number;
-    /**
-     * The parent commission agreement version
-     * @type {CommissionAgreementVersionClass}
-     * @memberof CommissionAgreementProductClass
-     */
-    'version': CommissionAgreementVersionClass;
     /**
      * Product slug identifier
      * @type {string}
@@ -45,6 +38,12 @@ export interface CommissionAgreementProductClass {
      * @memberof CommissionAgreementProductClass
      */
     'code': string;
+    /**
+     * The parent commission agreement version code
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'commissionAgreementVersionCode': string;
     /**
      * Status of the commission agreement product
      * @type {string}

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

@@ -0,0 +1,108 @@
+/* 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 { CommissionAgreementProductClass } from './commission-agreement-product-class';
+import { CommissionAgreementRuleConfigDto } from './commission-agreement-rule-config-dto';
+import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementRuleClass
+ */
+export interface CommissionAgreementRuleClass {
+    /**
+     * Unique identifier for the commission agreement rule
+     * @type {number}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'id': number;
+    /**
+     * The parent commission agreement version
+     * @type {CommissionAgreementVersionClass}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'version': CommissionAgreementVersionClass;
+    /**
+     * Unique code identifier for the commission agreement rule, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'code': string;
+    /**
+     * Configuration object for the commission agreement rule
+     * @type {CommissionAgreementRuleConfigDto}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'config': CommissionAgreementRuleConfigDto;
+    /**
+     * Status of the commission agreement rule (e.g., active, inactive, draft)
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'status': CommissionAgreementRuleClassStatusEnum;
+    /**
+     * Code of the commission agreement product to create a rule for
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'commissionAgreementProductCode': string;
+    /**
+     * The commission agreement product
+     * @type {CommissionAgreementProductClass}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'commissionAgreementProduct': CommissionAgreementProductClass;
+    /**
+     * Timestamp when the commission agreement rule was created
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'createdAt'?: string;
+    /**
+     * Timestamp when the commission agreement rule was last updated
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'updatedAt'?: string;
+    /**
+     * User identifier who created the commission agreement rule
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'createdBy'?: string;
+    /**
+     * User identifier who last updated the commission agreement rule
+     * @type {string}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'updatedBy'?: string;
+    /**
+     * Evaluated commission results stored as object. Contains premium amount and evaluated commissions for preview purposes (evaluated with 100 EUR premium).
+     * @type {object}
+     * @memberof CommissionAgreementRuleClass
+     */
+    'evaluatedCommissions'?: object;
+}
+
+export const CommissionAgreementRuleClassStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive',
+    Draft: 'draft'
+} as const;
+
+export type CommissionAgreementRuleClassStatusEnum = typeof CommissionAgreementRuleClassStatusEnum[keyof typeof CommissionAgreementRuleClassStatusEnum];
+
+

package/models/commission-agreement-rule-config-dto.ts

@@ -0,0 +1,31 @@
+/* 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 { CommissionConfigDto } from './commission-config-dto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementRuleConfigDto
+ */
+export interface CommissionAgreementRuleConfigDto {
+    /**
+     * Array of commission calculation rules
+     * @type {Array<CommissionConfigDto>}
+     * @memberof CommissionAgreementRuleConfigDto
+     */
+    'commissions': Array<CommissionConfigDto>;
+}
+

package/models/commission-agreement-rule-evaluation-class.ts

@@ -0,0 +1,37 @@
+/* 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 { EvaluatedCommissionClass } from './evaluated-commission-class';
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementRuleEvaluationClass
+ */
+export interface CommissionAgreementRuleEvaluationClass {
+    /**
+     * Premium amount in cents used for evaluation
+     * @type {number}
+     * @memberof CommissionAgreementRuleEvaluationClass
+     */
+    'premiumAmount': number;
+    /**
+     * Array of evaluated commission results
+     * @type {Array<EvaluatedCommissionClass>}
+     * @memberof CommissionAgreementRuleEvaluationClass
+     */
+    'commissions': Array<EvaluatedCommissionClass>;
+}
+

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

@@ -14,6 +14,7 @@
 
 
 import { CommissionAgreementClass } from './commission-agreement-class';
+import { CommissionAgreementProductClass } from './commission-agreement-product-class';
 
 /**
  * 
@@ -33,6 +34,12 @@ export interface CommissionAgreementVersionClass {
      * @memberof CommissionAgreementVersionClass
      */
     'agreement': CommissionAgreementClass;
+    /**
+     * Array of commission agreement products
+     * @type {Array<CommissionAgreementProductClass>}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'products'?: Array<CommissionAgreementProductClass>;
     /**
      * Unique code identifier for the commission agreement version, auto-generated on creation
      * @type {string}

package/models/commission-candidate-class.ts

@@ -0,0 +1,104 @@
+/* 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 CommissionCandidateClass
+ */
+export interface CommissionCandidateClass {
+    /**
+     * The unique database identifier of the commission candidate
+     * @type {number}
+     * @memberof CommissionCandidateClass
+     */
+    'id': number;
+    /**
+     * The unique code identifier of the commission candidate, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'code': string;
+    /**
+     * The code of the policy associated with this commission candidate
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'policyCode': string;
+    /**
+     * The code of the invoice associated with this commission candidate
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'invoiceCode': string;
+    /**
+     * The type of commission candidate. Valid values: initial, recurring
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'candidateType': string;
+    /**
+     * The status of the commission candidate. Valid values: pending, processed
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'status': CommissionCandidateClassStatusEnum;
+    /**
+     * The code of the commission associated with this commission candidate
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'commissionCode'?: string;
+    /**
+     * The policy renewal date, primarily for recurring candidates
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'policyRenewalDate'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'updatedBy': string;
+}
+
+export const CommissionCandidateClassStatusEnum = {
+    Pending: 'pending',
+    Processed: 'processed'
+} as const;
+
+export type CommissionCandidateClassStatusEnum = typeof CommissionCandidateClassStatusEnum[keyof typeof CommissionCandidateClassStatusEnum];
+
+

package/models/commission-class.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { CommissionAgreementClass } from './commission-agreement-class';
 import { CommissionItemClass } from './commission-item-class';
 
 /**
@@ -28,11 +29,11 @@ export interface CommissionClass {
      */
     'id': number;
     /**
-     * The unique code or identifier of the commission agreement this commission is based on
-     * @type {string}
+     * The commission agreement this commission is based on
+     * @type {CommissionAgreementClass}
      * @memberof CommissionClass
      */
-    'commissionAgreementCode': string;
+    'agreement': CommissionAgreementClass;
     /**
      * Unique identifier for the object.
      * @type {string}
@@ -45,12 +46,24 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'description': string;
+    /**
+     * The commission number for this commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionNumber': string;
     /**
      * The version identifier of the commission agreement being used for this commission
-     * @type {number}
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * The number of the commission agreement being used for this commission
+     * @type {string}
      * @memberof CommissionClass
      */
-    'commissionAgreementVersionId': number;
+    'commissionAgreementNumber': string;
     /**
      * The unique code or identifier of the partner associated with this commission
      * @type {string}
@@ -63,6 +76,18 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'policyCode': string;
+    /**
+     * The unique number of the partner associated with this commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'partnerNumber': string;
+    /**
+     * The unique number of the policy associated with this commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'policyNumber': string;
     /**
      * The total monetary amount of the commission in the smallest currency unit (e.g., cents). This is the sum of all commission items
      * @type {number}
@@ -70,11 +95,17 @@ export interface CommissionClass {
      */
     'amount': number;
     /**
-     * The status of the commission. Valid values: pending, settled
+     * The status of the commission. Valid values: draft, open, published, closed
      * @type {string}
      * @memberof CommissionClass
      */
     'status': string;
+    /**
+     * The code of the settlement this commission is associated with
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'settlementCode'?: string;
     /**
      * Time at which the object was created.
      * @type {string}

package/models/commission-conditions-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 CommissionConditionsDto
+ */
+export interface CommissionConditionsDto {
+    /**
+     * If the commission is paid on the first year
+     * @type {boolean}
+     * @memberof CommissionConditionsDto
+     */
+    'paidOnFirstYear'?: boolean;
+}
+