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

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

package/models/commission-recipient-class.ts

@@ -13,7 +13,7 @@
  */
 
 
-import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
+import { CommissionAgreementProductClass } from './commission-agreement-product-class';
 
 /**
  * 
@@ -28,17 +28,17 @@ export interface CommissionRecipientClass {
      */
     'id': number;
     /**
-     * The commission agreement version associated with this commission recipient
-     * @type {CommissionAgreementVersionClass}
+     * The commission agreement product associated with this commission recipient
+     * @type {CommissionAgreementProductClass}
      * @memberof CommissionRecipientClass
      */
-    'version'?: CommissionAgreementVersionClass;
+    'commissionAgreementProduct'?: CommissionAgreementProductClass;
     /**
-     * The commission agreement version code associated with this commission recipient
+     * The commission agreement product code associated with this commission recipient
      * @type {string}
      * @memberof CommissionRecipientClass
      */
-    'commissionAgreementVersionCode'?: string;
+    'commissionAgreementProductCode'?: string;
     /**
      * Unique code identifier for the commission recipient, auto-generated on creation
      * @type {string}

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

@@ -0,0 +1,75 @@
+/* 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 CreateCommissionCandidateRequestDto
+ */
+export interface CreateCommissionCandidateRequestDto {
+    /**
+     * The code of the policy associated with this commission candidate
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'policyCode': string;
+    /**
+     * The code of the invoice associated with this commission candidate
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'invoiceCode': string;
+    /**
+     * The type of commission candidate. Valid values: initial, recurring
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
+    /**
+     * The type of commission. Valid values: sales, maintenance, other
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'commissionType'?: CreateCommissionCandidateRequestDtoCommissionTypeEnum;
+    /**
+     * The code of the commission associated with this commission candidate
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'commissionCode'?: string;
+    /**
+     * The date of the next policy renewal for this commission candidate
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'policyRenewalDate'?: string;
+}
+
+export const CreateCommissionCandidateRequestDtoCandidateTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring'
+} as const;
+
+export type CreateCommissionCandidateRequestDtoCandidateTypeEnum = typeof CreateCommissionCandidateRequestDtoCandidateTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCandidateTypeEnum];
+export const CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];
+
+

package/models/create-commission-candidate-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 { CommissionCandidateClass } from './commission-candidate-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionCandidateResponseClass
+ */
+export interface CreateCommissionCandidateResponseClass {
+    /**
+     * candidate
+     * @type {CommissionCandidateClass}
+     * @memberof CreateCommissionCandidateResponseClass
+     */
+    'candidate'?: CommissionCandidateClass;
+}
+

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

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