@emilgroup/billing-sdk-node 1.25.0 → 1.26.0

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

@@ -0,0 +1,32 @@
+"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',
+    Refunded: 'refunded'
+};

package/dist/models/policy-billing-date-class.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 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;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'updatedBy': string;
+}

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

@@ -63,7 +63,7 @@ export interface PolicyDto {
      * @type {string}
      * @memberof PolicyDto
      */
-    'status': string;
+    'status': PolicyDtoStatusEnum;
     /**
      * Policy holder.
      * @type {string}
@@ -102,8 +102,28 @@ export interface PolicyDto {
     'productSlug': string;
     /**
      * Linked partners.
-     * @type {Array<string>}
+     * @type {Array<object>}
      * @memberof PolicyDto
      */
-    'partnerLinks': Array<string>;
+    'partnerLinks': Array<object>;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'policyStartDate': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyDto
+     */
+    'ern': string;
 }
+export declare const PolicyDtoStatusEnum: {
+    readonly Active: "ACTIVE";
+    readonly Withdrawn: "WITHDRAWN";
+    readonly Terminated: "TERMINATED";
+    readonly Suspended: "SUSPENDED";
+    readonly Pending: "PENDING";
+};
+export type PolicyDtoStatusEnum = typeof PolicyDtoStatusEnum[keyof typeof PolicyDtoStatusEnum];

package/dist/models/policy-dto.js

@@ -13,3 +13,11 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolicyDtoStatusEnum = void 0;
+exports.PolicyDtoStatusEnum = {
+    Active: 'ACTIVE',
+    Withdrawn: 'WITHDRAWN',
+    Terminated: 'TERMINATED',
+    Suspended: 'SUSPENDED',
+    Pending: 'PENDING'
+};

package/dist/models/policy-object-dto.d.ts

@@ -56,11 +56,17 @@ export interface PolicyObjectDto {
      * @type {string}
      * @memberof PolicyObjectDto
      */
-    'createdAt': string;
+    'createdAt'?: string;
     /**
      * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyObjectDto
      */
-    'updatedAt': string;
+    'updatedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyObjectDto
+     */
+    'code': string;
 }

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

@@ -27,13 +27,13 @@ export interface PolicyPremiumDto {
      * @type {string}
      * @memberof PolicyPremiumDto
      */
-    'createdAt': string;
+    'createdAt'?: string;
     /**
      * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyPremiumDto
      */
-    'updatedAt': string;
+    'updatedAt'?: string;
     /**
      * Premium Items.
      * @type {Array<PolicyPremiumItemDto>}

package/dist/models/policy-premium-item-dto.d.ts

@@ -39,7 +39,7 @@ export interface PolicyPremiumItemDto {
      * @type {string}
      * @memberof PolicyPremiumItemDto
      */
-    'updatedAt': string;
+    'updatedAt'?: string;
     /**
      * Item premium formula entity.
      * @type {PremiumFormulaDto}
@@ -51,5 +51,5 @@ export interface PolicyPremiumItemDto {
      * @type {boolean}
      * @memberof PolicyPremiumItemDto
      */
-    'isOverride': boolean;
+    'isOverride'?: boolean;
 }

package/dist/models/policy-version-dto.d.ts

@@ -33,19 +33,19 @@ export interface PolicyVersionDto {
      * @type {object}
      * @memberof PolicyVersionDto
      */
-    'metadata': object;
+    'metadata'?: object;
     /**
      * Time at which the object was created.
      * @type {string}
      * @memberof PolicyVersionDto
      */
-    'createdAt': string;
+    'createdAt'?: string;
     /**
      * Time at which the object was updated.
      * @type {string}
      * @memberof PolicyVersionDto
      */
-    'updatedAt': string;
+    'updatedAt'?: string;
     /**
      * Policy timeline.
      * @type {Array<TimesliceDto>}

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

@@ -62,11 +62,11 @@ export interface PremiumFormulaDto {
      * @type {string}
      * @memberof PremiumFormulaDto
      */
-    'createdAt': string;
+    'createdAt'?: string;
     /**
      * Time at which the object was updated.
      * @type {string}
      * @memberof PremiumFormulaDto
      */
-    'updatedAt': string;
+    'updatedAt'?: string;
 }

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

