@emilgroup/billing-sdk-node 1.10.0 → 1.11.0

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,163 @@
+/**
+ * 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 { InvoiceItemClass } from './invoice-item-class';
+import { InvoicePaymentsClass } from './invoice-payments-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;
+    /**
+     * Policy number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'policyNumber': 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;
+    /**
+     * Paid amount. This property is amount paid by this invoice. The amount corresponds to the sum (positives and negatives) of all payments relating to that invoice.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'paidAmount': 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 {string}
+     * @memberof OmitTypeClass
+     */
+    'currency': string;
+    /**
+     * Invoice payments.
+     * @type {InvoicePaymentsClass}
+     * @memberof OmitTypeClass
+     */
+    'payments': InvoicePaymentsClass;
+}
+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";
+    readonly PartiallyPaid: "partially-paid";
+};
+export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];

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

@@ -0,0 +1,31 @@
+"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',
+    PartiallyPaid: 'partially-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];

package/dist/models/policy-dto.js

@@ -0,0 +1,22 @@
+"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.PolicyDtoStatusEnum = void 0;
+exports.PolicyDtoStatusEnum = {
+    Active: 'ACTIVE',
+    Withdraw: 'WITHDRAW',
+    Terminated: 'TERMINATED',
+    Suspended: 'SUSPENDED'
+};

package/dist/models/policy-object-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 PolicyObjectDto
+ */
+export interface PolicyObjectDto {
+    /**
+     * Unique identifier referencing the insured object.
+     * @type {number}
+     * @memberof PolicyObjectDto
+     */
+    'insuredObjectId': number;
+    /**
+     * Insured object name.
+     * @type {string}
+     * @memberof PolicyObjectDto
+     */
+    'insuredObjectName': string;
+    /**
+     * Insured object summary.
+     * @type {string}
+     * @memberof PolicyObjectDto
+     */
+    'summary': string;
+    /**
+     * Insured object data.
+     * @type {object}
+     * @memberof PolicyObjectDto
+     */
+    'data': object;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyObjectDto
+     */
+    'code': string;
+}

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

@@ -0,0 +1,49 @@
+/**
+ * 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 { PolicyPremiumItemDto } from './policy-premium-item-dto';
+/**
+ *
+ * @export
+ * @interface PolicyPremiumDto
+ */
+export interface PolicyPremiumDto {
+    /**
+     * The grand total of a policy premium is the net sum of all policy premium items.
+     * @type {number}
+     * @memberof PolicyPremiumDto
+     */
+    'grandTotal': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PolicyPremiumDto
+     */
+    'createdAt'?: string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PolicyPremiumDto
+     */
+    'updatedAt'?: string;
+    /**
+     * Premium Items.
+     * @type {Array<PolicyPremiumItemDto>}
+     * @memberof PolicyPremiumDto
+     */
+    'premiumItems': Array<PolicyPremiumItemDto>;
+    /**
+     * The currency of policy premium
+     * @type {string}
+     * @memberof PolicyPremiumDto
+     */
+    'currency': string;
+}

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

@@ -0,0 +1,55 @@
+/**
+ * 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 { PremiumFormulaDto } from './premium-formula-dto';
+/**
+ *
+ * @export
+ * @interface PolicyPremiumItemDto
+ */
+export interface PolicyPremiumItemDto {
+    /**
+     * Unique identifier referencing the item premium formula.
+     * @type {number}
+     * @memberof PolicyPremiumItemDto
+     */
+    'premiumFormulaId': number;
+    /**
+     * Item total.
+     * @type {number}
+     * @memberof PolicyPremiumItemDto
+     */
+    'total': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PolicyPremiumItemDto
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PolicyPremiumItemDto
+     */
+    'updatedAt'?: string;
+    /**
+     * Item premium formula entity.
+     * @type {PremiumFormulaDto}
+     * @memberof PolicyPremiumItemDto
+     */
+    'premiumFormula': PremiumFormulaDto;
+    /**
+     * It indicates if the premium override exist.
+     * @type {boolean}
+     * @memberof PolicyPremiumItemDto
+     */
+    'isOverride'?: boolean;
+}

package/dist/models/policy-premium-item-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 });