@emilgroup/billing-sdk-node 1.4.0 → 1.5.0

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

@@ -0,0 +1,77 @@
+/**
+ * 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 declare const CreateInvoiceRequestDtoTypeEnum: {
+    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 CreateInvoiceRequestDtoTypeEnum = typeof CreateInvoiceRequestDtoTypeEnum[keyof typeof CreateInvoiceRequestDtoTypeEnum];

package/dist/models/{premium-override-dto.js → create-invoice-request-dto.js}

@@ -2,8 +2,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,14 +13,14 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PremiumOverrideDtoUnitEnum = exports.PremiumOverrideDtoTypeEnum = void 0;
-exports.PremiumOverrideDtoTypeEnum = {
-    Time: 'time'
-};
-exports.PremiumOverrideDtoUnitEnum = {
-    Day: 'day',
-    Week: 'week',
-    Month: 'month',
-    Year: 'year',
-    OneTimePayment: 'oneTimePayment'
+exports.CreateInvoiceRequestDtoTypeEnum = void 0;
+exports.CreateInvoiceRequestDtoTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
 };

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+import { OmitTypeClass } from './omit-type-class';
+/**
+ *
+ * @export
+ * @interface CreateInvoiceResponseClass
+ */
+export interface CreateInvoiceResponseClass {
+    /**
+     * Invoice response.
+     * @type {OmitTypeClass}
+     * @memberof CreateInvoiceResponseClass
+     */
+    'invoice': OmitTypeClass;
+}

package/dist/models/{complete-stripe-payment-setup-request-dto.js → create-invoice-response-class.js}

@@ -2,8 +2,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

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

@@ -0,0 +1,35 @@
+/**
+ * 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 declare const CreateInvoiceStatusRequestDtoStatusEnum: {
+    readonly Open: "open";
+    readonly Paid: "paid";
+};
+export type CreateInvoiceStatusRequestDtoStatusEnum = typeof CreateInvoiceStatusRequestDtoStatusEnum[keyof typeof CreateInvoiceStatusRequestDtoStatusEnum];

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/{complete-payment-setup-response-class.js → create-termination-invoice-request-dto.js}

@@ -2,8 +2,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

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

@@ -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/dist/models/index.js

@@ -14,55 +14,29 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./complete-braintree-payment-setup-request-dto"), exports);
-__exportStar(require("./complete-payment-setup-request-dto"), exports);
-__exportStar(require("./complete-payment-setup-response-class"), exports);
-__exportStar(require("./complete-stripe-payment-setup-request-dto"), exports);
-__exportStar(require("./create-account-request-dto"), exports);
-__exportStar(require("./create-bank-account-request-dto"), exports);
-__exportStar(require("./create-custom-application-request-dto"), exports);
-__exportStar(require("./create-custom-application-response-class"), exports);
-__exportStar(require("./create-document-request-dto"), exports);
+__exportStar(require("./create-correction-invoices-response-class"), exports);
+__exportStar(require("./create-custom-estimated-invoice-request-dto"), exports);
+__exportStar(require("./create-custom-estimated-invoice-response-class"), exports);
 __exportStar(require("./create-estimated-invoice-request-dto"), exports);
 __exportStar(require("./create-estimated-invoice-response-class"), exports);
-__exportStar(require("./create-lead-request-dto"), exports);
-__exportStar(require("./create-lead-response-class"), exports);
-__exportStar(require("./document-class"), exports);
-__exportStar(require("./get-custom-css-response-class"), exports);
-__exportStar(require("./get-lead-response-class"), exports);
-__exportStar(require("./get-public-psp-settings-response-class"), exports);
-__exportStar(require("./initiate-braintree-payment-setup-request-dto"), exports);
-__exportStar(require("./initiate-braintree-payment-setup-response-class"), exports);
-__exportStar(require("./initiate-lead-response-class"), exports);
-__exportStar(require("./initiate-payment-setup-request-dto"), exports);
-__exportStar(require("./initiate-payment-setup-response-class"), exports);
-__exportStar(require("./initiate-stripe-payment-setup-request-dto"), exports);
-__exportStar(require("./initiate-stripe-payment-setup-response-class"), exports);
-__exportStar(require("./insured-object-class"), exports);
-__exportStar(require("./insured-object-type-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("./lead-account-class"), exports);
-__exportStar(require("./lead-bank-account-class"), exports);
-__exportStar(require("./lead-class"), exports);
-__exportStar(require("./lead-policy-class"), exports);
-__exportStar(require("./lead-policy-object-class"), exports);
-__exportStar(require("./list-documents-response-class"), exports);
-__exportStar(require("./list-products-response-class"), exports);
-__exportStar(require("./payment-method-class"), exports);
-__exportStar(require("./policy-object-request-dto"), exports);
-__exportStar(require("./policy-premium-class"), exports);
-__exportStar(require("./policy-premium-item-class"), exports);
-__exportStar(require("./premium-formula-class"), exports);
-__exportStar(require("./premium-override-dto"), exports);
-__exportStar(require("./premium-override-request-dto"), exports);
-__exportStar(require("./product-class"), exports);
-__exportStar(require("./product-factor-class"), exports);
-__exportStar(require("./product-field-class"), exports);
-__exportStar(require("./product-version-class"), exports);
-__exportStar(require("./send-notification-request-dto"), exports);
-__exportStar(require("./send-notification-response-class"), exports);
-__exportStar(require("./update-lead-request-dto"), exports);
-__exportStar(require("./update-lead-response-class"), exports);
-__exportStar(require("./uploaded-document-dto"), 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

@@ -1,6 +1,6 @@
 /**
- * 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
@@ -9,6 +9,7 @@
  * 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';
 /**
@@ -30,7 +31,7 @@ export interface InvoiceClass {
      */
     'policyCode': string;
     /**
-     * Account number
+     * Account number.
      * @type {string}
      * @memberof InvoiceClass
      */
@@ -46,7 +47,7 @@ export interface InvoiceClass {
      * @type {string}
      * @memberof InvoiceClass
      */
-    'type': string;
+    'type': InvoiceClassTypeEnum;
     /**
      * Invoice number.
      * @type {string}
@@ -54,35 +55,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}
@@ -90,19 +91,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
      */
@@ -114,15 +115,37 @@ 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 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

@@ -2,8 +2,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,3 +13,18 @@
  * 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'
+};