@emilgroup/insurance-sdk-node 1.1.1 → 1.4.0

package/models/list-request-dto.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -21,13 +21,13 @@
  */
 export interface ListRequestDto {
     /**
-     * Page size
+     * Page size.
      * @type {number}
      * @memberof ListRequestDto
      */
     'pageSize'?: number;
     /**
-     * Page token
+     * Page token.
      * @type {string}
      * @memberof ListRequestDto
      */
@@ -39,19 +39,19 @@ export interface ListRequestDto {
      */
     'filter'?: string;
     /**
-     * Search query
+     * Search query.
      * @type {string}
      * @memberof ListRequestDto
      */
     'search'?: string;
     /**
-     * Ordering criteria
+     * Ordering criteria.
      * @type {string}
      * @memberof ListRequestDto
      */
     'order'?: string;
     /**
-     * Extra fields to fetch
+     * Extra fields to fetch.
      * @type {string}
      * @memberof ListRequestDto
      */

package/models/omit-type-class.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService 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 OmitTypeClass
+ */
+export interface OmitTypeClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the Product version.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'productVersionId': number;
+    /**
+     * Insured object name.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'name': string;
+    /**
+     * Insured object label.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'label': string;
+    /**
+     * Unique identifier referencing the Insured object type.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'insuredObjectTypeId': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'updatedAt': string;
+}
+

package/models/policy-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -23,76 +23,94 @@ import { ProductClass } from './product-class';
  */
 export interface PolicyClass {
     /**
-     * Policy id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof PolicyClass
      */
     'id': number;
     /**
-     * Policy code
+     * Unique identifier for the object.
      * @type {string}
      * @memberof PolicyClass
      */
     'code': string;
     /**
-     * Policy number
+     * Policy number.
      * @type {string}
      * @memberof PolicyClass
      */
     'policyNumber': string;
     /**
-     * Policy product version id
+     * Internal policy number.
+     * @type {string}
+     * @memberof PolicyClass
+     */
+    'internalPolicyNumber': string;
+    /**
+     * Unique identifier referencing the policy product version.
      * @type {number}
      * @memberof PolicyClass
      */
     'productVersionId': number;
     /**
-     * Policy product id
+     * Unique identifier referencing the policy product.
      * @type {number}
      * @memberof PolicyClass
      */
     'productId': number;
     /**
-     * Policy account code
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof PolicyClass
      */
     'accountCode': string;
     /**
-     * Policy status id
+     * Policy status. This property shows different numbers depending on the status of a policy: Active = 0, Withdrawn = 1, Terminated = 2, Suspended = 3.
      * @type {number}
      * @memberof PolicyClass
      */
-    'statusId': number;
+    'status': number;
     /**
-     * Policy versions
+     * Policy holder name.
+     * @type {string}
+     * @memberof PolicyClass
+     */
+    'holder': string;
+    /**
+     * Policy versions.
      * @type {Array<PolicyVersionClass>}
      * @memberof PolicyClass
      */
     'versions': Array<PolicyVersionClass>;
     /**
-     * Product
+     * Product.
      * @type {ProductClass}
      * @memberof PolicyClass
      */
     'product': ProductClass;
     /**
-     * Date created
+     * The date the policy will get started.
      * @type {string}
      * @memberof PolicyClass
      */
     'policyStartDate': string;
     /**
-     * Date created
+     * Time at which the object was created.
      * @type {string}
      * @memberof PolicyClass
      */
     'createdAt': string;
     /**
-     * Date updated
+     * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyClass
      */
     'updatedAt': string;
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof PolicyClass
+     */
+    'leadCode': string;
 }
 

package/models/policy-object-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -21,25 +21,25 @@
  */
 export interface PolicyObjectClass {
     /**
-     * Insured object id
+     * Unique identifier referencing the insured object.
      * @type {number}
      * @memberof PolicyObjectClass
      */
     'insuredObjectId': number;
     /**
-     * Insured object name
+     * Insured object name.
      * @type {string}
      * @memberof PolicyObjectClass
      */
     'insuredObjectName': string;
     /**
-     * Insured object data
+     * Insured object data.
      * @type {object}
      * @memberof PolicyObjectClass
      */
     'data': object;
     /**
-     * Insured object summary
+     * Insured object summary.
      * @type {string}
      * @memberof PolicyObjectClass
      */

package/models/policy-object-dto.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -21,13 +21,13 @@
  */
 export interface PolicyObjectDto {
     /**
-     * Insured object id
+     * Unique identifier referencing the insured object.
      * @type {number}
      * @memberof PolicyObjectDto
      */
     'insuredObjectId': number;
     /**
-     * Insured object data
+     * Insured object data.
      * @type {object}
      * @memberof PolicyObjectDto
      */

package/models/policy-premium-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -22,25 +22,25 @@ import { PolicyPremiumItemClass } from './policy-premium-item-class';
  */
 export interface PolicyPremiumClass {
     /**
-     * Premium Items
+     * Premium Items.
      * @type {Array<PolicyPremiumItemClass>}
      * @memberof PolicyPremiumClass
      */
     'premiumItems': Array<PolicyPremiumItemClass>;
     /**
-     * Policy premium grand total
+     * The grand total of a policy premium is the net sum of all policy premium items.
      * @type {number}
      * @memberof PolicyPremiumClass
      */
     'grandTotal': number;
     /**
-     * Date created
+     * Time at which the object was created.
      * @type {string}
      * @memberof PolicyPremiumClass
      */
     'createdAt': string;
     /**
-     * Date updated
+     * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyPremiumClass
      */

package/models/policy-premium-item-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -22,34 +22,40 @@ import { PremiumFormulaClass } from './premium-formula-class';
  */
 export interface PolicyPremiumItemClass {
     /**
-     * Item premium formula id
+     * Unique identifier referencing the item premium formula.
      * @type {number}
      * @memberof PolicyPremiumItemClass
      */
     'premiumFormulaId': number;
     /**
-     * Item total
+     * Item total.
      * @type {number}
      * @memberof PolicyPremiumItemClass
      */
     'total': number;
     /**
-     * Date created
+     * Time at which the object was created.
      * @type {string}
      * @memberof PolicyPremiumItemClass
      */
     'createdAt': string;
     /**
-     * Date updated
+     * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyPremiumItemClass
      */
     'updatedAt': string;
     /**
-     * Item premium formula entity
+     * Item premium formula entity.
      * @type {PremiumFormulaClass}
      * @memberof PolicyPremiumItemClass
      */
     'premiumFormula': PremiumFormulaClass;
+    /**
+     * Is premium override?
+     * @type {boolean}
+     * @memberof PolicyPremiumItemClass
+     */
+    'isOverride': boolean;
 }
 

package/models/policy-version-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -22,19 +22,19 @@ import { TimesliceClass } from './timeslice-class';
  */
 export interface PolicyVersionClass {
     /**
-     * Policy version id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof PolicyVersionClass
      */
     'id': number;
     /**
-     * Policy timeline
+     * Policy timeline.
      * @type {Array<TimesliceClass>}
      * @memberof PolicyVersionClass
      */
     'timeline': Array<TimesliceClass>;
     /**
-     * Policy version metadata
+     * Policy version metadata. Metadata contains extra information that is needed for specific cases.
      * @type {object}
      * @memberof PolicyVersionClass
      */
@@ -46,13 +46,13 @@ export interface PolicyVersionClass {
      */
     'isCurrent': boolean;
     /**
-     * Date created
+     * Time at which the object was created.
      * @type {string}
      * @memberof PolicyVersionClass
      */
     'createdAt': string;
     /**
-     * Date updated
+     * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyVersionClass
      */

package/models/premium-formula-class.ts

@@ -5,7 +5,7 @@
  * The EMIL InsuranceService 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
@@ -13,7 +13,6 @@
  */
 
 
-import { ProductVersionClass } from './product-version-class';
 
 /**
  * 
@@ -22,61 +21,55 @@ import { ProductVersionClass } from './product-version-class';
  */
 export interface PremiumFormulaClass {
     /**
-     * Premium formula id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof PremiumFormulaClass
      */
     'id': number;
     /**
-     * Product version id
+     * Unique identifier referencing the product version.
      * @type {number}
      * @memberof PremiumFormulaClass
      */
     'productVersionId': number;
     /**
-     * Premium group
+     * Premium group name.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'group': string;
     /**
-     * Premium name
+     * Premium name.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'name': string;
     /**
-     * Premium expression
+     * Premium expression.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'expression': string;
     /**
-     * Product type
+     * Type of Premium that is based on time.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'type': string;
     /**
-     * Premium type unit
+     * This is unit of Premium. Premium units are determined based                    on oneTimePayment, day, week, month and year.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'unit': string;
     /**
-     * Premium product version
-     * @type {Array<ProductVersionClass>}
-     * @memberof PremiumFormulaClass
-     */
-    'productVersion': Array<ProductVersionClass>;
-    /**
-     * Date created
+     * Time at which the object was created.
      * @type {string}
      * @memberof PremiumFormulaClass
      */
     'createdAt': string;
     /**
-     * Date updated
+     * Time at which the object was updated.
      * @type {string}
      * @memberof PremiumFormulaClass
      */

package/models/premium-override-dto.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService 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 PremiumOverrideDto
+ */
+export interface PremiumOverrideDto {
+    /**
+     * Name of Premium.
+     * @type {string}
+     * @memberof PremiumOverrideDto
+     */
+    'name': string;
+    /**
+     * Type of Premium that is based on time.
+     * @type {string}
+     * @memberof PremiumOverrideDto
+     */
+    'type': PremiumOverrideDtoTypeEnum;
+    /**
+     * This is unit of Premium. Premium units are determined based                    on oneTimePayment, day, week, month and year.
+     * @type {string}
+     * @memberof PremiumOverrideDto
+     */
+    'unit': PremiumOverrideDtoUnitEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof PremiumOverrideDto
+     */
+    'netPremium': number;
+}
+
+export const PremiumOverrideDtoTypeEnum = {
+    Time: 'time'
+} as const;
+
+export type PremiumOverrideDtoTypeEnum = typeof PremiumOverrideDtoTypeEnum[keyof typeof PremiumOverrideDtoTypeEnum];
+export const PremiumOverrideDtoUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+} as const;
+
+export type PremiumOverrideDtoUnitEnum = typeof PremiumOverrideDtoUnitEnum[keyof typeof PremiumOverrideDtoUnitEnum];
+
+

package/models/premium-override-request-dto.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService 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 { PremiumOverrideDto } from './premium-override-dto';
+
+/**
+ * 
+ * @export
+ * @interface PremiumOverrideRequestDto
+ */
+export interface PremiumOverrideRequestDto {
+    /**
+     * Premium Override.
+     * @type {Array<PremiumOverrideDto>}
+     * @memberof PremiumOverrideRequestDto
+     */
+    'premiumOverrides': Array<PremiumOverrideDto>;
+}
+