@emilgroup/claim-sdk-node 1.39.0 → 1.39.1-beta.1

package/models/claim-class.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { ClaimAppliedDeductibleClass } from './claim-applied-deductible-class';
 
 /**
  * 
@@ -80,6 +81,12 @@ export interface ClaimClass {
      * @memberof ClaimClass
      */
     'productVersionId': number;
+    /**
+     * The slug of the product.
+     * @type {string}
+     * @memberof ClaimClass
+     */
+    'productSlug'?: string;
     /**
      * The name of the product.
      * @type {string}
@@ -134,12 +141,30 @@ export interface ClaimClass {
      * @memberof ClaimClass
      */
     'damageDate': string;
+    /**
+     * The end date of the damage.
+     * @type {string}
+     * @memberof ClaimClass
+     */
+    'damageEndDate': string;
     /**
      * The date on which the damage was reported.
      * @type {string}
      * @memberof ClaimClass
      */
     'notificationDate': string;
+    /**
+     * The tariff key for the claim.
+     * @type {string}
+     * @memberof ClaimClass
+     */
+    'tariffKey': string;
+    /**
+     * Applied deductibles for the claim.
+     * @type {Array<ClaimAppliedDeductibleClass>}
+     * @memberof ClaimClass
+     */
+    'appliedDeductibles': Array<ClaimAppliedDeductibleClass>;
     /**
      * Tenant specific custom fields for claims (e.g. IMEI, Serial Number, etc.)
      * @type {object}

package/models/claim-limit-usage-class.ts

@@ -0,0 +1,154 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 ClaimLimitUsageClass
+ */
+export interface ClaimLimitUsageClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ClaimLimitUsageClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'code': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'policyCode': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ClaimLimitUsageClass
+     */
+    'productVersionId': number;
+    /**
+     * Type of the limit usage.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'type': ClaimLimitUsageClassTypeEnum;
+    /**
+     * Tariff key associated with the limit usage.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'tariffKey': string;
+    /**
+     * Period of the limit usage bucket.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'period': ClaimLimitUsageClassPeriodEnum;
+    /**
+     * Start date of the usage period.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'periodStart': string;
+    /**
+     * End date of the usage period.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'periodEnd': string;
+    /**
+     * Remaining amount of the limit usage.
+     * @type {number}
+     * @memberof ClaimLimitUsageClass
+     */
+    'remainingAmount': number;
+    /**
+     * Latest action reason that produced the current remaining amount.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'reason': ClaimLimitUsageClassReasonEnum;
+    /**
+     * Claim code associated with the limit usage.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'claimCode': string;
+    /**
+     * Category key associated with the limit usage.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'categoryKey': string;
+    /**
+     * Deductible key associated with the limit usage.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'deductibleKey': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof ClaimLimitUsageClass
+     */
+    'updatedBy': string;
+}
+
+export const ClaimLimitUsageClassTypeEnum = {
+    Coverage: 'coverage',
+    Deductible: 'deductible'
+} as const;
+
+export type ClaimLimitUsageClassTypeEnum = typeof ClaimLimitUsageClassTypeEnum[keyof typeof ClaimLimitUsageClassTypeEnum];
+export const ClaimLimitUsageClassPeriodEnum = {
+    PerClaim: 'PER_CLAIM',
+    PolicyYear: 'POLICY_YEAR',
+    CalendarYear: 'CALENDAR_YEAR'
+} as const;
+
+export type ClaimLimitUsageClassPeriodEnum = typeof ClaimLimitUsageClassPeriodEnum[keyof typeof ClaimLimitUsageClassPeriodEnum];
+export const ClaimLimitUsageClassReasonEnum = {
+    Initial: 'INITIAL',
+    Deduction: 'DEDUCTION',
+    Reset: 'RESET'
+} as const;
+
+export type ClaimLimitUsageClassReasonEnum = typeof ClaimLimitUsageClassReasonEnum[keyof typeof ClaimLimitUsageClassReasonEnum];
+
+

