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

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

@@ -0,0 +1,99 @@
+/* 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 { 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 const CommissionRecipientClassStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+} as const;
+
+export type CommissionRecipientClassStatusEnum = typeof CommissionRecipientClassStatusEnum[keyof typeof CommissionRecipientClassStatusEnum];
+
+

package/models/commission-settlement-class.ts

@@ -0,0 +1,134 @@
+/* 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 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 const CommissionSettlementClassCurrencyEnum = {
+    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 CommissionSettlementClassCurrencyEnum = typeof CommissionSettlementClassCurrencyEnum[keyof typeof CommissionSettlementClassCurrencyEnum];
+export const CommissionSettlementClassStatusEnum = {
+    Draft: 'draft',
+    Processing: 'processing',
+    Published: 'published',
+    Closed: 'closed'
+} as const;
+
+export type CommissionSettlementClassStatusEnum = typeof CommissionSettlementClassStatusEnum[keyof typeof CommissionSettlementClassStatusEnum];
+
+

package/models/create-commission-agreement-product-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 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/models/create-commission-agreement-product-response-class.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 { 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/models/create-commission-agreement-request-dto.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
 
 /**
  * 
@@ -44,6 +45,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}
@@ -55,7 +62,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/models/create-commission-agreement-rule-request-dto.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 { 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/models/create-commission-agreement-rule-response-class.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 { CommissionAgreementRuleClass } from './commission-agreement-rule-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionAgreementRuleResponseClass
+ */
+export interface CreateCommissionAgreementRuleResponseClass {
+    /**
+     * The created commission agreement rule object
+     * @type {CommissionAgreementRuleClass}
+     * @memberof CreateCommissionAgreementRuleResponseClass
+     */
+    'rule'?: CommissionAgreementRuleClass;
+}
+

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

@@ -31,7 +31,7 @@ export interface CreateCommissionAgreementVersionRequestDto {
      * @type {string}
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
-    'startDate'?: string;
+    'startDate': string;
     /**
      * End date when this version of the commission agreement expires
      * @type {string}

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

@@ -0,0 +1,42 @@
+/* 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 CreateCommissionRecipientRequestDto
+ */
+export interface CreateCommissionRecipientRequestDto {
+    /**
+     * The unique code or identifier of the commission agreement version this recipient is associated with
+     * @type {string}
+     * @memberof CreateCommissionRecipientRequestDto
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Human-readable display name for the commission recipient
+     * @type {string}
+     * @memberof CreateCommissionRecipientRequestDto
+     */
+    'displayName': string;
+    /**
+     * The unique code or identifier of the partner associated with this commission recipient
+     * @type {string}
+     * @memberof CreateCommissionRecipientRequestDto
+     */
+    'partnerCode': string;
+}
+

package/models/create-commission-recipient-response-class.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 { CommissionRecipientClass } from './commission-recipient-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionRecipientResponseClass
+ */
+export interface CreateCommissionRecipientResponseClass {
+    /**
+     * The commission recipient that was created
+     * @type {CommissionRecipientClass}
+     * @memberof CreateCommissionRecipientResponseClass
+     */
+    'recipient'?: CommissionRecipientClass;
+}
+

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

@@ -0,0 +1,46 @@
+/* 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 CreateCommissionSettlementRequestDto
+ */
+export interface CreateCommissionSettlementRequestDto {
+    /**
+     * Array of commission codes to include in this settlement
+     * @type {Array<string>}
+     * @memberof CreateCommissionSettlementRequestDto
+     */
+    'commissionCodes': Array<string>;
+    /**
+     * The status of the commission settlement. Valid values: draft, processing, published, closed
+     * @type {string}
+     * @memberof CreateCommissionSettlementRequestDto
+     */
+    'status'?: CreateCommissionSettlementRequestDtoStatusEnum;
+}
+
+export const CreateCommissionSettlementRequestDtoStatusEnum = {
+    Draft: 'draft',
+    Processing: 'processing',
+    Published: 'published',
+    Closed: 'closed'
+} as const;
+
+export type CreateCommissionSettlementRequestDtoStatusEnum = typeof CreateCommissionSettlementRequestDtoStatusEnum[keyof typeof CreateCommissionSettlementRequestDtoStatusEnum];
+
+

package/models/create-commission-settlement-response-class.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 { CommissionSettlementClass } from './commission-settlement-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionSettlementResponseClass
+ */
+export interface CreateCommissionSettlementResponseClass {
+    /**
+     * The commission settlement that was created
+     * @type {CommissionSettlementClass}
+     * @memberof CreateCommissionSettlementResponseClass
+     */
+    'commissionSettlement'?: CommissionSettlementClass;
+}
+

package/models/evaluate-commission-agreement-rule-request-dto.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 { CommissionAgreementRuleConfigDto } from './commission-agreement-rule-config-dto';
+
+/**
+ * 
+ * @export
+ * @interface EvaluateCommissionAgreementRuleRequestDto
+ */
+export interface EvaluateCommissionAgreementRuleRequestDto {
+    /**
+     * Mock data object containing invoice, policy, and other data needed for expression evaluation (e.g., { invoice: { netAmount: 1000 }, policy: { ... } })
+     * @type {object}
+     * @memberof EvaluateCommissionAgreementRuleRequestDto
+     */
+    'data': object;
+    /**
+     * Configuration object for the commission agreement rule
+     * @type {CommissionAgreementRuleConfigDto}
+     * @memberof EvaluateCommissionAgreementRuleRequestDto
+     */
+    'config': CommissionAgreementRuleConfigDto;
+}
+