@emilgroup/billing-sdk-node 1.3.0 → 1.4.1

package/dist/models/create-invoice-status-request-dto.js

@@ -0,0 +1,20 @@
+"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 });
+exports.CreateInvoiceStatusRequestDtoStatusEnum = void 0;
+exports.CreateInvoiceStatusRequestDtoStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+};

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

@@ -0,0 +1,48 @@
+/**
+ * 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/dist/models/create-termination-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/currency-class.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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/dist/models/currency-class.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/index.d.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';

package/dist/models/index.js

@@ -21,15 +21,22 @@ __exportStar(require("./create-estimated-invoice-request-dto"), exports);
 __exportStar(require("./create-estimated-invoice-response-class"), exports);
 __exportStar(require("./create-invoice-request-dto"), exports);
 __exportStar(require("./create-invoice-response-class"), exports);
+__exportStar(require("./create-invoice-status-request-dto"), exports);
+__exportStar(require("./create-termination-invoice-request-dto"), exports);
+__exportStar(require("./currency-class"), exports);
 __exportStar(require("./invoice-class"), exports);
 __exportStar(require("./invoice-item-class"), exports);
+__exportStar(require("./invoice-status-class"), exports);
 __exportStar(require("./list-invoices-response-class"), exports);
 __exportStar(require("./list-policies-billing-dates-response-class"), exports);
 __exportStar(require("./list-request-dto"), exports);
+__exportStar(require("./omit-type-class"), exports);
+__exportStar(require("./policy-billing-date-class"), exports);
 __exportStar(require("./policy-dto"), exports);
 __exportStar(require("./policy-object-dto"), exports);
 __exportStar(require("./policy-premium-dto"), exports);
 __exportStar(require("./policy-premium-item-dto"), exports);
 __exportStar(require("./policy-version-dto"), exports);
 __exportStar(require("./premium-formula-dto"), exports);
+__exportStar(require("./revert-invoice-request-dto"), exports);
 __exportStar(require("./timeslice-dto"), exports);

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

@@ -3,13 +3,15 @@
  * 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.
  */
+import { CurrencyClass } from './currency-class';
 import { InvoiceItemClass } from './invoice-item-class';
+import { InvoiceStatusClass } from './invoice-status-class';
 /**
  *
  * @export
@@ -17,105 +19,133 @@ import { InvoiceItemClass } from './invoice-item-class';
  */
 export interface InvoiceClass {
     /**
-     * Invoice id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceClass
      */
     'id': number;
     /**
-     * policy code
+     * 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': string;
+    '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;
     /**
-     * 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': string;
+    '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<InvoiceItemClass>}
      * @memberof InvoiceClass
      */
     'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice statuses.
+     * @type {Array<InvoiceStatusClass>}
+     * @memberof InvoiceClass
+     */
+    'statuses': Array<InvoiceStatusClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {CurrencyClass}
+     * @memberof InvoiceClass
+     */
+    'currency': CurrencyClass;
 }
+export declare const InvoiceClassTypeEnum: {
+    readonly Initial: "initial";
+    readonly Recurring: "recurring";
+    readonly Correction: "correction";
+    readonly Estimated: "estimated";
+    readonly Penalty: "penalty";
+    readonly Other: "other";
+    readonly Withdraw: "withdraw";
+    readonly Final: "final";
+};
+export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof InvoiceClassTypeEnum];
+export declare const InvoiceClassStatusEnum: {
+    readonly Open: "open";
+    readonly Paid: "paid";
+};
+export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];

package/dist/models/invoice-class.js

@@ -6,10 +6,25 @@
  * 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 });
+exports.InvoiceClassStatusEnum = exports.InvoiceClassTypeEnum = void 0;
+exports.InvoiceClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+};
+exports.InvoiceClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+};

package/dist/models/invoice-item-class.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,93 +16,102 @@
  */
 export interface InvoiceItemClass {
     /**
-     * Invoice item id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'id': number;
     /**
-     * Premium formula id
+     * Unique identifier referencing the premium formula.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'premiumFormulaId': number;
     /**
-     * product name
+     * Product name.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'name': string;
     /**
-     * tax code
+     * Unique identifier of the tax that this object belongs to.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'taxCode': string;
     /**
-     * Invoice type
+     * 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
      */
     'quantity': number;
     /**
-     * Item price per unit
+     * Item price per unit.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'pricePerUnit': number;
     /**
-     * Item tax rate
+     * Item tax rate.
      * @type {number}
      * @memberof 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
      */
     'grossAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'creditAmount': number;
     /**
-     * Invoice item interval from
+     * This is the date from which the invoice item interval starts.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'billingIntervalFrom': string;
     /**
-     * Invoice item interval to
+     * This is the date that the invoice item interval ends.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'billingIntervalTo': string;
 }
+export declare const InvoiceItemClassUnitEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Quarter: "quarter";
+    readonly Year: "year";
+    readonly OneTimePayment: "oneTimePayment";
+};
+export type InvoiceItemClassUnitEnum = typeof InvoiceItemClassUnitEnum[keyof typeof InvoiceItemClassUnitEnum];

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

@@ -6,10 +6,19 @@
  * 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 });
+exports.InvoiceItemClassUnitEnum = void 0;
+exports.InvoiceItemClassUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Quarter: 'quarter',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+};

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

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

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

@@ -0,0 +1,20 @@
+"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 });
+exports.InvoiceStatusClassStatusEnum = void 0;
+exports.InvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+};

package/dist/models/list-invoices-response-class.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
@@ -17,13 +17,13 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface ListInvoicesResponseClass {
     /**
-     * Invoices list items
+     * Invoices list items.
      * @type {Array<InvoiceClass>}
      * @memberof ListInvoicesResponseClass
      */
     'items': Array<InvoiceClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListInvoicesResponseClass
      */

package/dist/models/list-invoices-response-class.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/list-policies-billing-dates-response-class.d.ts

@@ -3,12 +3,13 @@
  * 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.
  */
+import { PolicyBillingDateClass } from './policy-billing-date-class';
 /**
  *
  * @export
@@ -16,13 +17,13 @@
  */
 export interface ListPoliciesBillingDatesResponseClass {
     /**
-     * Invoices list items
-     * @type {Array<string>}
+     * Invoices list items.
+     * @type {Array<PolicyBillingDateClass>}
      * @memberof ListPoliciesBillingDatesResponseClass
      */
-    'items': Array<string>;
+    'items': Array<PolicyBillingDateClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListPoliciesBillingDatesResponseClass
      */