@emilgroup/customer-sdk-node 1.18.0 → 1.20.0

package/.openapi-generator/FILES

@@ -34,9 +34,9 @@ models/create-customer-request-dto.ts
 models/create-customer-response-class.ts
 models/create-lead-request-dto.ts
 models/create-lead-response-class.ts
+models/create-payment-method-request-dto.ts
 models/create-policy-request-dto.ts
 models/create-presigned-post-response-class.ts
-models/currency-class.ts
 models/customer-class.ts
 models/customer-document-class.ts
 models/customer-product-class.ts
@@ -83,8 +83,10 @@ models/request-policy-update-response-class.ts
 models/reset-password-by-customer-request-dto.ts
 models/respond-to-auth-challenge-class.ts
 models/respond-to-auth-challenge-request-dto.ts
+models/sepa-dto.ts
 models/shared-customer-policy-object-request-dto.ts
 models/shared-invoice-item-class.ts
+models/shared-invoice-status-class.ts
 models/terminate-customer-policy-request-dto.ts
 models/terminate-customer-policy-response-class.ts
 models/timeslice-class.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/customer-sdk-node@1.18.0 --save
+npm install @emilgroup/customer-sdk-node@1.20.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/customer-sdk-node@1.18.0
+yarn add @emilgroup/customer-sdk-node@1.20.0
 ```
 
 And then you can import `CustomersApi`.

package/dist/models/claim-class.d.ts

@@ -33,6 +33,18 @@ export interface ClaimClass {
      * @memberof ClaimClass
      */
     'title': string;
+    /**
+     * Unique number assigned to the claim.
+     * @type {string}
+     * @memberof ClaimClass
+     */
+    'claimNumber': string;
+    /**
+     * The current status of the claim.
+     * @type {string}
+     * @memberof ClaimClass
+     */
+    'status': string;
     /**
      * Unique identifier of the account that the claim belongs to
      * @type {string}

package/dist/models/create-customer-claim-request-dto.d.ts

@@ -21,6 +21,12 @@ export interface CreateCustomerClaimRequestDto {
      * @memberof CreateCustomerClaimRequestDto
      */
     'title': string;
+    /**
+     * Unique number assigned to the claim.
+     * @type {string}
+     * @memberof CreateCustomerClaimRequestDto
+     */
+    'claimNumber'?: string;
     /**
      * Field for the policy number that the claim belongs to.
      * @type {string}

package/dist/models/create-lead-request-dto.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
+import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
 import { PolicyObjectDto } from './policy-object-dto';
 import { PremiumOverrideRequestDto } from './premium-override-request-dto';
 import { UploadedDocumentDto } from './uploaded-document-dto';
@@ -73,4 +74,10 @@ export interface CreateLeadRequestDto {
      * @memberof CreateLeadRequestDto
      */
     'premiumOverride'?: PremiumOverrideRequestDto;
+    /**
+     * Payment method
+     * @type {CreatePaymentMethodRequestDto}
+     * @memberof CreateLeadRequestDto
+     */
+    'paymentMethod': CreatePaymentMethodRequestDto;
 }

package/dist/models/create-payment-method-request-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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 { SepaDto } from './sepa-dto';
+/**
+ *
+ * @export
+ * @interface CreatePaymentMethodRequestDto
+ */
+export interface CreatePaymentMethodRequestDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'type': string;
+    /**
+     *
+     * @type {SepaDto}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'sepa'?: SepaDto;
+}

package/dist/models/grpc-update-lead-request-dto.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
 import { PolicyObjectDto } from './policy-object-dto';
 /**
  *
@@ -34,6 +35,12 @@ export interface GrpcUpdateLeadRequestDto {
      * @memberof GrpcUpdateLeadRequestDto
      */
     'status'?: string;
+    /**
+     * Payment method
+     * @type {CreatePaymentMethodRequestDto}
+     * @memberof GrpcUpdateLeadRequestDto
+     */
+    'paymentMethod': CreatePaymentMethodRequestDto;
     /**
      *
      * @type {string}

package/dist/models/index.d.ts

@@ -14,9 +14,9 @@ export * from './create-customer-request-dto';
 export * from './create-customer-response-class';
 export * from './create-lead-request-dto';
 export * from './create-lead-response-class';
+export * from './create-payment-method-request-dto';
 export * from './create-policy-request-dto';
 export * from './create-presigned-post-response-class';
-export * from './currency-class';
 export * from './customer-class';
 export * from './customer-document-class';
 export * from './customer-product-class';
@@ -62,8 +62,10 @@ export * from './request-policy-update-response-class';
 export * from './reset-password-by-customer-request-dto';
 export * from './respond-to-auth-challenge-class';
 export * from './respond-to-auth-challenge-request-dto';
+export * from './sepa-dto';
 export * from './shared-customer-policy-object-request-dto';
 export * from './shared-invoice-item-class';
+export * from './shared-invoice-status-class';
 export * from './terminate-customer-policy-request-dto';
 export * from './terminate-customer-policy-response-class';
 export * from './timeslice-class';

package/dist/models/index.js

@@ -30,9 +30,9 @@ __exportStar(require("./create-customer-request-dto"), exports);
 __exportStar(require("./create-customer-response-class"), exports);
 __exportStar(require("./create-lead-request-dto"), exports);
 __exportStar(require("./create-lead-response-class"), exports);
+__exportStar(require("./create-payment-method-request-dto"), exports);
 __exportStar(require("./create-policy-request-dto"), exports);
 __exportStar(require("./create-presigned-post-response-class"), exports);
-__exportStar(require("./currency-class"), exports);
 __exportStar(require("./customer-class"), exports);
 __exportStar(require("./customer-document-class"), exports);
 __exportStar(require("./customer-product-class"), exports);
@@ -78,8 +78,10 @@ __exportStar(require("./request-policy-update-response-class"), exports);
 __exportStar(require("./reset-password-by-customer-request-dto"), exports);
 __exportStar(require("./respond-to-auth-challenge-class"), exports);
 __exportStar(require("./respond-to-auth-challenge-request-dto"), exports);
+__exportStar(require("./sepa-dto"), exports);
 __exportStar(require("./shared-customer-policy-object-request-dto"), exports);
 __exportStar(require("./shared-invoice-item-class"), exports);
+__exportStar(require("./shared-invoice-status-class"), exports);
 __exportStar(require("./terminate-customer-policy-request-dto"), exports);
 __exportStar(require("./terminate-customer-policy-response-class"), exports);
 __exportStar(require("./timeslice-class"), exports);

package/dist/models/invoice-class.d.ts

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { CurrencyClass } from './currency-class';
 import { SharedInvoiceItemClass } from './shared-invoice-item-class';
+import { SharedInvoiceStatusClass } from './shared-invoice-status-class';
 /**
  *
  * @export
@@ -18,113 +18,119 @@ import { SharedInvoiceItemClass } from './shared-invoice-item-class';
  */
 export interface InvoiceClass {
     /**
-     * policy code
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof InvoiceClass
      */
     'policyCode': string;
     /**
-     * Account number
+     * Account number.
      * @type {string}
      * @memberof InvoiceClass
      */
     'accountNumber': string;
     /**
-     * Invoice code
+     * Unique identifier for the object.
      * @type {string}
      * @memberof InvoiceClass
      */
     'code': string;
     /**
-     * Invoice type
+     * Invoice type.
      * @type {string}
      * @memberof InvoiceClass
      */
     'type': InvoiceClassTypeEnum;
     /**
-     * Invoice number
+     * Invoice number.
      * @type {string}
      * @memberof InvoiceClass
      */
     'invoiceNumber': string;
     /**
-     * Net amount
+     * Net amount is in cents.
      * @type {number}
      * @memberof InvoiceClass
      */
     'netAmount': number;
     /**
-     * Tax amount
+     * Tax amount is in cents.
      * @type {number}
      * @memberof InvoiceClass
      */
     'taxAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'creditAmount': number;
     /**
-     * Surcharge amount
-     * @type {number}
-     * @memberof InvoiceClass
-     */
-    'surcharge': number;
-    /**
-     * Gross amount
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'grossAmount': number;
     /**
-     * Invoice status
+     * Invoice status.
      * @type {string}
      * @memberof InvoiceClass
      */
     'status': InvoiceClassStatusEnum;
     /**
-     * Invoice due date
+     * Invoice due date.
      * @type {string}
      * @memberof InvoiceClass
      */
     'dueDate': string;
     /**
-     * Invoice metadata
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof InvoiceClass
      */
     'metadata': object;
     /**
-     * Invoice billing interval from
+     * Start date of billing interval.
      * @type {string}
      * @memberof InvoiceClass
      */
     'billingIntervalFrom': string;
     /**
-     * Invoice billing interval to
+     * End date of billing interval.
      * @type {string}
      * @memberof InvoiceClass
      */
     'billingIntervalTo': string;
     /**
-     * Invoice created at
+     * Time at which the object was created.
      * @type {string}
      * @memberof InvoiceClass
      */
     'createdAt': string;
     /**
-     * Invoice items
+     * Invoice items.
      * @type {Array<SharedInvoiceItemClass>}
      * @memberof InvoiceClass
      */
     'invoiceItems': Array<SharedInvoiceItemClass>;
     /**
-     * Currency. Set to EUR by default
-     * @type {CurrencyClass}
+     * Invoice statuses.
+     * @type {Array<SharedInvoiceStatusClass>}
+     * @memberof InvoiceClass
+     */
+    'statuses': Array<SharedInvoiceStatusClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {string}
      * @memberof InvoiceClass
      */
-    'currency': CurrencyClass;
+    'currency': string;
 }
 export declare const InvoiceClassTypeEnum: {
     readonly Initial: "initial";

package/dist/models/lead-class.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 import { CreateAccountRequestDto } from './create-account-request-dto';
+import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
 import { CreatePolicyRequestDto } from './create-policy-request-dto';
+import { InvoiceClass } from './invoice-class';
 import { LeadBankAccountClass } from './lead-bank-account-class';
 import { PremiumOverrideRequestClass } from './premium-override-request-class';
 import { UploadedDocumentDto } from './uploaded-document-dto';
@@ -92,6 +94,18 @@ export interface LeadClass {
      * @memberof LeadClass
      */
     'ern': string;
+    /**
+     * Quote or price details.
+     * @type {InvoiceClass}
+     * @memberof LeadClass
+     */
+    'quote': InvoiceClass;
+    /**
+     * Payment method. When a payment method is provided, it needs to be handled in the workflow based on its type.
+     * @type {CreatePaymentMethodRequestDto}
+     * @memberof LeadClass
+     */
+    'paymentMethod': CreatePaymentMethodRequestDto;
     /**
      * Time at which the object was created.
      * @type {string}

package/dist/models/premium-override-dto.d.ts

@@ -48,6 +48,7 @@ export declare const PremiumOverrideDtoUnitEnum: {
     readonly Day: "day";
     readonly Week: "week";
     readonly Month: "month";
+    readonly Quarter: "quarter";
     readonly Year: "year";
     readonly OneTimePayment: "oneTimePayment";
 };

package/dist/models/premium-override-dto.js

@@ -21,6 +21,7 @@ exports.PremiumOverrideDtoUnitEnum = {
     Day: 'day',
     Week: 'week',
     Month: 'month',
+    Quarter: 'quarter',
     Year: 'year',
     OneTimePayment: 'oneTimePayment'
 };

package/dist/models/sepa-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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 SepaDto
+ */
+export interface SepaDto {
+    /**
+     *
+     * @type {string}
+     * @memberof SepaDto
+     */
+    'iban': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SepaDto
+     */
+    'holderName'?: string;
+}

package/dist/models/sepa-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/shared-invoice-item-class.d.ts

@@ -16,87 +16,114 @@
  */
 export interface SharedInvoiceItemClass {
     /**
-     * product name
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SharedInvoiceItemClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the premium formula.
+     * @type {number}
+     * @memberof SharedInvoiceItemClass
+     */
+    'premiumFormulaId': number;
+    /**
+     * Product name.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
     'name': string;
     /**
-     * tax code
+     * Unique identifier of the tax that this object belongs to.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
     'taxCode': string;
     /**
-     * Invoice type
+     * The Premium unit determined based on time or distance.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
-    'unit': string;
+    'unit': SharedInvoiceItemClassUnitEnum;
     /**
-     * group
+     * Invoice group.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
     'group': string;
     /**
-     * Item quantity
+     * Item quantity property determines number of days during the billing interval.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'quantity': number;
     /**
-     * Item price per unit
+     * Item price per unit.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'pricePerUnit': number;
     /**
-     * Item tax rate
+     * Item tax rate.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'taxRate': number;
     /**
-     * Net amount
+     * Net amount is in cents. It is calculated by multiplying the quantity and the price Per unit.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'netAmount': number;
     /**
-     * Net tax amount
+     * Tax amount is in cents.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'taxAmount': number;
     /**
-     * Gross amount
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'grossAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof SharedInvoiceItemClass
      */
     'creditAmount': number;
     /**
-     * Surcharge amount
-     * @type {number}
+     * This is the date from which the invoice item interval starts.
+     * @type {string}
      * @memberof SharedInvoiceItemClass
      */
-    'surcharge': number;
+    'billingIntervalFrom': string;
     /**
-     * Invoice item interval from
+     * This is the date that the invoice item interval ends.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
-    'billingIntervalFrom': string;
+    'billingIntervalTo': string;
     /**
-     * Invoice item interval to
+     * Type of Premium item.
      * @type {string}
      * @memberof SharedInvoiceItemClass
      */
-    'billingIntervalTo': string;
+    'itemType'?: string;
+    /**
+     * Visibility of Premium item.
+     * @type {string}
+     * @memberof SharedInvoiceItemClass
+     */
+    'visibility'?: string;
 }
+export declare const SharedInvoiceItemClassUnitEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Quarter: "quarter";
+    readonly Year: "year";
+    readonly OneTimePayment: "oneTimePayment";
+};
+export type SharedInvoiceItemClassUnitEnum = typeof SharedInvoiceItemClassUnitEnum[keyof typeof SharedInvoiceItemClassUnitEnum];

package/dist/models/shared-invoice-item-class.js

@@ -13,3 +13,12 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedInvoiceItemClassUnitEnum = void 0;
+exports.SharedInvoiceItemClassUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Quarter: 'quarter',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+};

package/dist/models/shared-invoice-status-class.d.ts

@@ -0,0 +1,47 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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 SharedInvoiceStatusClass
+ */
+export interface SharedInvoiceStatusClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SharedInvoiceStatusClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the invoice.
+     * @type {number}
+     * @memberof SharedInvoiceStatusClass
+     */
+    'invoiceId': number;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof SharedInvoiceStatusClass
+     */
+    'status': SharedInvoiceStatusClassStatusEnum;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof SharedInvoiceStatusClass
+     */
+    'createdAt': string;
+}
+export declare const SharedInvoiceStatusClassStatusEnum: {
+    readonly Open: "open";
+    readonly Paid: "paid";
+};
+export type SharedInvoiceStatusClassStatusEnum = typeof SharedInvoiceStatusClassStatusEnum[keyof typeof SharedInvoiceStatusClassStatusEnum];

package/dist/models/shared-invoice-status-class.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedInvoiceStatusClassStatusEnum = void 0;
+exports.SharedInvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+};

package/dist/models/update-customer-claim-request-dto.d.ts

@@ -15,6 +15,12 @@
  * @interface UpdateCustomerClaimRequestDto
  */
 export interface UpdateCustomerClaimRequestDto {
+    /**
+     * Unique identifier of the claim that this object belongs to.
+     * @type {string}
+     * @memberof UpdateCustomerClaimRequestDto
+     */
+    'code': string;
     /**
      * Field to enter the claim title.
      * @type {string}
@@ -111,10 +117,4 @@ export interface UpdateCustomerClaimRequestDto {
      * @memberof UpdateCustomerClaimRequestDto
      */
     'customerCode'?: string;
-    /**
-     * The identifier code for the claim that will be updated
-     * @type {string}
-     * @memberof UpdateCustomerClaimRequestDto
-     */
-    'code'?: string;
 }