@emilgroup/billing-sdk-node 1.3.0 → 1.4.0

package/models/index.ts

@@ -1,19 +1,52 @@
-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 './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-estimated-invoice-request-dto';
 export * from './create-estimated-invoice-response-class';
-export * from './create-invoice-request-dto';
-export * from './create-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 './invoice-class';
 export * from './invoice-item-class';
-export * from './list-invoices-response-class';
-export * from './list-policies-billing-dates-response-class';
-export * from './list-request-dto';
-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 './timeslice-dto';
+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';

package/models/initiate-braintree-payment-setup-request-dto.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InitiateBraintreePaymentSetupRequestDto
+ */
+export interface InitiateBraintreePaymentSetupRequestDto {
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof InitiateBraintreePaymentSetupRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof InitiateBraintreePaymentSetupRequestDto
+     */
+    'accountCode'?: string;
+}
+

package/models/initiate-braintree-payment-setup-response-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InitiateBraintreePaymentSetupResponseClass
+ */
+export interface InitiateBraintreePaymentSetupResponseClass {
+    /**
+     * Identifier used by the payment service provider to create a payment method.
+     * @type {string}
+     * @memberof InitiateBraintreePaymentSetupResponseClass
+     */
+    'pspSecretToken': string;
+}
+

package/models/initiate-lead-response-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InitiateLeadResponseClass
+ */
+export interface InitiateLeadResponseClass {
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof InitiateLeadResponseClass
+     */
+    'leadCode': string;
+}
+

package/models/initiate-payment-setup-request-dto.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { InitiateBraintreePaymentSetupRequestDto } from './initiate-braintree-payment-setup-request-dto';
+import { InitiateStripePaymentSetupRequestDto } from './initiate-stripe-payment-setup-request-dto';
+
+/**
+ * 
+ * @export
+ * @interface InitiatePaymentSetupRequestDto
+ */
+export interface InitiatePaymentSetupRequestDto {
+    /**
+     * 
+     * @type {InitiateStripePaymentSetupRequestDto}
+     * @memberof InitiatePaymentSetupRequestDto
+     */
+    'stripe'?: InitiateStripePaymentSetupRequestDto;
+    /**
+     * 
+     * @type {InitiateBraintreePaymentSetupRequestDto}
+     * @memberof InitiatePaymentSetupRequestDto
+     */
+    'braintree'?: InitiateBraintreePaymentSetupRequestDto;
+}
+

package/models/initiate-payment-setup-response-class.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { InitiateBraintreePaymentSetupResponseClass } from './initiate-braintree-payment-setup-response-class';
+import { InitiateStripePaymentSetupResponseClass } from './initiate-stripe-payment-setup-response-class';
+
+/**
+ * 
+ * @export
+ * @interface InitiatePaymentSetupResponseClass
+ */
+export interface InitiatePaymentSetupResponseClass {
+    /**
+     * The stripe response after creating the setup intent.
+     * @type {InitiateStripePaymentSetupResponseClass}
+     * @memberof InitiatePaymentSetupResponseClass
+     */
+    'stripe': InitiateStripePaymentSetupResponseClass;
+    /**
+     * Braintree response after generating client token.
+     * @type {InitiateBraintreePaymentSetupResponseClass}
+     * @memberof InitiatePaymentSetupResponseClass
+     */
+    'braintree': InitiateBraintreePaymentSetupResponseClass;
+}
+

package/models/initiate-stripe-payment-setup-request-dto.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InitiateStripePaymentSetupRequestDto
+ */
+export interface InitiateStripePaymentSetupRequestDto {
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof InitiateStripePaymentSetupRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof InitiateStripePaymentSetupRequestDto
+     */
+    'accountCode'?: string;
+}
+

package/models/initiate-stripe-payment-setup-response-class.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InitiateStripePaymentSetupResponseClass
+ */
+export interface InitiateStripePaymentSetupResponseClass {
+    /**
+     * Identifier used by the payment service provider to create a payment method.
+     * @type {string}
+     * @memberof InitiateStripePaymentSetupResponseClass
+     */
+    'pspSecretToken': string;
+    /**
+     * Unique identifier for the customer on Stripe.
+     * @type {string}
+     * @memberof InitiateStripePaymentSetupResponseClass
+     */
+    'pspCustomerId': string;
+}
+

package/models/insured-object-class.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { ProductFieldClass } from './product-field-class';
+
+/**
+ * 
+ * @export
+ * @interface InsuredObjectClass
+ */
+export interface InsuredObjectClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InsuredObjectClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the product version.
+     * @type {number}
+     * @memberof InsuredObjectClass
+     */
+    'productVersionId': number;
+    /**
+     * Insured object name
+     * @type {string}
+     * @memberof InsuredObjectClass
+     */
+    'name': string;
+    /**
+     * Insured object label
+     * @type {string}
+     * @memberof InsuredObjectClass
+     */
+    'label': string;
+    /**
+     * Unique identifier referencing the insured object type.
+     * @type {number}
+     * @memberof InsuredObjectClass
+     */
+    'insuredObjectTypeId': number;
+    /**
+     * Product fields of insured object. Product fields are also called Variables on the Admin website. They are automatically created according to the product factors. Those can then be used in the formula for the premium calculation. It is possible to add new ones.
+     * @type {Array<ProductFieldClass>}
+     * @memberof InsuredObjectClass
+     */
+    'productFields': Array<ProductFieldClass>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InsuredObjectClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof InsuredObjectClass
+     */
+    'updatedAt': string;
+}
+

