@emilgroup/commission-sdk-node 1.0.0-beta.3 → 1.0.0-beta.30

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { CommissionAgreementClass } from './commission-agreement-class';
+import { CommissionAgreementProductClass } from './commission-agreement-product-class';
 /**
  *
  * @export
@@ -28,6 +29,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/dist/models/commission-class.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CommissionAgreementClass } from './commission-agreement-class';
 import { CommissionItemClass } from './commission-item-class';
 /**
  *
@@ -23,11 +24,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}
@@ -40,6 +41,12 @@ 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}
@@ -58,6 +65,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}
@@ -65,11 +84,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/dist/models/commission-conditions-dto.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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/dist/models/commission-conditions-dto.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/dist/models/commission-config-dto.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 declare const CommissionConfigDtoTypeEnum: {
+    readonly Sales: "sales";
+    readonly Maintenance: "maintenance";
+    readonly Other: "other";
+};
+export type CommissionConfigDtoTypeEnum = typeof CommissionConfigDtoTypeEnum[keyof typeof CommissionConfigDtoTypeEnum];
+export declare const CommissionConfigDtoCurrencyEnum: {
+    readonly Eur: "EUR";
+    readonly Usd: "USD";
+    readonly Gbp: "GBP";
+    readonly Chf: "CHF";
+    readonly Pln: "PLN";
+    readonly Aud: "AUD";
+    readonly Cad: "CAD";
+    readonly Ddk: "DDK";
+    readonly Huf: "HUF";
+    readonly Nok: "NOK";
+    readonly Sek: "SEK";
+};
+export type CommissionConfigDtoCurrencyEnum = typeof CommissionConfigDtoCurrencyEnum[keyof typeof CommissionConfigDtoCurrencyEnum];

package/dist/models/commission-config-dto.js

@@ -0,0 +1,34 @@
+"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.CommissionConfigDtoCurrencyEnum = exports.CommissionConfigDtoTypeEnum = void 0;
+exports.CommissionConfigDtoTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+};
+exports.CommissionConfigDtoCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Chf: 'CHF',
+    Pln: 'PLN',
+    Aud: 'AUD',
+    Cad: 'CAD',
+    Ddk: 'DDK',
+    Huf: 'HUF',
+    Nok: 'NOK',
+    Sek: 'SEK'
+};

package/dist/models/commission-recipient-class.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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 { CommissionAgreementVersionClass } from './commission-agreement-version-class';
+/**
+ *
+ * @export
+ * @interface CommissionRecipientClass
+ */
+export interface CommissionRecipientClass {
+    /**
+     * Unique identifier for the commission recipient
+     * @type {number}
+     * @memberof CommissionRecipientClass
+     */
+    'id': number;
+    /**
+     * The commission agreement version associated with this commission recipient
+     * @type {CommissionAgreementVersionClass}
+     * @memberof CommissionRecipientClass
+     */
+    'version'?: CommissionAgreementVersionClass;
+    /**
+     * The commission agreement version code associated with this commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'commissionAgreementVersionCode'?: string;
+    /**
+     * Unique code identifier for the commission recipient, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'code': string;
+    /**
+     * Human-readable display name for the commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'displayName': string;
+    /**
+     * The unique code or identifier of the partner associated with this commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'partnerCode': string;
+    /**
+     * Status of the commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'status': CommissionRecipientClassStatusEnum;
+    /**
+     * Timestamp when the commission recipient was created
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'createdAt'?: string;
+    /**
+     * Timestamp when the commission recipient was last updated
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'updatedAt'?: string;
+    /**
+     * User identifier who created the commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'createdBy'?: string;
+    /**
+     * User identifier who last updated the commission recipient
+     * @type {string}
+     * @memberof CommissionRecipientClass
+     */
+    'updatedBy'?: string;
+}
+export declare const CommissionRecipientClassStatusEnum: {
+    readonly Active: "active";
+    readonly Inactive: "inactive";
+};
+export type CommissionRecipientClassStatusEnum = typeof CommissionRecipientClassStatusEnum[keyof typeof CommissionRecipientClassStatusEnum];

package/dist/models/commission-recipient-class.js

@@ -0,0 +1,20 @@
+"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.CommissionRecipientClassStatusEnum = void 0;
+exports.CommissionRecipientClassStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+};

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

