@emilgroup/billing-sdk-node 1.4.0 → 1.5.0

package/dist/models/invoice-item-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
@@ -40,19 +40,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
      */
@@ -70,19 +70,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
      */
@@ -106,3 +106,12 @@ export interface 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

@@ -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,12 @@
  * 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

@@ -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
@@ -28,11 +28,11 @@ export interface InvoiceStatusClass {
      */
     'invoiceId': number;
     /**
-     * Invoice type
+     * Invoice type.
      * @type {string}
      * @memberof InvoiceStatusClass
      */
-    'status': string;
+    'status': InvoiceStatusClassStatusEnum;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -40,3 +40,8 @@ export interface 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

@@ -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,8 @@
  * 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

@@ -0,0 +1,31 @@
+/**
+ * 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 { InvoiceClass } from './invoice-class';
+/**
+ *
+ * @export
+ * @interface ListInvoicesResponseClass
+ */
+export interface ListInvoicesResponseClass {
+    /**
+     * Invoices list items.
+     * @type {Array<InvoiceClass>}
+     * @memberof ListInvoicesResponseClass
+     */
+    'items': Array<InvoiceClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListInvoicesResponseClass
+     */
+    'nextPageToken': string;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { PolicyBillingDateClass } from './policy-billing-date-class';
+/**
+ *
+ * @export
+ * @interface ListPoliciesBillingDatesResponseClass
+ */
+export interface ListPoliciesBillingDatesResponseClass {
+    /**
+     * Invoices list items.
+     * @type {Array<PolicyBillingDateClass>}
+     * @memberof ListPoliciesBillingDatesResponseClass
+     */
+    'items': Array<PolicyBillingDateClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListPoliciesBillingDatesResponseClass
+     */
+    'nextPageToken': string;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 ListRequestDto
+ */
+export interface ListRequestDto {
+    /**
+     * Page size
+     * @type {number}
+     * @memberof ListRequestDto
+     */
+    'pageSize'?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'pageToken'?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'filter'?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'search'?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'order'?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'expand'?: string;
+}

package/dist/models/list-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/omit-type-class.d.ts

@@ -0,0 +1,144 @@
+/**
+ * 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 { CurrencyClass } from './currency-class';
+import { InvoiceItemClass } from './invoice-item-class';
+/**
+ *
+ * @export
+ * @interface OmitTypeClass
+ */
+export interface OmitTypeClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'policyCode': string;
+    /**
+     * Account number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'accountNumber': string;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'code': string;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'type': OmitTypeClassTypeEnum;
+    /**
+     * Invoice number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'invoiceNumber': string;
+    /**
+     * Net amount is in cents.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'netAmount': number;
+    /**
+     * Tax amount is in cents.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'taxAmount': number;
+    /**
+     * Credit amount.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'creditAmount': number;
+    /**
+     * Gross amount. This property is sum of taxAmount and netAmount.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'grossAmount': number;
+    /**
+     * Invoice status.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'status': OmitTypeClassStatusEnum;
+    /**
+     * Invoice due date.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'dueDate': string;
+    /**
+     * Metadata contains extra information that the object would need for specific cases.
+     * @type {object}
+     * @memberof OmitTypeClass
+     */
+    'metadata': object;
+    /**
+     * Start date of billing interval.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'billingIntervalFrom': string;
+    /**
+     * End date of billing interval.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'billingIntervalTo': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'createdAt': string;
+    /**
+     * Invoice items.
+     * @type {Array<InvoiceItemClass>}
+     * @memberof OmitTypeClass
+     */
+    'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {CurrencyClass}
+     * @memberof OmitTypeClass
+     */
+    'currency': CurrencyClass;
+}
+export declare const OmitTypeClassTypeEnum: {
+    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 OmitTypeClassTypeEnum = typeof OmitTypeClassTypeEnum[keyof typeof OmitTypeClassTypeEnum];
+export declare const OmitTypeClassStatusEnum: {
+    readonly Open: "open";
+    readonly Paid: "paid";
+};
+export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];

package/dist/models/omit-type-class.js

@@ -0,0 +1,30 @@
+"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.OmitTypeClassStatusEnum = exports.OmitTypeClassTypeEnum = void 0;
+exports.OmitTypeClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+};
+exports.OmitTypeClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+};

package/dist/models/policy-billing-date-class.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 PolicyBillingDateClass
+ */
+export interface PolicyBillingDateClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PolicyBillingDateClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'policyCode': string;
+    /**
+     * The next billing date this policy will be invoiced.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'nextBillingDate': string;
+    /**
+     * This field will be set to true once an invoice has been created on this specific billing date.     It is there to avoid a policy being invoiced multiple times in case of retry.
+     * @type {boolean}
+     * @memberof PolicyBillingDateClass
+     */
+    'isInvoiced': boolean;
+}

package/dist/models/policy-billing-date-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/policy-dto.d.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 { PolicyVersionDto } from './policy-version-dto';
+/**
+ *
+ * @export
+ * @interface PolicyDto
+ */
+export interface PolicyDto {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PolicyDto
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'code': string;
+    /**
+     * Policy number.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'policyNumber': string;
+    /**
+     * Internal policy number.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'internalPolicyNumber': string;
+    /**
+     * Unique identifier referencing the policy product version.
+     * @type {number}
+     * @memberof PolicyDto
+     */
+    'productVersionId': number;
+    /**
+     * Unique identifier referencing the policy product.
+     * @type {number}
+     * @memberof PolicyDto
+     */
+    'productId': number;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'accountCode': string;
+    /**
+     * Policy status. This property shows different statuses depending on the status of a policy:                    ACTIVE, WITHDRAW, TERMINATED, SUSPENDED.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'status': PolicyDtoStatusEnum;
+    /**
+     * Policy holder.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'holder': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'updatedAt': string;
+    /**
+     * Policy versions.
+     * @type {Array<PolicyVersionDto>}
+     * @memberof PolicyDto
+     */
+    'versions': Array<PolicyVersionDto>;
+    /**
+     * Product name.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'productName': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'productSlug': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'policyStartDate': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'ern': string;
+}
+export declare const PolicyDtoStatusEnum: {
+    readonly Active: "ACTIVE";
+    readonly Withdraw: "WITHDRAW";
+    readonly Terminated: "TERMINATED";
+    readonly Suspended: "SUSPENDED";
+};
+export type PolicyDtoStatusEnum = typeof PolicyDtoStatusEnum[keyof typeof PolicyDtoStatusEnum];