@emilgroup/billing-sdk-node 1.4.0 → 1.4.1

package/models/create-estimated-invoice-request-dto.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Emil PublicAPI
- * The Emil Public API description
+ * EMIL BillingService
+ * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -13,8 +13,7 @@
  */
 
 
-import { PolicyObjectRequestDto } from './policy-object-request-dto';
-import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+import { PolicyDto } from './policy-dto';
 
 /**
  * 
@@ -23,42 +22,16 @@ import { PremiumOverrideRequestDto } from './premium-override-request-dto';
  */
 export interface CreateEstimatedInvoiceRequestDto {
     /**
-     * Unique identifier referencing the product version.
-     * @type {number}
+     * Policy.
+     * @type {PolicyDto}
      * @memberof CreateEstimatedInvoiceRequestDto
      */
-    'productVersionId'?: number;
+    'policy': PolicyDto;
     /**
-     * The policy objects to calculate premium.
-     * @type {Array<PolicyObjectRequestDto>}
-     * @memberof CreateEstimatedInvoiceRequestDto
-     */
-    'policyObjects'?: Array<PolicyObjectRequestDto>;
-    /**
-     * Customer custom data for premium calculation. Necessary when no policyObjects are provided.
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof CreateEstimatedInvoiceRequestDto
      */
-    'data'?: object;
-    /**
-     * Custom provider name. Necessary if data is provided.
-     * @type {string}
-     * @memberof CreateEstimatedInvoiceRequestDto
-     */
-    'provider'?: CreateEstimatedInvoiceRequestDtoProviderEnum;
-    /**
-     * Premium Override.
-     * @type {PremiumOverrideRequestDto}
-     * @memberof CreateEstimatedInvoiceRequestDto
-     */
-    'premiumOverride'?: PremiumOverrideRequestDto;
+    'metadata': object;
 }
 
-export const CreateEstimatedInvoiceRequestDtoProviderEnum = {
-    Squarelife: 'squarelife',
-    Janitos: 'janitos'
-} as const;
-
-export type CreateEstimatedInvoiceRequestDtoProviderEnum = typeof CreateEstimatedInvoiceRequestDtoProviderEnum[keyof typeof CreateEstimatedInvoiceRequestDtoProviderEnum];
-
-

package/models/create-estimated-invoice-response-class.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Emil PublicAPI
- * The Emil Public API description
+ * EMIL BillingService
+ * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -22,16 +22,16 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface CreateEstimatedInvoiceResponseClass {
     /**
-     * Estimated invoice response
+     * Estimated invoice response.
      * @type {InvoiceClass}
      * @memberof CreateEstimatedInvoiceResponseClass
      */
-    'invoice'?: InvoiceClass;
+    'invoice': InvoiceClass;
     /**
-     * In some cases, custom premium calculation needs to be used.      In that case, a custom object is returned. It can hold up any kind of information. For more information,      check the general documentation.
+     * In some cases, custom premium calculation needs to be used. In that case, a custom object is returned.      It can hold up any kind of information. For more information, check the general documentation.
      * @type {object}
      * @memberof CreateEstimatedInvoiceResponseClass
      */
-    'custom'?: object;
+    'custom': object;
 }
 

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

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService 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 CreateInvoiceRequestDto
+ */
+export interface CreateInvoiceRequestDto {
+    /**
+     * Unique number for the invoice. If not set, the system will automatically assign a value.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'invoiceNumber'?: string;
+    /**
+     * Account number.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'accountNumber': string;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'policyCode': string;
+    /**
+     * Type of the invoice.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'type': CreateInvoiceRequestDtoTypeEnum;
+    /**
+     * Metadata contains extra information that the object would need for specific cases.
+     * @type {object}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'metadata'?: object;
+    /**
+     * This is the date from which the invoice item interval starts.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'billingIntervalFrom': string;
+    /**
+     * This is the date that the invoice item interval ends.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'billingIntervalTo': string;
+    /**
+     * Invoice due date.
+     * @type {string}
+     * @memberof CreateInvoiceRequestDto
+     */
+    'dueDate'?: string;
+}
+
+export const CreateInvoiceRequestDtoTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type CreateInvoiceRequestDtoTypeEnum = typeof CreateInvoiceRequestDtoTypeEnum[keyof typeof CreateInvoiceRequestDtoTypeEnum];
+
+

package/models/{get-lead-response-class.ts → create-invoice-response-class.ts}

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Emil PublicAPI
- * The Emil Public API description
+ * EMIL BillingService
+ * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -13,19 +13,19 @@
  */
 
 
