@emilgroup/billing-sdk-node 1.3.0 → 1.4.0

package/models/premium-formula-class.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 PremiumFormulaClass
+ */
+export interface PremiumFormulaClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PremiumFormulaClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the product version.
+     * @type {number}
+     * @memberof PremiumFormulaClass
+     */
+    'productVersionId': number;
+    /**
+     * Premium group name.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'group': string;
+    /**
+     * Premium name.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'name': string;
+    /**
+     * Premium expression.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'expression': string;
+    /**
+     * Type of premium that is based on time.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'type': string;
+    /**
+     * This is unit of premium. Premium units are determined based                    on oneTimePayment, day, week, month and year.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'unit': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PremiumFormulaClass
+     */
+    'updatedAt': string;
+}
+

package/models/premium-override-dto.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 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 PublicAPI
+ * The Emil Public 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>;
+}
+

package/models/product-class.ts

@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { InsuredObjectTypeClass } from './insured-object-type-class';
+import { ProductVersionClass } from './product-version-class';
+
+/**
+ * 
+ * @export
+ * @interface ProductClass
+ */
+export interface ProductClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'code': string;
+    /**
+     * Product\'s name.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'name': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'slug': string;
+    /**
+     * Insured object types covered under product.
+     * @type {Array<InsuredObjectTypeClass>}
+     * @memberof ProductClass
+     */
+    'insuredObjectTypes': Array<InsuredObjectTypeClass>;
+    /**
+     * Contract duration in days.
+     * @type {number}
+     * @memberof ProductClass
+     */
+    'contractDurationDays': number;
+    /**
+     * Product versions.
+     * @type {Array<ProductVersionClass>}
+     * @memberof ProductClass
+     */
+    'versions': Array<ProductVersionClass>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ProductClass
+     */
+    'updatedAt': string;
+}
+

package/models/product-factor-class.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 ProductFactorClass
+ */
+export interface ProductFactorClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductFactorClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the version of the product on which this product factor is used.
+     * @type {number}
+     * @memberof ProductFactorClass
+     */
+    'productVersionId': number;
+    /**
+     * Product factor group.
+     * @type {string}
+     * @memberof ProductFactorClass
+     */
+    'group': string;
+    /**
+     * Product factor label.
+     * @type {string}
+     * @memberof ProductFactorClass
+     */
+    'label': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ProductFactorClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ProductFactorClass
+     */
+    'updatedAt': string;
+    /**
+     * Factor values.
+     * @type {Array<string>}
+     * @memberof ProductFactorClass
+     */
+    'values': Array<string>;
+}
+

package/models/product-field-class.ts

@@ -0,0 +1,138 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 ProductFieldClass
+ */
+export interface ProductFieldClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductFieldClass
+     */
+    'id': number;
+    /**
+     * Product field name.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'name': string;
+    /**
+     * Product field group.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'group': string;
+    /**
+     * Product field label.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'label': string;
+    /**
+     * Product field type.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'typeEntity': string;
+    /**
+     * Unique identifier referencing the product type.
+     * @type {number}
+     * @memberof ProductFieldClass
+     */
+    'typeId': number;
+    /**
+     * Unique identifier referencing the insured object.
+     * @type {number}
+     * @memberof ProductFieldClass
+     */
+    'insuredObjectId': number;
+    /**
+     * Is field required?
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isRequired': boolean;
+    /**
+     * Is field hidden on the booking funnel?
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isHidden': boolean;
+    /**
+     * Is field hidden on the customer portal?
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isHiddenCustomerPortal': boolean;
+    /**
+     * Is field editable on the customer portal?
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isEditableCustomerPortal': boolean;
+    /**
+     * Is this a system field? - System fields can neither be deleted nor modified
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isSystem': boolean;
+    /**
+     * Should the field value be unique across policies?
+     * @type {boolean}
+     * @memberof ProductFieldClass
+     */
+    'isUnique': boolean;
+    /**
+     * Default value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof ProductFieldClass
+     */
+    'defaultValue': object;
+    /**
+     * Minimum value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof ProductFieldClass
+     */
+    'minValue': object;
+    /**
+     * Maximum value of the field. For the field type date-time, it should be { \"templated\" : \"{{today}}\" }
+     * @type {object}
+     * @memberof ProductFieldClass
+     */
+    'maxValue': object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ProductFieldClass
+     */
+    'updatedAt': string;
+    /**
+     * Order
+     * @type {number}
+     * @memberof ProductFieldClass
+     */
+    'order': number;
+}
+

