@emilgroup/commission-sdk-node 1.0.0-beta.4 → 1.0.0-beta.40

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

@@ -0,0 +1,86 @@
+/* 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 CommissionAgreementProductClass
+ */
+export interface CommissionAgreementProductClass {
+    /**
+     * Unique identifier for the commission agreement product
+     * @type {number}
+     * @memberof CommissionAgreementProductClass
+     */
+    'id': number;
+    /**
+     * Product slug identifier
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'productSlug': string;
+    /**
+     * Unique code identifier for the commission agreement product, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'code': string;
+    /**
+     * The parent commission agreement version code
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Status of the commission agreement product
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'status': CommissionAgreementProductClassStatusEnum;
+    /**
+     * Timestamp when the commission agreement product was created
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'createdAt'?: string;
+    /**
+     * Timestamp when the commission agreement product was last updated
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'updatedAt'?: string;
+    /**
+     * User identifier who created the commission agreement product
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'createdBy'?: string;
+    /**
+     * User identifier who last updated the commission agreement product
+     * @type {string}
+     * @memberof CommissionAgreementProductClass
+     */
+    'updatedBy'?: string;
+}
+
+export const CommissionAgreementProductClassStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+} as const;
+
+export type CommissionAgreementProductClassStatusEnum = typeof CommissionAgreementProductClassStatusEnum[keyof typeof CommissionAgreementProductClassStatusEnum];
+
+

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

@@ -0,0 +1,102 @@
+/* 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;
+}
+
+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-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;
+}
+

package/models/commission-config-dto.ts

@@ -0,0 +1,73 @@
+/* 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 { CommissionConditionsDto } from './commission-conditions-dto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionConfigDto
+ */
+export interface CommissionConfigDto {
+    /**
+     * Type of commission (e.g., sales, maintenance, other)
+     * @type {string}
+     * @memberof CommissionConfigDto
+     */
+    'type': CommissionConfigDtoTypeEnum;
+    /**
+     * Mathematical expression to calculate commission (e.g., \'invoice.netAmount * 0.10\'). Always return value in cents.
+     * @type {string}
+     * @memberof CommissionConfigDto
+     */
+    'expression': string;
+    /**
+     * Currency code (e.g., EUR, USD, GBP, CHF, PLN, AUD, CAD, DDK, HUF, NOK, SEK)
+     * @type {string}
+     * @memberof CommissionConfigDto
+     */
+    'currency': CommissionConfigDtoCurrencyEnum;
+    /**
+     * Business rule conditions that determine commission calculation logic beyond the expression (e.g., payment timing, eligibility criteria, special conditions)
+     * @type {CommissionConditionsDto}
+     * @memberof CommissionConfigDto
+     */
+    'conditions'?: CommissionConditionsDto;
+}
+
+export const CommissionConfigDtoTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type CommissionConfigDtoTypeEnum = typeof CommissionConfigDtoTypeEnum[keyof typeof CommissionConfigDtoTypeEnum];
+export const CommissionConfigDtoCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Chf: 'CHF',
+    Pln: 'PLN',
+    Aud: 'AUD',
+    Cad: 'CAD',
+    Ddk: 'DDK',
+    Huf: 'HUF',
+    Nok: 'NOK',
+    Sek: 'SEK'
+} as const;
+
+export type CommissionConfigDtoCurrencyEnum = typeof CommissionConfigDtoCurrencyEnum[keyof typeof CommissionConfigDtoCurrencyEnum];
+
+

package/models/commission-estimate-class.ts

@@ -0,0 +1,69 @@
+/* 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 CommissionEstimateClass
+ */
+export interface CommissionEstimateClass {
+    /**
+     * The name of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'name': string;
+    /**
+     * A detailed description of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'description': string;
+    /**
+     * The estimated commission amount in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CommissionEstimateClass
+     */
+    'amount': number;
+    /**
+     * Type of commission. Valid values: sales, maintenance, other
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'type': CommissionEstimateClassTypeEnum;
+    /**
+     * Commission group indicating whether this is for the first year or following years
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'group': CommissionEstimateClassGroupEnum;
+}
+
+export const CommissionEstimateClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
+export const CommissionEstimateClassGroupEnum = {
+    FirstYear: 'firstYear',
+    FollowingYears: 'followingYears'
+} as const;
+
+export type CommissionEstimateClassGroupEnum = typeof CommissionEstimateClassGroupEnum[keyof typeof CommissionEstimateClassGroupEnum];
+
+