-import { LeadClass } from './lead-class';
+import { OmitTypeClass } from './omit-type-class';
 
 /**
  * 
  * @export
- * @interface GetLeadResponseClass
+ * @interface CreateInvoiceResponseClass
  */
-export interface GetLeadResponseClass {
+export interface CreateInvoiceResponseClass {
     /**
-     * The list of leads.
-     * @type {LeadClass}
-     * @memberof GetLeadResponseClass
+     * Invoice response.
+     * @type {OmitTypeClass}
+     * @memberof CreateInvoiceResponseClass
      */
-    'lead': LeadClass;
+    'invoice': OmitTypeClass;
 }
 

package/models/create-invoice-status-request-dto.ts

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService 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 CreateInvoiceStatusRequestDto
+ */
+export interface CreateInvoiceStatusRequestDto {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateInvoiceStatusRequestDto
+     */
+    'invoiceId': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateInvoiceStatusRequestDto
+     */
+    'status': CreateInvoiceStatusRequestDtoStatusEnum;
+}
+
+export const CreateInvoiceStatusRequestDtoStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type CreateInvoiceStatusRequestDtoStatusEnum = typeof CreateInvoiceStatusRequestDtoStatusEnum[keyof typeof CreateInvoiceStatusRequestDtoStatusEnum];
+
+

package/models/create-termination-invoice-request-dto.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService 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 CreateTerminationInvoiceRequestDto
+ */
+export interface CreateTerminationInvoiceRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'policyCode': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'accountNumber': string;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'metadata'?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'billingIntervalFrom': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'billingIntervalTo': string;
+}
+

package/models/currency-class.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService 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 CurrencyClass
+ */
+export interface CurrencyClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof CurrencyClass
+     */
+    'id': number;
+    /**
+     * Name of currency in English.
+     * @type {string}
+     * @memberof CurrencyClass
+     */
+    'name': string;
+    /**
+     * Name of currency in native language.
+     * @type {string}
+     * @memberof CurrencyClass
+     */
+    'nativeName': string;
+    /**
+     * Code defined by ISO 4217 standard.
+     * @type {string}
+     * @memberof CurrencyClass
+     */
+    'code': string;
+    /**
+     * Currency symbols are graphical representations used to denote a particular currency in written or printed form.
+     * @type {string}
+     * @memberof CurrencyClass
+     */
+    'symbol': string;
+}
+

package/models/index.ts

@@ -1,52 +1,26 @@
-export * from './complete-braintree-payment-setup-request-dto';
-export * from './complete-payment-setup-request-dto';
-export * from './complete-payment-setup-response-class';
-export * from './complete-stripe-payment-setup-request-dto';
-export * from './create-account-request-dto';
-export * from './create-bank-account-request-dto';
-export * from './create-custom-application-request-dto';
-export * from './create-custom-application-response-class';
-export * from './create-document-request-dto';
+export * from './create-correction-invoices-response-class';
+export * from './create-custom-estimated-invoice-request-dto';
+export * from './create-custom-estimated-invoice-response-class';
 export * from './create-estimated-invoice-request-dto';
 export * from './create-estimated-invoice-response-class';
-export * from './create-lead-request-dto';
-export * from './create-lead-response-class';
-export * from './document-class';
-export * from './get-custom-css-response-class';
-export * from './get-lead-response-class';
-export * from './get-public-psp-settings-response-class';
-export * from './initiate-braintree-payment-setup-request-dto';
-export * from './initiate-braintree-payment-setup-response-class';
-export * from './initiate-lead-response-class';
-export * from './initiate-payment-setup-request-dto';
-export * from './initiate-payment-setup-response-class';
-export * from './initiate-stripe-payment-setup-request-dto';
-export * from './initiate-stripe-payment-setup-response-class';
-export * from './insured-object-class';
-export * from './insured-object-type-class';
+export * from './create-invoice-request-dto';
+export * from './create-invoice-response-class';
+export * from './create-invoice-status-request-dto';
+export * from './create-termination-invoice-request-dto';
+export * from './currency-class';
 export * from './invoice-class';
 export * from './invoice-item-class';
 export * from './invoice-status-class';
