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

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-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 EstimateCommissionsRequestDto
+ */
+export interface EstimateCommissionsRequestDto {
+    /**
+     * The code of the policy to estimate commissions for
+     * @type {string}
+     * @memberof EstimateCommissionsRequestDto
+     */
+    'policyCode': string;
+    /**
+     * The objects of the policy to estimate commissions for
+     * @type {Array<object>}
+     * @memberof EstimateCommissionsRequestDto
+     */
+    'policyObjects': Array<object>;
+}
+

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

package/models/get-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 GetCommissionAgreementRuleResponseClass
+ */
+export interface GetCommissionAgreementRuleResponseClass {
+    /**
+     * The commission agreement rule object
+     * @type {CommissionAgreementRuleClass}
+     * @memberof GetCommissionAgreementRuleResponseClass
+     */
+    'rule'?: CommissionAgreementRuleClass;
+}
+

package/models/get-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 GetCommissionCandidateResponseClass
+ */
+export interface GetCommissionCandidateResponseClass {
+    /**
+     * candidate
+     * @type {CommissionCandidateClass}
+     * @memberof GetCommissionCandidateResponseClass
+     */
+    'candidate'?: CommissionCandidateClass;
+}
+

package/models/get-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 GetCommissionSettlementResponseClass
+ */
+export interface GetCommissionSettlementResponseClass {
+    /**
+     * The commission settlement that was retrieved
+     * @type {CommissionSettlementClass}
+     * @memberof GetCommissionSettlementResponseClass
+     */
+    'commissionSettlement'?: CommissionSettlementClass;
+}
+

package/models/index.ts

@@ -1,37 +1,74 @@
 export * from './commission-agreement-class';
+export * from './commission-agreement-metadata-dto';
+export * from './commission-agreement-metadata-partner-dto';
 export * from './commission-agreement-product-class';
+export * from './commission-agreement-rule-class';
+export * from './commission-agreement-rule-config-dto';
+export * from './commission-agreement-rule-evaluation-class';
 export * from './commission-agreement-version-class';
+export * from './commission-candidate-class';
 export * from './commission-class';
+export * from './commission-conditions-dto';
+export * from './commission-config-dto';
+export * from './commission-estimate-class';
 export * from './commission-item-class';
 export * from './commission-recipient-class';
+export * from './commission-settlement-class';
 export * from './create-commission-agreement-product-request-dto';
 export * from './create-commission-agreement-product-response-class';
 export * from './create-commission-agreement-request-dto';
 export * from './create-commission-agreement-response-class';
+export * from './create-commission-agreement-rule-request-dto';
+export * from './create-commission-agreement-rule-response-class';
 export * from './create-commission-agreement-version-request-dto';
 export * from './create-commission-agreement-version-response-class';
+export * from './create-commission-candidate-request-dto';
+export * from './create-commission-candidate-response-class';
 export * from './create-commission-item-request-dto';
 export * from './create-commission-recipient-request-dto';
 export * from './create-commission-recipient-response-class';
 export * from './create-commission-request-dto';
 export * from './create-commission-response-class';
+export * from './create-commission-settlement-request-dto';
+export * from './create-commission-settlement-response-class';
+export * from './estimate-commissions-request-dto';
+export * from './estimate-commissions-response-class';
+export * from './evaluate-commission-agreement-rule-request-dto';
+export * from './evaluate-commission-agreement-rule-response-class';
+export * from './evaluated-commission-class';
 export * from './get-commission-agreement-product-response-class';
 export * from './get-commission-agreement-response-class';
+export * from './get-commission-agreement-rule-response-class';
 export * from './get-commission-agreement-version-response-class';
+export * from './get-commission-candidate-response-class';
 export * from './get-commission-recipient-response-class';
 export * from './get-commission-response-class';
+export * from './get-commission-settlement-response-class';
 export * from './inline-response200';
 export * from './inline-response503';
 export * from './list-commission-agreement-products-response-class';
+export * from './list-commission-agreement-rules-response-class';
 export * from './list-commission-agreement-versions-response-class';
 export * from './list-commission-agreements-response-class';
+export * from './list-commission-candidates-response-class';
 export * from './list-commission-recipients-response-class';
+export * from './list-commission-settlements-response-class';
 export * from './list-commissions-response-class';
