@emilgroup/partner-portal-sdk-node 1.0.1-beta.0

package/models/invoice-class.ts

@@ -0,0 +1,160 @@
+/* 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'
+} 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,56 @@
+/* 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'
+} 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;
+}
+

package/models/lead-class.ts

@@ -0,0 +1,163 @@
+/* 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 { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
+import { CreatePolicyRequestDto } from './create-policy-request-dto';
+import { InvoiceClass } from './invoice-class';
+import { LeadBankAccountClass } from './lead-bank-account-class';
+import { OmitTypeClass } from './omit-type-class';
+import { PremiumOverrideRequestDto } from './premium-override-request-dto';
+import { UploadedDocumentDto } from './uploaded-document-dto';
+
+/**
+ * 
+ * @export
+ * @interface LeadClass
+ */
+export interface LeadClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof LeadClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'code': string;
+    /**
+     * Emil Resources Names (ERN) identifies the most specific owner of a resource.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'ern': string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'accountCode'?: string;
+    /**
+     * Lead status.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'status': string;
+    /**
+     * Lead account.
+     * @type {object}
+     * @memberof LeadClass
+     */
+    'account': object;
+    /**
+     * Lead policy.
+     * @type {CreatePolicyRequestDto}
+     * @memberof LeadClass
+     */
+    'policy': CreatePolicyRequestDto;
+    /**
+     * Lead bank account, will be treated as a reference to payout customer claims.
+     * @type {LeadBankAccountClass}
+     * @memberof LeadClass
+     */
+    'bankAccount'?: LeadBankAccountClass;
+    /**
+     * Custom data for custom application creation.
+     * @type {object}
+     * @memberof LeadClass
+     */
+    'customData'?: object;
+    /**
+     * List of uploaded document codes.
+     * @type {UploadedDocumentDto}
+     * @memberof LeadClass
+     */
+    'uploadedDocument'?: UploadedDocumentDto;
+    /**
+     * Override for premium calculation. Leave null for default calculation.
+     * @type {PremiumOverrideRequestDto}
+     * @memberof LeadClass
+     */
+    'premiumOverride'?: PremiumOverrideRequestDto;
+    /**
+     * 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 LeadClass
+     */
+    'productSlug'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'updatedAt': string;
+    /**
+     * Quote or price details.
+     * @type {InvoiceClass}
+     * @memberof LeadClass
+     */
+    'quote'?: InvoiceClass;
+    /**
+     * Payment method. When a payment method is provided, it needs to be handled in the workflow based on its type.
+     * @type {CreatePaymentMethodRequestDto}
+     * @memberof LeadClass
+     */
+    'paymentMethod'?: CreatePaymentMethodRequestDto;
+    /**
+     * A indicator to validate the lead.
+     * @type {boolean}
+     * @memberof LeadClass
+     */
+    'validate': boolean;
+    /**
+     * Lead number.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'leadNumber': string;
+    /**
+     * Lead version.
+     * @type {number}
+     * @memberof LeadClass
+     */
+    'version'?: number;
+    /**
+     * Partner links.
+     * @type {Array<OmitTypeClass>}
+     * @memberof LeadClass
+     */
+    'partnerLinks': Array<OmitTypeClass>;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof LeadClass
+     */
+    'updatedBy': string;
+}
+

package/models/list-accounts-response-class.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 { AccountClass } from './account-class';
+
+/**
+ * 
+ * @export
+ * @interface ListAccountsResponseClass
+ */
+export interface ListAccountsResponseClass {
+    /**
+     * The list of accounts.
+     * @type {Array<AccountClass>}
+     * @memberof ListAccountsResponseClass
+     */
+    'items': Array<AccountClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListAccountsResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-leads-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { LeadClass } from './lead-class';
+
+/**
+ * 
+ * @export
+ * @interface ListLeadsResponseClass
+ */
+export interface ListLeadsResponseClass {
+    /**
+     * Leads
+     * @type {Array<LeadClass>}
+     * @memberof ListLeadsResponseClass
+     */
+    'items': Array<LeadClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListLeadsResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListLeadsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListLeadsResponseClass
+     */
+    'totalItems': number;
+}
+

package/models/list-partners-response-class.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 { PartnerClass } from './partner-class';
+
+/**
+ * 
+ * @export
+ * @interface ListPartnersResponseClass
+ */
+export interface ListPartnersResponseClass {
+    /**
+     * The list of partners.
+     * @type {Array<PartnerClass>}
+     * @memberof ListPartnersResponseClass
+     */
+    'items': Array<PartnerClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListPartnersResponseClass
+     */
+    'nextPageToken': string;
+}
+