-export * from './lead-account-class';
-export * from './lead-bank-account-class';
-export * from './lead-class';
-export * from './lead-policy-class';
-export * from './lead-policy-object-class';
-export * from './list-documents-response-class';
-export * from './list-products-response-class';
-export * from './payment-method-class';
-export * from './policy-object-request-dto';
-export * from './policy-premium-class';
-export * from './policy-premium-item-class';
-export * from './premium-formula-class';
-export * from './premium-override-dto';
-export * from './premium-override-request-dto';
-export * from './product-class';
-export * from './product-factor-class';
-export * from './product-field-class';
-export * from './product-version-class';
-export * from './send-notification-request-dto';
-export * from './send-notification-response-class';
-export * from './update-lead-request-dto';
-export * from './update-lead-response-class';
-export * from './uploaded-document-dto';
+export * from './list-invoices-response-class';
+export * from './list-policies-billing-dates-response-class';
+export * from './list-request-dto';
+export * from './omit-type-class';
+export * from './policy-billing-date-class';
+export * from './policy-dto';
+export * from './policy-object-dto';
+export * from './policy-premium-dto';
+export * from './policy-premium-item-dto';
+export * from './policy-version-dto';
+export * from './premium-formula-dto';
+export * from './revert-invoice-request-dto';
+export * from './timeslice-dto';

package/models/invoice-class.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Emil PublicAPI
- * The Emil Public API description
+ * EMIL BillingService
+ * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -13,6 +13,7 @@
  */
 
 
+import { CurrencyClass } from './currency-class';
 import { InvoiceItemClass } from './invoice-item-class';
 import { InvoiceStatusClass } from './invoice-status-class';
 
@@ -35,7 +36,7 @@ export interface InvoiceClass {
      */
     'policyCode': string;
     /**
-     * Account number
+     * Account number.
      * @type {string}
      * @memberof InvoiceClass
      */
@@ -51,7 +52,7 @@ export interface InvoiceClass {
      * @type {string}
      * @memberof InvoiceClass
      */
-    'type': string;
+    'type': InvoiceClassTypeEnum;
     /**
      * Invoice number.
      * @type {string}
@@ -59,35 +60,35 @@ export interface 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;
     /**
-     * Gross amount.
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'grossAmount': number;
     /**
-     * It shows the status of the invoice that is paid or open.
+     * Invoice status.
      * @type {string}
      * @memberof InvoiceClass
      */
-    'status': string;
+    'status': InvoiceClassStatusEnum;
     /**
      * Invoice due date.
      * @type {string}
@@ -95,19 +96,19 @@ export interface InvoiceClass {
      */
     'dueDate': string;
     /**
-     * Metadata contains extra information that the invoice would need for specific cases.
+     * 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
      */
@@ -119,16 +120,42 @@ export interface InvoiceClass {
      */
     'createdAt': string;
     /**
-     * Invoice items
+     * Invoice items.
      * @type {Array<InvoiceItemClass>}
      * @memberof InvoiceClass
      */
     'invoiceItems': Array<InvoiceItemClass>;
     /**
-     * Invoice statuses
+     * Invoice statuses.
      * @type {Array<InvoiceStatusClass>}
      * @memberof InvoiceClass
      */
     'statuses': Array<InvoiceStatusClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {CurrencyClass}
+     * @memberof InvoiceClass
+     */
+    'currency': CurrencyClass;
 }
 
+export const InvoiceClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof InvoiceClassTypeEnum];
+export const InvoiceClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];
+
+

package/models/invoice-item-class.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Emil PublicAPI
- * The Emil Public API description
+ * EMIL BillingService
+ * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -45,19 +45,19 @@ export interface InvoiceItemClass {
      */
     'taxCode': string;
     /**
-     * This is unit of Premium. Premium units are determined based on day, week, month and year.
+     * Unit of Premium..Premium units are determined based on time or distance.
      * @type {string}
      * @memberof InvoiceItemClass
      */
-    'unit': string;
+    'unit': InvoiceItemClassUnitEnum;
     /**
-     * group
+     * Invoice group.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'group': string;
     /**
-     * Item quantity.
+     * Item quantity. this property determines number of days during the billing interval.
      * @type {number}
      * @memberof InvoiceItemClass
      */
@@ -75,19 +75,19 @@ export interface InvoiceItemClass {
      */
     'taxRate': number;
     /**
-     * Net amount.
+     * Net amount is in cents. It is calculated by multiplying the quantity and the price Per unit.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'netAmount': number;
     /**
-     * Net tax amount.
+     * Tax amount is in cents.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'taxAmount': number;
     /**
-     * Gross amount.
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
@@ -112,3 +112,15 @@ export interface InvoiceItemClass {
     'billingIntervalTo': string;
 }
 
+export const InvoiceItemClassUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Quarter: 'quarter',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+} as const;
+
+export type InvoiceItemClassUnitEnum = typeof InvoiceItemClassUnitEnum[keyof typeof InvoiceItemClassUnitEnum];
+
+