@@ -40,7 +40,7 @@ export interface TimesliceDto {
      * @type {string}
      * @memberof TimesliceDto
      */
-    'to': string;
+    'to'?: string;
     /**
      * Time at which the object was created.
      * @type {string}

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

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { OmitTypeClass } from './omit-type-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCorrectionInvoicesResponseClass
+ */
+export interface CreateCorrectionInvoicesResponseClass {
+    /**
+     * Correction invoices response.
+     * @type {OmitTypeClass}
+     * @memberof CreateCorrectionInvoicesResponseClass
+     */
+    'invoices': OmitTypeClass;
+}
+

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

@@ -0,0 +1,30 @@
+/* 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 CreateCustomEstimatedInvoiceResponseClass
+ */
+export interface CreateCustomEstimatedInvoiceResponseClass {
+    /**
+     * Recurring invoice response
+     * @type {object}
+     * @memberof CreateCustomEstimatedInvoiceResponseClass
+     */
+    'custom': object;
+}
+

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

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+import { InvoiceClass } from './invoice-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateEstimatedInvoiceForIntervalResponseClass
+ */
+export interface CreateEstimatedInvoiceForIntervalResponseClass {
+    /**
+     * Estimated invoice response
+     * @type {InvoiceClass}
+     * @memberof CreateEstimatedInvoiceForIntervalResponseClass
+     */
+    'invoice': InvoiceClass;
+}
+

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

@@ -32,6 +32,12 @@ export interface CreateEstimatedInvoiceRequestDto {
      * @type {object}
      * @memberof CreateEstimatedInvoiceRequestDto
      */
-    'metadata': object;
+    'metadata'?: object;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateEstimatedInvoiceRequestDto
+     */
+    'calculateProRata'?: boolean;
 }
 

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

@@ -0,0 +1,43 @@
+/* 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.
+ */
+
+
+import { InvoiceClass } from './invoice-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateEstimatedInvoiceResponseClass
+ */
+export interface CreateEstimatedInvoiceResponseClass {
+    /**
+     * The estimated invoice response based on the current policy data.      This includes the calculated invoice for the specified billing period (e.g., monthly, quarterly) as defined by the policy.      The invoice contains details such as gross amount, net amount, tax amount, and other invoice-related data for the specific period the invoice is generated for.
+     * @type {InvoiceClass}
+     * @memberof CreateEstimatedInvoiceResponseClass
+     */
+    'invoice': InvoiceClass;
+    /**
+     * The estimated yearly invoice response.      This represents the invoice recalculated to a yearly format, standardizing the invoice values regardless of the billing frequency defined by the policy (e.g., monthly, quarterly, etc.).      This yearly invoice gives an overview of the total cost for the entire year, including recalculated gross amount, net amount, tax amount, and other related invoice data, ensuring that all charges are displayed on a yearly basis.          Note: If the original invoice is already set to a yearly billing frequency, the \'yearlyInvoice\' will be identical to the \'invoice\'.
+     * @type {InvoiceClass}
+     * @memberof CreateEstimatedInvoiceResponseClass
+     */
+    'yearlyInvoice': InvoiceClass;
+    /**
+     * 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
+     */
+    'custom': object;
+}
+

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

@@ -43,12 +43,18 @@ export interface CreateInvoicePaymentRequestDto {
      * @type {string}
      * @memberof CreateInvoicePaymentRequestDto
      */
-    'comment': string;
+    'comment'?: string;
     /**
      * Unique identifier referencing the payment.
      * @type {number}
      * @memberof CreateInvoicePaymentRequestDto
      */
     'paymentId': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'invoiceId': number;
 }
 

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

@@ -25,7 +25,7 @@ export interface CreateInvoiceRequestDto {
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
-    'invoiceNumber': string;
+    'invoiceNumber'?: string;
     /**
      * Account number.
      * @type {string}
@@ -49,13 +49,13 @@ export interface CreateInvoiceRequestDto {
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
-    'type': CreateInvoiceRequestDtoTypeEnum;
+    'type'?: CreateInvoiceRequestDtoTypeEnum;
     /**
      * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof CreateInvoiceRequestDto
      */
-    'metadata': object;
+    'metadata'?: object;
     /**
      * This is the date from which the invoice interval starts.
      * @type {string}
@@ -73,7 +73,7 @@ export interface CreateInvoiceRequestDto {
      * @type {string}
      * @memberof CreateInvoiceRequestDto
      */
-    'dueDate': string;
+    'dueDate'?: string;
 }
 
 export const CreateInvoiceRequestDtoTypeEnum = {

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

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

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

@@ -0,0 +1,46 @@
+/* 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',
+    PartiallyPaid: 'partially-paid',
+    Refunded: 'refunded'
+} as const;
+
+export type CreateInvoiceStatusRequestDtoStatusEnum = typeof CreateInvoiceStatusRequestDtoStatusEnum[keyof typeof CreateInvoiceStatusRequestDtoStatusEnum];
+
+

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

@@ -0,0 +1,60 @@
+/* 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;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTerminationInvoiceRequestDto
+     */
+    'policyNumber': string;
+}
+

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

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

package/models/index.ts

@@ -1,12 +1,29 @@
+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-draft-invoice-request-dto';
 export * from './create-estimated-invoice-for-interval-request-dto';
+export * from './create-estimated-invoice-for-interval-response-class';
 export * from './create-estimated-invoice-request-dto';
+export * from './create-estimated-invoice-response-class';
 export * from './create-invoice-payment-request-dto';
 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 './get-invoice-response-class';
 export * from './inline-response200';
 export * from './inline-response503';
+export * from './invoice-class';
+export * from './invoice-item-class';
+export * from './invoice-payment-class';
+export * from './invoice-payments-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';