package/models/claim-limit-usage-result-class.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 ClaimLimitUsageResultClass
+ */
+export interface ClaimLimitUsageResultClass {
+    /**
+     * Step key of the limit usage result.
+     * @type {string}
+     * @memberof ClaimLimitUsageResultClass
+     */
+    'stepKey': string;
+    /**
+     * Period of the limit usage result.
+     * @type {string}
+     * @memberof ClaimLimitUsageResultClass
+     */
+    'period': ClaimLimitUsageResultClassPeriodEnum;
+    /**
+     * Remaining amount before the limit usage result.
+     * @type {number}
+     * @memberof ClaimLimitUsageResultClass
+     */
+    'remainingBefore': number;
+    /**
+     * Remaining amount after the limit usage result.
+     * @type {number}
+     * @memberof ClaimLimitUsageResultClass
+     */
+    'remainingAfter': number;
+}
+
+export const ClaimLimitUsageResultClassPeriodEnum = {
+    PerClaim: 'PER_CLAIM',
+    PolicyYear: 'POLICY_YEAR',
+    CalendarYear: 'CALENDAR_YEAR'
+} as const;
+
+export type ClaimLimitUsageResultClassPeriodEnum = typeof ClaimLimitUsageResultClassPeriodEnum[keyof typeof ClaimLimitUsageResultClassPeriodEnum];
+
+

package/models/claim-position-class.ts

@@ -0,0 +1,160 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 { CalculationStepResultClass } from './calculation-step-result-class';
+import { ClaimLimitUsageResultClass } from './claim-limit-usage-result-class';
+
+/**
+ * 
+ * @export
+ * @interface ClaimPositionClass
+ */
+export interface ClaimPositionClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'id': number;
+    /**
+     * Code of the claim this position belongs to.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'claimCode': string;
+    /**
+     * Unique code of the claim position.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'code': string;
+    /**
+     * Unique number assigned to the claim position.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'positionNumber': string;
+    /**
+     * Current category of the claim position.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'category': string;
+    /**
+     * Original category as submitted.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'submittedCategory': string;
+    /**
+     * Description of what is being claimed.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'description': string;
+    /**
+     * Current status of the claim position.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'status': ClaimPositionClassStatusEnum;
+    /**
+     * Display order of the position in the list. Lower value appears first.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'order': number;
+    /**
+     * Version of the entity, incremented on every update. Starts at 1.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'version': number;
+    /**
+     * Current cost of the claim position.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'cost': number;
+    /**
+     * Original cost as submitted.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'submittedCost': number;
+    /**
+     * Manual adjustment amount used as a step in the calculation order.        When applied, it overrides the running amount at that point in the calculation chain.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'manualAdjustmentAmount': number;
+    /**
+     * Calculated reimbursement amount for this position.
+     * @type {number}
+     * @memberof ClaimPositionClass
+     */
+    'reimbursementAmount': number;
+    /**
+     * Additional custom data specific to the tenant or product.
+     * @type {object}
+     * @memberof ClaimPositionClass
+     */
+    'customFields': object;
+    /**
+     * Snapshot of limit usages at the time this position was calculated.
+     * @type {Array<ClaimLimitUsageResultClass>}
+     * @memberof ClaimPositionClass
+     */
+    'limitUsageSnapshot': Array<ClaimLimitUsageResultClass>;
+    /**
+     * Snapshot of calculation steps at the time this position was calculated.
+     * @type {Array<CalculationStepResultClass>}
+     * @memberof ClaimPositionClass
+     */
+    'calculationStepSnapshot': Array<CalculationStepResultClass>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof ClaimPositionClass
+     */
+    'updatedBy': string;
+}
+
+export const ClaimPositionClassStatusEnum = {
+    Open: 'OPEN',
+    Closed: 'CLOSED'
+} as const;
+
+export type ClaimPositionClassStatusEnum = typeof ClaimPositionClassStatusEnum[keyof typeof ClaimPositionClassStatusEnum];
+
+

package/models/create-claim-position-request-dto.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 CreateClaimPositionRequestDto
+ */
+export interface CreateClaimPositionRequestDto {
+    /**
+     * Code of the claim this position belongs to (e.g. cla_xxxxx).
+     * @type {string}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'claimCode': string;
+    /**
+     * Category or type of the claim position (e.g. damage type, coverage area, or product category).
+     * @type {string}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'category'?: string;
+    /**
+     * Human-readable description of the claim position (what is being claimed or covered).
+     * @type {string}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'description'?: string;
+    /**
+     * Monetary cost or amount associated with this claim position.
+     * @type {number}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'cost': number;
+    /**
+     * Optional key-value object for tenant- or product-specific data. Merged with existing customFields.
+     * @type {object}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'customFields'?: object;
+    /**
+     * Display order (lower = first). Used for reordering claim positions in lists.
+     * @type {number}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'order': number;
+    /**
+     * The date on which the procedure was performed.
+     * @type {string}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'procedureDate'?: string;
+    /**
+     * Manual adjustment amount for this claim position.
+     * @type {number}
+     * @memberof CreateClaimPositionRequestDto
+     */
+    'manualAdjustmentAmount'?: number;
+}
+