@@ -0,0 +1,124 @@
+/**
+ * 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 CommissionSettlementClass
+ */
+export interface CommissionSettlementClass {
+    /**
+     * The unique database identifier of the commission settlement
+     * @type {number}
+     * @memberof CommissionSettlementClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'code': string;
+    /**
+     * The settlement number for this commission settlement
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'settlementNumber': string;
+    /**
+     * The unique code of the partner associated with this settlement
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'partnerCode': string;
+    /**
+     * The partner number associated with this settlement
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'partnerNumber': string;
+    /**
+     * The currency code for this settlement
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'currency': CommissionSettlementClassCurrencyEnum;
+    /**
+     * The total amount of the settlement in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CommissionSettlementClass
+     */
+    'amount': number;
+    /**
+     * The status of the commission settlement. Valid values: draft, processing, published, closed
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'status': CommissionSettlementClassStatusEnum;
+    /**
+     * Array of commissions included in this settlement
+     * @type {Array<CommissionClass>}
+     * @memberof CommissionSettlementClass
+     */
+    'commissions': Array<CommissionClass>;
+    /**
+     * The number of policies included in this settlement
+     * @type {number}
+     * @memberof CommissionSettlementClass
+     */
+    'policyCount': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionSettlementClass
+     */
+    'updatedBy': string;
+}
+export declare const CommissionSettlementClassCurrencyEnum: {
+    readonly Eur: "EUR";
+    readonly Usd: "USD";
+    readonly Gbp: "GBP";
+    readonly Chf: "CHF";
+    readonly Pln: "PLN";
+    readonly Aud: "AUD";
+    readonly Cad: "CAD";
+    readonly Ddk: "DDK";
+    readonly Huf: "HUF";
+    readonly Nok: "NOK";
+    readonly Sek: "SEK";
+};
+export type CommissionSettlementClassCurrencyEnum = typeof CommissionSettlementClassCurrencyEnum[keyof typeof CommissionSettlementClassCurrencyEnum];
+export declare const CommissionSettlementClassStatusEnum: {
+    readonly Draft: "draft";
+    readonly Processing: "processing";
+    readonly Published: "published";
+    readonly Closed: "closed";
+};
+export type CommissionSettlementClassStatusEnum = typeof CommissionSettlementClassStatusEnum[keyof typeof CommissionSettlementClassStatusEnum];

package/dist/models/commission-settlement-class.js

@@ -0,0 +1,35 @@
+"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.CommissionSettlementClassStatusEnum = exports.CommissionSettlementClassCurrencyEnum = void 0;
+exports.CommissionSettlementClassCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Chf: 'CHF',
+    Pln: 'PLN',
+    Aud: 'AUD',
+    Cad: 'CAD',
+    Ddk: 'DDK',
+    Huf: 'HUF',
+    Nok: 'NOK',
+    Sek: 'SEK'
+};
+exports.CommissionSettlementClassStatusEnum = {
+    Draft: 'draft',
+    Processing: 'processing',
+    Published: 'published',
+    Closed: 'closed'
+};

package/dist/models/create-commission-agreement-product-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 CreateCommissionAgreementProductRequestDto
+ */
+export interface CreateCommissionAgreementProductRequestDto {
+    /**
+     * Code of the parent commission agreement version to create a product for
+     * @type {string}
+     * @memberof CreateCommissionAgreementProductRequestDto
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Product slug identifier
+     * @type {string}
+     * @memberof CreateCommissionAgreementProductRequestDto
+     */
+    'productSlug': string;
+}

package/dist/models/create-commission-agreement-product-request-dto.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/dist/models/create-commission-agreement-product-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 { CommissionAgreementProductClass } from './commission-agreement-product-class';
+/**
+ *
+ * @export
+ * @interface CreateCommissionAgreementProductResponseClass
+ */
+export interface CreateCommissionAgreementProductResponseClass {
+    /**
+     * The created commission agreement product object
+     * @type {CommissionAgreementProductClass}
+     * @memberof CreateCommissionAgreementProductResponseClass
+     */
+    'product'?: CommissionAgreementProductClass;
+}

package/dist/models/create-commission-agreement-product-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/dist/models/create-commission-agreement-request-dto.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
 /**
  *
  * @export
@@ -39,6 +40,12 @@ export interface CreateCommissionAgreementRequestDto {
      * @memberof CreateCommissionAgreementRequestDto
      */
     'productSlugs': Array<string>;
+    /**
+     * Metadata associated with the commission agreement
+     * @type {CommissionAgreementMetadataDto}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'metadata': CommissionAgreementMetadataDto;
     /**
      * Detailed description of the commission agreement terms and conditions
      * @type {string}
@@ -50,7 +57,7 @@ export interface CreateCommissionAgreementRequestDto {
      * @type {string}
      * @memberof CreateCommissionAgreementRequestDto
      */
-    'startDate'?: string;
+    'startDate': string;
     /**
      * End date when the commission agreement expires or is terminated
      * @type {string}

package/dist/models/create-commission-agreement-rule-request-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { CommissionAgreementRuleConfigDto } from './commission-agreement-rule-config-dto';
+/**
+ *
+ * @export
+ * @interface CreateCommissionAgreementRuleRequestDto
+ */
+export interface CreateCommissionAgreementRuleRequestDto {
+    /**
+     * Code of the parent commission agreement version to create a rule for
+     * @type {string}
+     * @memberof CreateCommissionAgreementRuleRequestDto
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Configuration object for the commission agreement rule
+     * @type {CommissionAgreementRuleConfigDto}
+     * @memberof CreateCommissionAgreementRuleRequestDto
+     */
+    'config': CommissionAgreementRuleConfigDto;
+}

package/dist/models/create-commission-agreement-rule-request-dto.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 });