package/models/insured-object-type-class.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 InsuredObjectTypeClass
+ */
+export interface InsuredObjectTypeClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InsuredObjectTypeClass
+     */
+    'id': number;
+    /**
+     * Insured object type name
+     * @type {string}
+     * @memberof InsuredObjectTypeClass
+     */
+    'name': 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 InsuredObjectTypeClass
+     */
+    'slug': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InsuredObjectTypeClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof InsuredObjectTypeClass
+     */
+    'updatedAt': string;
+}
+

package/models/invoice-class.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL BillingService
- * The EMIL BillingService API description
+ * Emil PublicAPI
+ * The Emil Public 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
@@ -14,6 +14,7 @@
 
 
 import { InvoiceItemClass } from './invoice-item-class';
+import { InvoiceStatusClass } from './invoice-status-class';
 
 /**
  * 
@@ -22,13 +23,13 @@ import { InvoiceItemClass } from './invoice-item-class';
  */
 export interface InvoiceClass {
     /**
-     * Invoice id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceClass
      */
     'id': number;
     /**
-     * policy code
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof InvoiceClass
      */
@@ -40,31 +41,31 @@ export interface InvoiceClass {
      */
     'accountNumber': string;
     /**
-     * Invoice code
+     * Unique identifier for the object.
      * @type {string}
      * @memberof InvoiceClass
      */
     'code': string;
     /**
-     * Invoice type
+     * Invoice type.
      * @type {string}
      * @memberof InvoiceClass
      */
     'type': string;
     /**
-     * Invoice number
+     * Invoice number.
      * @type {string}
      * @memberof InvoiceClass
      */
     'invoiceNumber': string;
     /**
-     * Net amount
+     * Net amount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'netAmount': number;
     /**
-     * Tax amount
+     * Tax amount.
      * @type {number}
      * @memberof InvoiceClass
      */
@@ -76,25 +77,25 @@ export interface InvoiceClass {
      */
     'creditAmount': number;
     /**
-     * Gross amount
+     * Gross amount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'grossAmount': number;
     /**
-     * Invoice status
+     * It shows the status of the invoice that is paid or open.
      * @type {string}
      * @memberof InvoiceClass
      */
     'status': string;
     /**
-     * Invoice due date
+     * Invoice due date.
      * @type {string}
      * @memberof InvoiceClass
      */
     'dueDate': string;
     /**
-     * Invoice metadata
+     * Metadata contains extra information that the invoice would need for specific cases.
      * @type {object}
      * @memberof InvoiceClass
      */
@@ -112,7 +113,7 @@ export interface InvoiceClass {
      */
     'billingIntervalTo': string;
     /**
-     * Invoice created at
+     * Time at which the object was created.
      * @type {string}
      * @memberof InvoiceClass
      */
@@ -123,5 +124,11 @@ export interface InvoiceClass {
      * @memberof InvoiceClass
      */
     'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice statuses
+     * @type {Array<InvoiceStatusClass>}
+     * @memberof InvoiceClass
+     */
+    'statuses': Array<InvoiceStatusClass>;
 }
 

package/models/invoice-item-class.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL BillingService
- * The EMIL BillingService API description
+ * Emil PublicAPI
+ * The Emil Public 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
@@ -21,31 +21,31 @@
  */
 export interface InvoiceItemClass {
     /**
-     * Invoice item id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'id': number;
     /**
-     * Premium formula id
+     * Unique identifier referencing the premium formula.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'premiumFormulaId': number;
     /**
-     * product name
+     * Product name.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'name': string;
     /**
-     * tax code
+     * Unique identifier of the tax that this object belongs to.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'taxCode': string;
     /**
-     * Invoice type
+     * This is unit of Premium. Premium units are determined based on day, week, month and year.
      * @type {string}
      * @memberof InvoiceItemClass
      */
@@ -57,55 +57,55 @@ export interface InvoiceItemClass {
      */
     'group': string;
     /**
-     * Item quantity
+     * Item quantity.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'quantity': number;
     /**
-     * Item price per unit
+     * Item price per unit.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'pricePerUnit': number;
     /**
-     * Item tax rate
+     * Item tax rate.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'taxRate': number;
     /**
-     * Net amount
+     * Net amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'netAmount': number;
     /**
-     * Net tax amount
+     * Net tax amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'taxAmount': number;
     /**
-     * Gross amount
+     * Gross amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'grossAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'creditAmount': number;
     /**
-     * Invoice item interval from
+     * This is the date from which the invoice item interval starts.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'billingIntervalFrom': string;
     /**
-     * Invoice item interval to
+     * This is the date that the invoice item interval ends.
      * @type {string}
      * @memberof InvoiceItemClass
      */