package/models/product-version-class.ts

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 ProductVersionClass
+ */
+export interface ProductVersionClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductVersionClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the product.
+     * @type {number}
+     * @memberof ProductVersionClass
+     */
+    'productId': number;
+    /**
+     * Product version description.
+     * @type {string}
+     * @memberof ProductVersionClass
+     */
+    'description': string;
+    /**
+     * Product version status.
+     * @type {string}
+     * @memberof ProductVersionClass
+     */
+    'status': ProductVersionClassStatusEnum;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof ProductVersionClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof ProductVersionClass
+     */
+    'updatedAt': string;
+}
+
+export const ProductVersionClassStatusEnum = {
+    Draft: 'draft',
+    Active: 'active',
+    Passive: 'passive',
+    Archived: 'archived'
+} as const;
+
+export type ProductVersionClassStatusEnum = typeof ProductVersionClassStatusEnum[keyof typeof ProductVersionClassStatusEnum];
+
+

package/models/send-notification-request-dto.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 SendNotificationRequestDto
+ */
+export interface SendNotificationRequestDto {
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof SendNotificationRequestDto
+     */
+    'templateSlug': string;
+    /**
+     * Subject of the email.
+     * @type {string}
+     * @memberof SendNotificationRequestDto
+     */
+    'emailSubject'?: string;
+    /**
+     * Payload is used by the template engine to replace all template variables with proper data.      For more information, please go to https://github.com/flosch/pongo2.
+     * @type {object}
+     * @memberof SendNotificationRequestDto
+     */
+    'payload'?: object;
+}
+

package/models/send-notification-response-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 SendNotificationResponseClass
+ */
+export interface SendNotificationResponseClass {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof SendNotificationResponseClass
+     */
+    'code': string;
+}
+

package/models/update-lead-request-dto.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { CreateAccountRequestDto } from './create-account-request-dto';
+import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
+import { PolicyObjectRequestDto } from './policy-object-request-dto';
+import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+import { UploadedDocumentDto } from './uploaded-document-dto';
+
+/**
+ * 
+ * @export
+ * @interface UpdateLeadRequestDto
+ */
+export interface UpdateLeadRequestDto {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof UpdateLeadRequestDto
+     */
+    'code': string;
+    /**
+     * Unique identifier referencing the product version.
+     * @type {number}
+     * @memberof UpdateLeadRequestDto
+     */
+    'productVersionId'?: number;
+    /**
+     * Unique identifier of the product that this object belongs to.
+     * @type {string}
+     * @memberof UpdateLeadRequestDto
+     */
+    'productCode': string;
+    /**
+     * 
+     * @type {Array<PolicyObjectRequestDto>}
+     * @memberof UpdateLeadRequestDto
+     */
+    'policyObjects': Array<PolicyObjectRequestDto>;
+    /**
+     * Bank account details
+     * @type {CreateBankAccountRequestDto}
+     * @memberof UpdateLeadRequestDto
+     */
+    'bankAccount'?: CreateBankAccountRequestDto;
+    /**
+     * Custom data.
+     * @type {object}
+     * @memberof UpdateLeadRequestDto
+     */
+    'customData'?: object;
+    /**
+     * Codes for documents to be uploaded.
+     * @type {UploadedDocumentDto}
+     * @memberof UpdateLeadRequestDto
+     */
+    'uploadedDocument'?: UploadedDocumentDto;
+    /**
+     * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
+     * @type {string}
+     * @memberof UpdateLeadRequestDto
+     */
+    'status': string;
+    /**
+     * Premium Override
+     * @type {PremiumOverrideRequestDto}
+     * @memberof UpdateLeadRequestDto
+     */
+    'premiumOverride'?: PremiumOverrideRequestDto;
+    /**
+     * 
+     * @type {CreateAccountRequestDto}
+     * @memberof UpdateLeadRequestDto
+     */
+    'account': CreateAccountRequestDto;
+}
+