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

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';
 
 /**
  * 
@@ -33,7 +34,7 @@ export interface CreateCommissionAgreementRequestDto {
      */
     'billingFrequency': CreateCommissionAgreementRequestDtoBillingFrequencyEnum;
     /**
-     * Current status of the commission agreement (e.g., active, inactive)
+     * Current status of the commission agreement (e.g., draft, active, processing, archived)
      * @type {string}
      * @memberof CreateCommissionAgreementRequestDto
      */
@@ -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}
@@ -65,15 +72,19 @@ export interface CreateCommissionAgreementRequestDto {
 }
 
 export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
+    Immediately: 'immediately',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
+    HalfYearly: 'halfYearly',
     Yearly: 'yearly'
 } as const;
 
 export type CreateCommissionAgreementRequestDtoBillingFrequencyEnum = typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum[keyof typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum];
 export const CreateCommissionAgreementRequestDtoStatusEnum = {
+    Draft: 'draft',
     Active: 'active',
-    Inactive: 'inactive'
+    Processing: 'processing',
+    Archived: 'archived'
 } as const;
 
 export type CreateCommissionAgreementRequestDtoStatusEnum = typeof CreateCommissionAgreementRequestDtoStatusEnum[keyof typeof CreateCommissionAgreementRequestDtoStatusEnum];

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

@@ -0,0 +1,43 @@
+/* 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;
+    /**
+     * Code of the commission agreement product to create a rule for
+     * @type {string}
+     * @memberof CreateCommissionAgreementRuleRequestDto
+     */
+    'commissionAgreementProductCode': string;
+}
+

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-request-dto.ts

@@ -21,12 +21,6 @@ import { CreateCommissionItemRequestDto } from './create-commission-item-request
  * @interface CreateCommissionRequestDto
  */
 export interface CreateCommissionRequestDto {
-    /**
-     * The unique code or identifier of the commission agreement this commission is based on
-     * @type {string}
-     * @memberof CreateCommissionRequestDto
-     */
-    'commissionAgreementCode': string;
     /**
      * A detailed description explaining what this commission represents and its purpose
      * @type {string}
@@ -34,11 +28,11 @@ export interface CreateCommissionRequestDto {
      */
     'description': string;
     /**
-     * The version identifier of the commission agreement being used for this commission
-     * @type {number}
+     * The code of the commission agreement version being used for this commission
+     * @type {string}
      * @memberof CreateCommissionRequestDto
      */
-    'commissionAgreementVersionId': number;
+    'commissionAgreementVersionCode': string;
     /**
      * The unique code or identifier of the partner associated with this commission
      * @type {string}

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

@@ -0,0 +1,67 @@
+/* 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;
+    /**
+     * The currency of the commission settlement
+     * @type {string}
+     * @memberof CreateCommissionSettlementRequestDto
+     */
+    'currency'?: CreateCommissionSettlementRequestDtoCurrencyEnum;
+}
+
+export const CreateCommissionSettlementRequestDtoStatusEnum = {
+    Draft: 'draft',
+    Processing: 'processing',
+    Published: 'published',
+    Closed: 'closed'
+} as const;
+
+export type CreateCommissionSettlementRequestDtoStatusEnum = typeof CreateCommissionSettlementRequestDtoStatusEnum[keyof typeof CreateCommissionSettlementRequestDtoStatusEnum];
+export const CreateCommissionSettlementRequestDtoCurrencyEnum = {
+    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 CreateCommissionSettlementRequestDtoCurrencyEnum = typeof CreateCommissionSettlementRequestDtoCurrencyEnum[keyof typeof CreateCommissionSettlementRequestDtoCurrencyEnum];
+
+

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

@@ -0,0 +1,79 @@
+/* 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 { CommissionEstimateClass } from './commission-estimate-class';
+
+/**
+ * 
+ * @export
+ * @interface EstimateCommissionsResponseClass
+ */
+export interface EstimateCommissionsResponseClass {
+    /**
+     * The unique code of the policy for which commissions are being estimated
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyCode': string;
+    /**
+     * The unique number of the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyNumber': string;
+    /**
+     * The unique code of the partner associated with the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerCode': string;
+    /**
+     * The unique number of the partner
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerNumber': string;
+    /**
+     * The total estimated commission amount in the smallest currency unit (e.g., cents). This is the sum of all commission estimates
+     * @type {number}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'totalAmount': number;
+    /**
+     * A detailed description explaining the commission estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'description': string;
+    /**
+     * The version identifier of the commission agreement being used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * The code of the commission agreement rule that was used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementRuleCode': string;
+    /**
+     * An array of individual commission estimates that make up the total commission. Each estimate represents a specific commission component with its own amount, type, and group
+     * @type {Array<CommissionEstimateClass>}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissions': Array<CommissionEstimateClass>;
+}
+

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

package/models/evaluate-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 { CommissionAgreementRuleEvaluationClass } from './commission-agreement-rule-evaluation-class';
+
+/**
+ * 
+ * @export
+ * @interface EvaluateCommissionAgreementRuleResponseClass
+ */
+export interface EvaluateCommissionAgreementRuleResponseClass {
+    /**
+     * The evaluation result containing premium amount and evaluated commissions
+     * @type {CommissionAgreementRuleEvaluationClass}
+     * @memberof EvaluateCommissionAgreementRuleResponseClass
+     */
+    'evaluation'?: CommissionAgreementRuleEvaluationClass;
+}
+

package/models/evaluated-commission-class.ts

@@ -0,0 +1,63 @@
+/* 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 EvaluatedCommissionClass
+ */
+export interface EvaluatedCommissionClass {
+    /**
+     * Type of commission (e.g., sales, maintenance, other)
+     * @type {string}
+     * @memberof EvaluatedCommissionClass
+     */
+    'type': EvaluatedCommissionClassTypeEnum;
+    /**
+     * Commission amount in cents
+     * @type {number}
+     * @memberof EvaluatedCommissionClass
+     */
+    'amount': number;
+    /**
+     * The expression that was evaluated
+     * @type {string}
+     * @memberof EvaluatedCommissionClass
+     */
+    'expression': string;
+    /**
+     * Commission group (first year or following years)
+     * @type {string}
+     * @memberof EvaluatedCommissionClass
+     */
+    'group': string;
+    /**
+     * Currency code
+     * @type {string}
+     * @memberof EvaluatedCommissionClass
+     */
+    'currency': string;
+}
+
+export const EvaluatedCommissionClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type EvaluatedCommissionClassTypeEnum = typeof EvaluatedCommissionClassTypeEnum[keyof typeof EvaluatedCommissionClassTypeEnum];
+
+