package/models/create-claim-position-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 { ClaimPositionClass } from './claim-position-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateClaimPositionResponseClass
+ */
+export interface CreateClaimPositionResponseClass {
+    /**
+     * Claim position created successfully.
+     * @type {ClaimPositionClass}
+     * @memberof CreateClaimPositionResponseClass
+     */
+    'claimPosition': ClaimPositionClass;
+}
+

package/models/create-claim-request-dto.ts

@@ -134,5 +134,11 @@ export interface CreateClaimRequestDto {
      * @memberof CreateClaimRequestDto
      */
     'customFields'?: object;
+    /**
+     * The claim\'s damage end date.
+     * @type {string}
+     * @memberof CreateClaimRequestDto
+     */
+    'damageEndDate'?: string;
 }
 

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

@@ -30,11 +30,11 @@ export interface CreateRegulationItemRequestDto {
      */
     'regulationItemType': CreateRegulationItemRequestDtoRegulationItemTypeEnum;
     /**
-     * The amount for the regulation item
+     * The amount for the regulation item. For payout regulation items, this is computed automatically from the reimbursementAmount of the matched open claim positions.
      * @type {number}
      * @memberof CreateRegulationItemRequestDto
      */
-    'amount': number;
+    'amount'?: number;
     /**
      * The currency of the regulation item
      * @type {string}
@@ -60,7 +60,19 @@ export interface CreateRegulationItemRequestDto {
      */
     'metadata'?: object;
     /**
-     * Details of the payout. Required if the regulation item type is payout.
+     * The payout provider to use. Defaults to INTERNAL. Use PAYMENT_SERVICE to delegate payout processing to the payment service.
+     * @type {string}
+     * @memberof CreateRegulationItemRequestDto
+     */
+    'payoutProvider'?: CreateRegulationItemRequestDtoPayoutProviderEnum;
+    /**
+     * List of claim position categories that are covered by this regulation. Required for payout regulation items.
+     * @type {Array<string>}
+     * @memberof CreateRegulationItemRequestDto
+     */
+    'claimPositionCategories'?: Array<string>;
+    /**
+     * Details of the payout. Required if the regulation item type is payout and payoutProvider is INTERNAL.
      * @type {PayoutDetailsDto}
      * @memberof CreateRegulationItemRequestDto
      */
@@ -77,6 +89,12 @@ export interface CreateRegulationItemRequestDto {
      * @memberof CreateRegulationItemRequestDto
      */
     'regressDetails'?: RegressDetailsDto;
+    /**
+     * The partner code to use for the regulation item
+     * @type {string}
+     * @memberof CreateRegulationItemRequestDto
+     */
+    'partnerCode': string;
 }
 
 export const CreateRegulationItemRequestDtoRegulationItemTypeEnum = {
@@ -101,5 +119,11 @@ export const CreateRegulationItemRequestDtoCurrencyEnum = {
 } as const;
 
 export type CreateRegulationItemRequestDtoCurrencyEnum = typeof CreateRegulationItemRequestDtoCurrencyEnum[keyof typeof CreateRegulationItemRequestDtoCurrencyEnum];
+export const CreateRegulationItemRequestDtoPayoutProviderEnum = {
+    Internal: 'INTERNAL',
+    PaymentService: 'PAYMENT_SERVICE'
+} as const;
+
+export type CreateRegulationItemRequestDtoPayoutProviderEnum = typeof CreateRegulationItemRequestDtoPayoutProviderEnum[keyof typeof CreateRegulationItemRequestDtoPayoutProviderEnum];
 
 

package/models/get-claim-limit-usage-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 { ClaimLimitUsageClass } from './claim-limit-usage-class';
+
+/**
+ * 
+ * @export
+ * @interface GetClaimLimitUsageResponseClass
+ */
+export interface GetClaimLimitUsageResponseClass {
+    /**
+     * Claim limit usage
+     * @type {ClaimLimitUsageClass}
+     * @memberof GetClaimLimitUsageResponseClass
+     */
+    'claimLimitUsage': ClaimLimitUsageClass;
+}
+

package/models/get-claim-position-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 { ClaimPositionClass } from './claim-position-class';
+
+/**
+ * 
+ * @export
+ * @interface GetClaimPositionResponseClass
+ */
+export interface GetClaimPositionResponseClass {
+    /**
+     * Claim position details.
+     * @type {ClaimPositionClass}
+     * @memberof GetClaimPositionResponseClass
+     */
+    'claimPosition': ClaimPositionClass;
+}
+