@emilgroup/partner-portal-sdk 1.1.1 → 1.5.0

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

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 { SepaDto } from './sepa-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreatePaymentMethodRequestDto
+ */
+export interface CreatePaymentMethodRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'type': string;
+    /**
+     * 
+     * @type {SepaDto}
+     * @memberof CreatePaymentMethodRequestDto
+     */
+    'sepa'?: SepaDto;
+}
+

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

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 { PremiumOverrideRequestDto } from './premium-override-request-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreatePolicyRequestDto
+ */
+export interface CreatePolicyRequestDto {
+    /**
+     * The product version id of the product version to be used for the lead.     The product version id will be validated if the \'validate\' flag is set to true.
+     * @type {number}
+     * @memberof CreatePolicyRequestDto
+     */
+    'productVersionId': number;
+    /**
+     * Unique identifier of the The account code of the account the policy is attached to. that this object belongs to.
+     * @type {string}
+     * @memberof CreatePolicyRequestDto
+     */
+    'accountCode'?: string;
+    /**
+     * Policy holder name. If not provided, the account holder name will be used.
+     * @type {string}
+     * @memberof CreatePolicyRequestDto
+     */
+    'holder'?: string;
+    /**
+     * The policy objects contains necessary information to create a policy.     The Policy objects array will be validated if the \'validate\' flag is set to true
+     * @type {Array<object>}
+     * @memberof CreatePolicyRequestDto
+     */
+    'policyObjects'?: Array<object>;
+    /**
+     * Premium Override is utilized to override the premium calculation.     The premium formulas will be disregarded when this object is present.     The premium override content will be validated if the \'validate\' flag is set to true.
+     * @type {PremiumOverrideRequestDto}
+     * @memberof CreatePolicyRequestDto
+     */
+    'premiumOverride'?: PremiumOverrideRequestDto;
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof CreatePolicyRequestDto
+     */
+    'leadCode'?: string;
+}
+

package/models/index.ts

@@ -0,0 +1,32 @@
+export * from './account-class';
+export * from './account-policy-class';
+export * from './create-payment-method-request-dto';
+export * from './create-policy-request-dto';
+export * from './insured-object-type-class';
+export * from './invoice-class';
+export * from './invoice-item-class';
+export * from './invoice-status-class';
+export * from './lead-bank-account-class';
+export * from './lead-class';
+export * from './list-accounts-response-class';
+export * from './list-leads-response-class';
+export * from './list-partners-response-class';
+export * from './list-policies-response-class';
+export * from './omit-type-class';
+export * from './partner-class';
+export * from './partner-link-class';
+export * from './partner-role-class';
+export * from './policy-class';
+export * from './policy-object-class';
+export * from './policy-premium-class';
+export * from './policy-premium-item-class';
+export * from './policy-version-class';
+export * from './premium-formula-class';
+export * from './premium-override-dto';
+export * from './premium-override-request-dto';
+export * from './product-class';
+export * from './product-version-class';
+export * from './sepa-dto';
+export * from './tag-class';
+export * from './timeslice-class';
+export * from './uploaded-document-dto';

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

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof InsuredObjectTypeClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof InsuredObjectTypeClass
+     */
+    'updatedBy': string;
+}
+

package/models/invoice-class.ts

@@ -0,0 +1,162 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 { InvoiceStatusClass } from './invoice-status-class';
+
+/**
+ * 
+ * @export
+ * @interface InvoiceClass
+ */
+export interface InvoiceClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'policyCode': string;
+    /**
+     * Account number.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'accountNumber': string;
+    /**
+     * Unique identifier of the invoice that this object belongs to.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'code': string;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'type': InvoiceClassTypeEnum;
+    /**
+     * Invoice number.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'invoiceNumber': string;
+    /**
+     * Net amount is in cents.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'netAmount': number;
+    /**
+     * Tax amount is in cents.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'taxAmount': number;
+    /**
+     * Credit amount.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'creditAmount': number;
+    /**
+     * Gross amount. This property is sum of taxAmount and netAmount.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'grossAmount': number;
+    /**
+     * Invoice status.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'status': InvoiceClassStatusEnum;
+    /**
+     * Invoice due date.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'dueDate': string;
+    /**
+     * Metadata contains extra information that the object would need for specific cases.
+     * @type {object}
+     * @memberof InvoiceClass
+     */
+    'metadata': object;
+    /**
+     * Start date of billing interval.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'billingIntervalFrom': string;
+    /**
+     * End date of billing interval.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'billingIntervalTo': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'createdAt': string;
+    /**
+     * Invoice items.
+     * @type {Array<InvoiceItemClass>}
+     * @memberof InvoiceClass
+     */
+    'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice statuses.
+     * @type {Array<InvoiceStatusClass>}
+     * @memberof InvoiceClass
+     */
+    'statuses': Array<InvoiceStatusClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {string}
+     * @memberof InvoiceClass
+     */
+    'currency': string;
+}
+
+export const InvoiceClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof InvoiceClassTypeEnum];
+export const InvoiceClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid',
+    Refunded: 'refunded'
+} as const;
+
+export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];
+
+

package/models/invoice-item-class.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 InvoiceItemClass
+ */
+export interface InvoiceItemClass {
+    /**
+     * Unique identifier referencing the invoice item.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the premium formula.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'premiumFormulaId': number;
+    /**
+     * Product name.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'name': string;
+    /**
+     * Tax code.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'taxCode': string;
+    /**
+     * Unit of Premium units are determined based on time or distance.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'unit': InvoiceItemClassUnitEnum;
+    /**
+     * Invoice group.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'group': string;
+    /**
+     * Item quantity. This property determines number of days during the billing interval.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'quantity': number;
+    /**
+     * Item price per unit.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'pricePerUnit': number;
+    /**
+     * Item tax rate.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'taxRate': number;
+    /**
+     * Net amount in cents. It is the result of the multiplication of the quantity by the pricePerUnit.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'netAmount': number;
+    /**
+     * Tax amount in cents.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'taxAmount': number;
+    /**
+     * Gross amount in cents. It is the result of the sum of taxAmount and netAmount.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'grossAmount': number;
+    /**
+     * Credit amount.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'creditAmount': number;
+    /**
+     * This is the date at which the invoice item interval starts.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'billingIntervalFrom': string;
+    /**
+     * This is the date at which the invoice item interval ends.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'billingIntervalTo': string;
+}
+
+export const InvoiceItemClassUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Quarter: 'quarter',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+} as const;
+
+export type InvoiceItemClassUnitEnum = typeof InvoiceItemClassUnitEnum[keyof typeof InvoiceItemClassUnitEnum];
+
+

package/models/invoice-status-class.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 InvoiceStatusClass
+ */
+export interface InvoiceStatusClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoiceStatusClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the invoice.
+     * @type {number}
+     * @memberof InvoiceStatusClass
+     */
+    'invoiceId': number;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'status': InvoiceStatusClassStatusEnum;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'createdAt': string;
+}
+
+export const InvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid',
+    Refunded: 'refunded'
+} as const;
+
+export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];
+
+

package/models/lead-bank-account-class.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL PartnerPortal
+ * The EMIL PartnerPortal 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 LeadBankAccountClass
+ */
+export interface LeadBankAccountClass {
+    /**
+     * Account code place-holder.
+     * @type {string}
+     * @memberof LeadBankAccountClass
+     */
+    'accountCode': string;
+    /**
+     * Bank account IBAN.
+     * @type {string}
+     * @memberof LeadBankAccountClass
+     */
+    'iban': string;
+}
+