@emilgroup/billing-sdk-node 1.4.0 → 1.4.1

package/models/invoice-status-class.ts

@@ -1,8 +1,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
@@ -33,11 +33,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}
@@ -46,3 +46,11 @@ export interface InvoiceStatusClass {
     'createdAt': string;
 }
 
+export const InvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];
+
+

package/models/{list-products-response-class.ts → list-invoices-response-class.ts}

@@ -1,8 +1,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,24 +13,24 @@
  */
 
 
-import { ProductClass } from './product-class';
+import { InvoiceClass } from './invoice-class';
 
 /**
  * 
  * @export
- * @interface ListProductsResponseClass
+ * @interface ListInvoicesResponseClass
  */
-export interface ListProductsResponseClass {
+export interface ListInvoicesResponseClass {
     /**
-     * List of products.
-     * @type {Array<ProductClass>}
-     * @memberof ListProductsResponseClass
+     * Invoices list items.
+     * @type {Array<InvoiceClass>}
+     * @memberof ListInvoicesResponseClass
      */
-    'items': Array<ProductClass>;
+    'items': Array<InvoiceClass>;
     /**
      * Next page token.
      * @type {string}
-     * @memberof ListProductsResponseClass
+     * @memberof ListInvoicesResponseClass
      */
     'nextPageToken': string;
 }

package/models/list-policies-billing-dates-response-class.ts

@@ -0,0 +1,37 @@
+/* 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 { 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/models/list-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 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/models/omit-type-class.ts

@@ -0,0 +1,154 @@
+/* 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 { 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 const OmitTypeClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type OmitTypeClassTypeEnum = typeof OmitTypeClassTypeEnum[keyof typeof OmitTypeClassTypeEnum];
+export const OmitTypeClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];
+
+

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

@@ -0,0 +1,48 @@
+/* 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 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/models/policy-dto.ts

@@ -0,0 +1,131 @@
+/* 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 { 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
+     */
+    'tenantHierarchy': string;
+}
+
+export const PolicyDtoStatusEnum = {
+    Active: 'ACTIVE',
+    Withdraw: 'WITHDRAW',
+    Terminated: 'TERMINATED',
+    Suspended: 'SUSPENDED'
+} as const;
+
+export type PolicyDtoStatusEnum = typeof PolicyDtoStatusEnum[keyof typeof PolicyDtoStatusEnum];
+
+

package/models/{lead-policy-object-class.ts → policy-object-dto.ts}

@@ -1,8 +1,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
@@ -17,19 +17,31 @@
 /**
  * 
  * @export
- * @interface LeadPolicyObjectClass
+ * @interface PolicyObjectDto
  */
-export interface LeadPolicyObjectClass {
+export interface PolicyObjectDto {
     /**
      * Unique identifier referencing the insured object.
      * @type {number}
-     * @memberof LeadPolicyObjectClass
+     * @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 LeadPolicyObjectClass
+     * @memberof PolicyObjectDto
      */
     'data': object;
 }

package/models/policy-premium-dto.ts

@@ -0,0 +1,49 @@
+/* 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 { 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>;
+}
+

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

@@ -0,0 +1,61 @@
+/* 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 { 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;
+}
+