+export * from './patch-commission-agreement-status-request-dto';
+export * from './patch-commission-agreement-status-response-class';
+export * from './publish-commission-settlements-request-dto';
+export * from './publish-commission-settlements-response-class';
 export * from './update-commission-agreement-product-request-dto';
 export * from './update-commission-agreement-product-response-class';
 export * from './update-commission-agreement-request-dto';
 export * from './update-commission-agreement-response-class';
+export * from './update-commission-agreement-rule-request-dto';
+export * from './update-commission-agreement-rule-response-class';
+export * from './update-commission-candidate-request-dto';
+export * from './update-commission-candidate-response-class';
 export * from './update-commission-recipient-request-dto';
 export * from './update-commission-recipient-response-class';
 export * from './update-commission-request-dto';
 export * from './update-commission-response-class';
+export * from './update-commission-settlement-request-dto';
+export * from './update-commission-settlement-response-class';

package/models/list-commission-agreement-rules-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 ListCommissionAgreementRulesResponseClass
+ */
+export interface ListCommissionAgreementRulesResponseClass {
+    /**
+     * List of commission agreement rules
+     * @type {Array<CommissionAgreementRuleClass>}
+     * @memberof ListCommissionAgreementRulesResponseClass
+     */
+    'items': Array<CommissionAgreementRuleClass>;
+    /**
+     * Token for next page
+     * @type {string}
+     * @memberof ListCommissionAgreementRulesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof ListCommissionAgreementRulesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof ListCommissionAgreementRulesResponseClass
+     */
+    'totalItems': number;
+}
+

package/models/list-commission-candidates-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 ListCommissionCandidatesResponseClass
+ */
+export interface ListCommissionCandidatesResponseClass {
+    /**
+     * items
+     * @type {Array<CommissionCandidateClass>}
+     * @memberof ListCommissionCandidatesResponseClass
+     */
+    'items': Array<CommissionCandidateClass>;
+    /**
+     * The token for the next page of results
+     * @type {string}
+     * @memberof ListCommissionCandidatesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof ListCommissionCandidatesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The total number of items in the collection
+     * @type {number}
+     * @memberof ListCommissionCandidatesResponseClass
+     */
+    'totalItems': number;
+}
+

package/models/list-commission-settlements-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 ListCommissionSettlementsResponseClass
+ */
+export interface ListCommissionSettlementsResponseClass {
+    /**
+     * An array of commission settlements that were retrieved
+     * @type {Array<CommissionSettlementClass>}
+     * @memberof ListCommissionSettlementsResponseClass
+     */
+    'items': Array<CommissionSettlementClass>;
+    /**
+     * nextPageToken
+     * @type {string}
+     * @memberof ListCommissionSettlementsResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * totalItems
+     * @type {number}
+     * @memberof ListCommissionSettlementsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * totalPages
+     * @type {number}
+     * @memberof ListCommissionSettlementsResponseClass
+     */
+    'itemsPerPage': number;
+}
+

package/models/patch-commission-agreement-status-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 PatchCommissionAgreementStatusRequestDto
+ */
+export interface PatchCommissionAgreementStatusRequestDto {
+    /**
+     * Unique code identifier for the commission agreement
+     * @type {string}
+     * @memberof PatchCommissionAgreementStatusRequestDto
+     */
+    'code': string;
+    /**
+     * Status of the commission agreement. Valid values: draft, active, processing, archived
+     * @type {string}
+     * @memberof PatchCommissionAgreementStatusRequestDto
+     */
+    'status': PatchCommissionAgreementStatusRequestDtoStatusEnum;
+}
+
+export const PatchCommissionAgreementStatusRequestDtoStatusEnum = {
+    Draft: 'draft',
+    Active: 'active',
+    Processing: 'processing',
+    Archived: 'archived'
+} as const;
+
+export type PatchCommissionAgreementStatusRequestDtoStatusEnum = typeof PatchCommissionAgreementStatusRequestDtoStatusEnum[keyof typeof PatchCommissionAgreementStatusRequestDtoStatusEnum];
+
+

package/models/patch-commission-agreement-status-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 { CommissionAgreementClass } from './commission-agreement-class';
+
+/**
+ * 
+ * @export
+ * @interface PatchCommissionAgreementStatusResponseClass
+ */
+export interface PatchCommissionAgreementStatusResponseClass {
+    /**
+     * The commission agreement with updated status
+     * @type {CommissionAgreementClass}
+     * @memberof PatchCommissionAgreementStatusResponseClass
+     */
+    'commissionAgreement'?: CommissionAgreementClass;
+}
+