@emilgroup/commission-sdk-node 2.9.1-beta.13 → 2.9.1-beta.130

package/models/commission-creation-config-dto.ts

@@ -0,0 +1,52 @@
+/* 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 { CommissionCreationInvoiceConfigDto } from './commission-creation-invoice-config-dto';
+import { CommissionCreationRenewalConfigDto } from './commission-creation-renewal-config-dto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationConfigDto
+ */
+export interface CommissionCreationConfigDto {
+    /**
+     * Determines which event drives recurring commission creation: renewal dates or paid invoices.
+     * @type {string}
+     * @memberof CommissionCreationConfigDto
+     */
+    'mode': CommissionCreationConfigDtoModeEnum;
+    /**
+     * Required when mode is renewal.      Defines whether commission work is created only at renewal or yearly inside long policy periods.
+     * @type {CommissionCreationRenewalConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'renewal'?: CommissionCreationRenewalConfigDto;
+    /**
+     * Required when mode is invoice.     Defines how many paid invoices must be counted before commission work is created.
+     * @type {CommissionCreationInvoiceConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'invoice'?: CommissionCreationInvoiceConfigDto;
+}
+
+export const CommissionCreationConfigDtoModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+} as const;
+
+export type CommissionCreationConfigDtoModeEnum = typeof CommissionCreationConfigDtoModeEnum[keyof typeof CommissionCreationConfigDtoModeEnum];
+
+

package/models/commission-creation-invoice-config-class.ts

@@ -0,0 +1,30 @@
+/* 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 CommissionCreationInvoiceConfigClass
+ */
+export interface CommissionCreationInvoiceConfigClass {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigClass
+     */
+    'paidInvoiceInterval': number;
+}
+

package/models/commission-creation-invoice-config-dto.ts

@@ -0,0 +1,30 @@
+/* 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 CommissionCreationInvoiceConfigDto
+ */
+export interface CommissionCreationInvoiceConfigDto {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigDto
+     */
+    'paidInvoiceInterval': number;
+}
+

package/models/commission-creation-renewal-config-class.ts

@@ -0,0 +1,38 @@
+/* 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 CommissionCreationRenewalConfigClass
+ */
+export interface CommissionCreationRenewalConfigClass {
+    /**
+     * Renewal mode frequency.      Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigClass
+     */
+    'frequency': CommissionCreationRenewalConfigClassFrequencyEnum;
+}
+
+export const CommissionCreationRenewalConfigClassFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionCreationRenewalConfigClassFrequencyEnum = typeof CommissionCreationRenewalConfigClassFrequencyEnum[keyof typeof CommissionCreationRenewalConfigClassFrequencyEnum];
+
+

package/models/commission-creation-renewal-config-dto.ts

@@ -0,0 +1,38 @@
+/* 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 CommissionCreationRenewalConfigDto
+ */
+export interface CommissionCreationRenewalConfigDto {
+    /**
+     * Renewal mode frequency.      Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigDto
+     */
+    'frequency': CommissionCreationRenewalConfigDtoFrequencyEnum;
+}
+
+export const CommissionCreationRenewalConfigDtoFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionCreationRenewalConfigDtoFrequencyEnum = typeof CommissionCreationRenewalConfigDtoFrequencyEnum[keyof typeof CommissionCreationRenewalConfigDtoFrequencyEnum];
+
+

package/models/commission-estimate-class.ts

@@ -50,6 +50,30 @@ export interface CommissionEstimateClass {
      * @memberof CommissionEstimateClass
      */
     'group': CommissionEstimateClassGroupEnum;
+    /**
+     * First day the line pays for (inclusive); absent when the line covers the whole commission period, or is a sale
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'periodFrom'?: string;
+    /**
+     * Day after the last day the line pays for (exclusive); absent when periodFrom is absent
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'periodTo'?: string;
+    /**
+     * Code of the commission agreement version the line is priced with, set when the estimate splits the commission period by version; a line without it is priced with the estimate\'s version. Pass it on with the line when creating the commission
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'commissionAgreementVersionCode'?: string;
+    /**
+     * Code of the partner the line is paid to, set when the estimate splits the commission period by version; a line without it is paid to the estimate\'s partner. Pass it on with the line when creating the commission
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'partnerCode'?: string;
 }
 
 export const CommissionEstimateClassTypeEnum = {

package/models/commission-item-class.ts

@@ -56,6 +56,24 @@ export interface CommissionItemClass {
      * @memberof CommissionItemClass
      */
     'type': CommissionItemClassTypeEnum;
+    /**
+     * First day the item pays for (inclusive); absent when the item does not record its days
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'periodFrom'?: string;
+    /**
+     * Day after the last day the item pays for (exclusive); absent when periodFrom is absent
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'periodTo'?: string;
+    /**
+     * Code of the invoice the item pays for; absent when the item does not record its invoice
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'invoiceCode'?: string;
     /**
      * Time at which the object was created.
      * @type {string}

package/models/commission-paid-invoice-entry-class.ts

@@ -0,0 +1,124 @@
+/* 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 CommissionPaidInvoiceEntryClass
+ */
+export interface CommissionPaidInvoiceEntryClass {
+    /**
+     * The unique database identifier of the paid invoice entry
+     * @type {number}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'code': string;
+    /**
+     * Policy whose paid invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyCode': string;
+    /**
+     * Paid invoice counted for invoice-mode commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'invoiceCode': string;
+    /**
+     * Commission agreement version used when this invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Start of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceFrom': string;
+    /**
+     * End of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceTo': string;
+    /**
+     * The status of the paid invoice entry. Valid values: counted, consumed, settled_no_commission, discarded
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'status': CommissionPaidInvoiceEntryClassStatusEnum;
+    /**
+     * Whether this entry advances the interval counter. False for a premium correction, which is paid out on its own commission when it is paid.
+     * @type {boolean}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'countsTowardInterval': boolean;
+    /**
+     * Candidate created when this entry was reserved for commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCandidateCode'?: string;
+    /**
+     * Commission created from this counted invoice entry
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCode'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedBy': string;
+}
+
+export const CommissionPaidInvoiceEntryClassStatusEnum = {
+    Counted: 'counted',
+    Consumed: 'consumed',
+    SettledNoCommission: 'settled_no_commission',
+    Discarded: 'discarded'
+} as const;
+
+export type CommissionPaidInvoiceEntryClassStatusEnum = typeof CommissionPaidInvoiceEntryClassStatusEnum[keyof typeof CommissionPaidInvoiceEntryClassStatusEnum];
+
+

package/models/commission-payout-config-dto.ts

@@ -0,0 +1,38 @@
+/* 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 CommissionPayoutConfigDto
+ */
+export interface CommissionPayoutConfigDto {
+    /**
+     * Who receives the commissions priced by the rule: the agreement\'s main partner or the intermediary linked on the policy
+     * @type {string}
+     * @memberof CommissionPayoutConfigDto
+     */
+    'to': CommissionPayoutConfigDtoToEnum;
+}
+
+export const CommissionPayoutConfigDtoToEnum = {
+    MainPartner: 'mainPartner',
+    Intermediary: 'intermediary'
+} as const;
+
+export type CommissionPayoutConfigDtoToEnum = typeof CommissionPayoutConfigDtoToEnum[keyof typeof CommissionPayoutConfigDtoToEnum];
+
+

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

@@ -13,8 +13,8 @@
  */
 
 
-import { ClawbackConfigDto } from './clawback-config-dto';
 import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -77,15 +77,15 @@ export interface CreateCommissionAgreementRequestDto {
      */
     'settlementCreationDate'?: string;
     /**
-     * Initial version clawback creation configuration. Missing config defaults to all triggers disabled.
-     * @type {ClawbackConfigDto}
+     * Initial version agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
      * @memberof CreateCommissionAgreementRequestDto
      */
-    'clawbackConfig'?: ClawbackConfigDto;
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 
 export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
-    Immediately: 'immediately',
+    Manual: 'manual',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
     HalfYearly: 'halfYearly',

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

@@ -13,7 +13,7 @@
  */
 
 
-import { ClawbackConfigDto } from './clawback-config-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -52,10 +52,10 @@ export interface CreateCommissionAgreementVersionRequestDto {
      */
     'versionDescription'?: string;
     /**
-     * Version-scoped clawback creation configuration. Missing config defaults to all triggers disabled.
-     * @type {ClawbackConfigDto}
+     * Version-scoped agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
-    'clawbackConfig'?: ClawbackConfigDto;
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 

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

@@ -44,6 +44,30 @@ export interface CreateCommissionItemRequestDto {
      * @memberof CreateCommissionItemRequestDto
      */
     'type': CreateCommissionItemRequestDtoTypeEnum;
+    /**
+     * First day the item pays for (inclusive), as the estimate returns it; give it together with periodTo, or neither. Inside the commission period when the commission has a candidate
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'periodFrom'?: string;
+    /**
+     * Day after the last day the item pays for (exclusive), as the estimate returns it; after periodFrom
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'periodTo'?: string;
+    /**
+     * Code of the commission agreement version the item is priced with, as the estimate returns it; empty for the request\'s version. It must belong to the request\'s version\'s agreement and cover the item\'s days, or the commission period\'s start for an item without days. Without a candidate, only the request\'s version is accepted
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'commissionAgreementVersionCode'?: string;
+    /**
+     * Code of the partner the item is paid to, as the estimate returns it; empty for the request\'s partner. All items of one agreement version are paid to one partner
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'partnerCode'?: string;
 }
 
 export const CreateCommissionItemRequestDtoTypeEnum = {

package/models/estimate-commissions-request-dto.ts

@@ -32,5 +32,11 @@ export interface EstimateCommissionsRequestDto {
      * @memberof EstimateCommissionsRequestDto
      */
     'policyObjects': Array<object>;
+    /**
+     * The commission candidate whose period is estimated: the partner link and the agreement version are taken on its period start instead of the policy start.
+     * @type {string}
+     * @memberof EstimateCommissionsRequestDto
+     */
+    'commissionCandidateCode'?: string;
 }
 

package/models/index.ts

@@ -8,12 +8,22 @@ 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-agreement-version-config-class';
+export * from './commission-agreement-version-config-dto';
 export * from './commission-candidate-class';
 export * from './commission-class';
 export * from './commission-conditions-dto';
 export * from './commission-config-dto';
+export * from './commission-creation-config-class';
+export * from './commission-creation-config-dto';
+export * from './commission-creation-invoice-config-class';
+export * from './commission-creation-invoice-config-dto';
+export * from './commission-creation-renewal-config-class';
+export * from './commission-creation-renewal-config-dto';
 export * from './commission-estimate-class';
 export * from './commission-item-class';
+export * from './commission-paid-invoice-entry-class';
+export * from './commission-payout-config-dto';
 export * from './commission-recipient-class';
 export * from './commission-settlement-class';
 export * from './create-commission-agreement-product-request-dto';
@@ -58,6 +68,7 @@ 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-paid-invoice-entries-response-class';
 export * from './list-commission-recipients-response-class';
 export * from './list-commission-settlements-response-class';
 export * from './list-commissions-response-class';

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

@@ -22,28 +22,28 @@ import { CommissionAgreementVersionClass } from './commission-agreement-version-
  */
 export interface ListCommissionAgreementVersionsResponseClass {
     /**
-     * Array of commission agreement version objects
-     * @type {Array<CommissionAgreementVersionClass>}
+     * Next page token.
+     * @type {string}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'items': Array<CommissionAgreementVersionClass>;
+    'nextPageToken': string;
     /**
-     * Token for retrieving the next page of results
-     * @type {string}
+     * Total amount of items.
+     * @type {number}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'nextPageToken': string;
+    'totalItems': number;
     /**
-     * Number of items per page
+     * Items per page.
      * @type {number}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
     'itemsPerPage': number;
     /**
-     * Total number of items
-     * @type {number}
+     * Array of commission agreement version objects
+     * @type {Array<CommissionAgreementVersionClass>}
      * @memberof ListCommissionAgreementVersionsResponseClass
      */
-    'totalItems': number;
+    'items': Array<CommissionAgreementVersionClass>;
 }
 

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

@@ -22,28 +22,28 @@ import { CommissionAgreementClass } from './commission-agreement-class';
  */
 export interface ListCommissionAgreementsResponseClass {
     /**
-     * Array of commission agreement objects
-     * @type {Array<CommissionAgreementClass>}
+     * Next page token.
+     * @type {string}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'items': Array<CommissionAgreementClass>;
+    'nextPageToken': string;
     /**
-     * Token for pagination to retrieve the next page of results. Empty string indicates no more pages available
-     * @type {string}
+     * Total amount of items.
+     * @type {number}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'nextPageToken': string;
+    'totalItems': number;
     /**
-     * Number of items per page
+     * Items per page.
      * @type {number}
      * @memberof ListCommissionAgreementsResponseClass
      */
     'itemsPerPage': number;
     /**
-     * Total number of items
-     * @type {number}
+     * Array of commission agreement objects
+     * @type {Array<CommissionAgreementClass>}
      * @memberof ListCommissionAgreementsResponseClass
      */
-    'totalItems': number;
+    'items': Array<CommissionAgreementClass>;
 }
 

package/models/list-commission-paid-invoice-entries-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 { CommissionPaidInvoiceEntryClass } from './commission-paid-invoice-entry-class';
+
+/**
+ * 
+ * @export
+ * @interface ListCommissionPaidInvoiceEntriesResponseClass
+ */
+export interface ListCommissionPaidInvoiceEntriesResponseClass {
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of commission paid invoice entriess.
+     * @type {Array<CommissionPaidInvoiceEntryClass>}
+     * @memberof ListCommissionPaidInvoiceEntriesResponseClass
+     */
+    'items': Array<CommissionPaidInvoiceEntryClass>;
+}
+