@emilgroup/billing-sdk-node 1.3.0 → 1.4.1

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

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

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

@@ -6,7 +6,7 @@
  * 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

package/dist/models/revert-invoice-request-dto.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 RevertInvoiceRequestDto
+ */
+export interface RevertInvoiceRequestDto {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof RevertInvoiceRequestDto
+     */
+    'invoiceCode': string;
+}

package/dist/models/revert-invoice-request-dto.js

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

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

@@ -3,7 +3,7 @@
  * 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
@@ -18,45 +18,45 @@ import { PolicyPremiumDto } from './policy-premium-dto';
  */
 export interface TimesliceDto {
     /**
-     *
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof TimesliceDto
+     */
+    'id': number;
+    /**
+     * Timeslice policy data.
      * @type {Array<PolicyObjectDto>}
      * @memberof TimesliceDto
      */
     'policyObjects': Array<PolicyObjectDto>;
     /**
-     *
+     * Timeslice validity start.
      * @type {string}
      * @memberof TimesliceDto
      */
     'from': string;
     /**
-     *
+     * Timeslice validity end.
      * @type {string}
      * @memberof TimesliceDto
      */
     'to': string;
     /**
-     *
+     * Time at which the object was created.
      * @type {string}
      * @memberof TimesliceDto
      */
     'createdAt': string;
     /**
-     *
+     * Time at which the object was updated.
      * @type {string}
      * @memberof TimesliceDto
      */
     'updatedAt': string;
     /**
-     *
+     * Timeslice premium.
      * @type {PolicyPremiumDto}
      * @memberof TimesliceDto
      */
     'premium': PolicyPremiumDto;
-    /**
-     *
-     * @type {number}
-     * @memberof TimesliceDto
-     */
-    'id': number;
 }

package/dist/models/timeslice-dto.js

@@ -6,7 +6,7 @@
  * 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

package/index.ts

@@ -5,7 +5,7 @@
  * 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
@@ -13,7 +13,7 @@
  */
 
 
-export { BaseAPI } from "./base";
+export { Environment, BaseAPI } from "./base";
 export * from "./api";
 export * from "./configuration";
 export * from "./models";

package/models/create-correction-invoices-response-class.ts

@@ -5,7 +5,7 @@
  * 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
@@ -13,7 +13,7 @@
  */
 
 
-import { InvoiceClass } from './invoice-class';
+import { OmitTypeClass } from './omit-type-class';
 
 /**
  * 
@@ -22,10 +22,10 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface CreateCorrectionInvoicesResponseClass {
     /**
-     * Correction invoices response
-     * @type {Array<InvoiceClass>}
+     * Correction invoices response.
+     * @type {OmitTypeClass}
      * @memberof CreateCorrectionInvoicesResponseClass
      */
-    'invoices': Array<InvoiceClass>;
+    'invoices': OmitTypeClass;
 }
 

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

@@ -5,7 +5,7 @@
  * 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
@@ -21,13 +21,13 @@
  */
 export interface CreateCustomEstimatedInvoiceRequestDto {
     /**
-     * Customer custom data for premium calculation
+     * Required data to create a custom application.
      * @type {object}
      * @memberof CreateCustomEstimatedInvoiceRequestDto
      */
     'data': object;
     /**
-     * Custom premium provider
+     * Custom premium provider.
      * @type {string}
      * @memberof CreateCustomEstimatedInvoiceRequestDto
      */

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

@@ -5,7 +5,7 @@
  * 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

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

@@ -5,7 +5,7 @@
  * 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
@@ -22,13 +22,13 @@ import { PolicyDto } from './policy-dto';
  */
 export interface CreateEstimatedInvoiceRequestDto {
     /**
-     * 
+     * Policy.
      * @type {PolicyDto}
      * @memberof CreateEstimatedInvoiceRequestDto
      */
     'policy': PolicyDto;
     /**
-     * metadata
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof CreateEstimatedInvoiceRequestDto
      */

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

@@ -5,7 +5,7 @@
  * 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
@@ -22,13 +22,13 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface CreateEstimatedInvoiceResponseClass {
     /**
-     * Recurring invoice response
+     * Estimated invoice response.
      * @type {InvoiceClass}
      * @memberof CreateEstimatedInvoiceResponseClass
      */
     'invoice': InvoiceClass;
     /**
-     * Recurring invoice response
+     * 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
      */

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

@@ -5,7 +5,7 @@
  * 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
@@ -21,53 +21,53 @@
  */
 export interface CreateInvoiceRequestDto {
     /**
-     * Invoice number
+     * Unique number for the invoice. If not set, the system will automatically assign a value.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'invoiceNumber'?: string;
     /**
-     * account number
+     * Account number.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'accountNumber': string;
     /**
-     * Policy code
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'policyCode': string;
     /**
-     * metadata
+     * 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;
     /**
-     * Interval from date
+     * This is the date from which the invoice item interval starts.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'billingIntervalFrom': string;
     /**
-     * Interval to date
+     * This is the date that the invoice item interval ends.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'billingIntervalTo': string;
     /**
-     * Invoice due date
+     * Invoice due date.
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
     'dueDate'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof CreateInvoiceRequestDto
-     */
-    'type': CreateInvoiceRequestDtoTypeEnum;
 }
 
 export const CreateInvoiceRequestDtoTypeEnum = {
@@ -76,7 +76,9 @@ export const CreateInvoiceRequestDtoTypeEnum = {
     Correction: 'correction',
     Estimated: 'estimated',
     Penalty: 'penalty',
-    Other: 'other'
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
 } as const;
 
 export type CreateInvoiceRequestDtoTypeEnum = typeof CreateInvoiceRequestDtoTypeEnum[keyof typeof CreateInvoiceRequestDtoTypeEnum];

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

@@ -5,7 +5,7 @@
  * 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
@@ -13,7 +13,7 @@
  */
 
 
-import { InvoiceClass } from './invoice-class';
+import { OmitTypeClass } from './omit-type-class';
 
 /**
  * 
@@ -22,10 +22,10 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface CreateInvoiceResponseClass {
     /**
-     * Recurring invoice response
-     * @type {InvoiceClass}
+     * Invoice response.
+     * @type {OmitTypeClass}
      * @memberof CreateInvoiceResponseClass
      */
-    'invoice': InvoiceClass;
+    '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

@@ -5,15 +5,22 @@ export * from './create-estimated-invoice-request-dto';
 export * from './create-estimated-invoice-response-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 './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';