@lendi/integrations-transform 1.6.5 → 1.6.7-beta.0

package/lib/transform-events/transform-applicant.js

@@ -1,58 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDependants = exports.generateContact = exports.transformApplicant = exports.booleanMapping = void 0;
-const lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+exports.transformApplicant = exports.booleanMapping = void 0;
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+const lixi_internal_request_2 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 const application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 const lodash_1 = require("lodash");
-const address_tools_1 = require("../utils/address-tools");
 const enum_mappings_1 = require("../types/enum-mappings");
+const applicant_gender_1 = require("../types/enum-mappings/applicant-gender");
+const applicant_type_1 = require("../types/enum-mappings/applicant-type");
+const guarantor_relationship_type_1 = require("../types/enum-mappings/guarantor-relationship-type");
 const public_applicant_1 = require("../types/events/public-applicant");
+const errors_1 = require("../utils/errors");
 const normalise_date_1 = require("../utils/normalise-date");
-const booleanMapping = (input = false) => (input === true ? lixi_internal_request_1.YesNoList.Yes : lixi_internal_request_1.YesNoList.No);
+const booleanMapping = (input = false) => (input === true ? lixi_internal_request_2.YesNoList.Yes : lixi_internal_request_2.YesNoList.No);
 exports.booleanMapping = booleanMapping;
-const applicantMapping = {
-    applicationId: application_paths_1.paths.ApplicationId,
-    citizenship: `${application_paths_1.paths.PersonApplicant}.@Citizenship`,
-    contact: `${application_paths_1.paths.PersonApplicant}.Contact`,
-    dependants: 'dependants',
-    dateOfBirth: `${application_paths_1.paths.PersonApplicant}.@DateOfBirth`,
-    firstName: `${application_paths_1.paths.PersonApplicant}.PersonName.@FirstName`,
-    id: `${application_paths_1.paths.PersonApplicant}.@UniqueID`,
-    isFirstHomeBuyer: `${application_paths_1.paths.PersonApplicant}.@FirstHomeBuyer`,
-    isPrimaryApplicant: `${application_paths_1.paths.PersonApplicant}.@PrimaryApplicant`,
-    lastName: `${application_paths_1.paths.PersonApplicant}.PersonName.@Surname`,
-    maritalStatus: `${application_paths_1.paths.PersonApplicant}.@MaritalStatus`,
-    maritalDetails: `${application_paths_1.paths.PersonApplicant}.MaritalStatusDetails.@x_Spouse`,
-    middleName: `${application_paths_1.paths.PersonApplicant}.PersonName.@MiddleNames`,
-    residencyStatus: `${application_paths_1.paths.PersonApplicant}.@ResidencyStatus`,
-    title: `${application_paths_1.paths.PersonName}.@NameTitle`,
-};
-/**
- * Transforms a partial Applicant event to a partial LIXI application.
- *
- * @param applicant: A partial applicant.
- * @param applicant
- * @returns partialApplication an incomplete application.
- */
 function transformApplicant(applicant) {
     const partialApplication = {};
-    const { id: applicantId, applicationId } = applicant;
-    (0, lodash_1.set)(partialApplication, applicantMapping['isFirstHomeBuyer'], (0, exports.booleanMapping)(applicant.isFirstHomeBuyer));
-    (0, lodash_1.set)(partialApplication, applicantMapping['isPrimaryApplicant'], (0, exports.booleanMapping)(applicant.isPrimaryApplicant));
-    (0, lodash_1.set)(partialApplication, applicantMapping['title'], enum_mappings_1.titleMapping[applicant.title || public_applicant_1.Title.Unknown]);
-    const applicantUpdated = (0, lodash_1.omit)(applicant, ['isFirstHomeBuyer', 'isPrimaryApplicant', 'title']);
-    for (const [key, value] of Object.entries(applicantUpdated)) {
+    const applicantId = applicant.id; // This is how SF events cross reference applicant with its entities.
+    const applicantMapping = {
+        applicantType: `${application_paths_1.paths.PersonApplicant}.@ApplicantType`,
+        applicationId: application_paths_1.paths.ApplicationId,
+        citizenship: `${application_paths_1.paths.PersonApplicant}.@Citizenship`,
+        cityOfBirth: `${application_paths_1.paths.PersonApplicant}.@PlaceOfBirth`,
+        contact: 'contact',
+        countryOfBirth: `${application_paths_1.paths.PersonApplicant}.@CountryOfBirth`,
+        dateOfBirth: `${application_paths_1.paths.PersonApplicant}.@DateOfBirth`,
+        dependants: 'dependants',
+        email: `${application_paths_1.paths.PersonApplicant}.Contact.EmailAddress[0].@Email`,
+        firstName: `${application_paths_1.paths.PersonApplicant}.PersonName.@FirstName`,
+        id: `${application_paths_1.paths.PersonApplicant}.@UniqueID`,
+        lastName: `${application_paths_1.paths.PersonApplicant}.PersonName.@Surname`,
+        maritalDetails: `${application_paths_1.paths.PersonApplicant}.MaritalStatusDetails.@x_Spouse`,
+        maritalStatus: `${application_paths_1.paths.PersonApplicant}.@MaritalStatus`,
+        middleName: `${application_paths_1.paths.PersonApplicant}.PersonName.@MiddleNames`,
+        mothersMaidenName: `${application_paths_1.paths.PersonApplicant}.@MothersMaidenName`,
+        phone: `${application_paths_1.paths.PersonApplicant}.Contact.Mobile.@Number`,
+        residencyStatus: `${application_paths_1.paths.PersonApplicant}.@ResidencyStatus`,
+        title: `${application_paths_1.paths.PersonName}.@NameTitle`,
+    };
+    // Any applicant event need to have at least dateOfBirth, firstName and lastName.
+    if (!(applicant.dateOfBirth && applicant.firstName && applicant.lastName)) {
+        throw new errors_1.InvalidEvent('Applicant needs to have dateOfBirth, firstName and lastName');
+    }
+    // If applicant event comes without an applicantType then default it to ApplicantType.Borrower
+    if (!applicant.applicantType) {
+        applicant.applicantType = public_applicant_1.ApplicantType.Borrower;
+    }
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonName}.@NameTitle`, lixi_internal_request_1.NameTitleList.Other);
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@PrimaryApplicant`, (0, exports.booleanMapping)(applicant.isPrimaryApplicant));
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@FirstHomeBuyer`, (0, exports.booleanMapping)(applicant.isFirstHomeBuyer));
+    if (applicant.applicantType === public_applicant_1.ApplicantType.Guarantor) {
+        const mappedGuarantorRelationship = applicant.guarantorRelationshipToBorrower
+            ? guarantor_relationship_type_1.guarantorRelationshipTypeMappings[applicant.guarantorRelationshipToBorrower.type]
+            : lixi_internal_request_1.KinRelationshipList.OtherRelative;
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@RelationshipToPrimaryApplicant`, mappedGuarantorRelationship);
+        // Credit Report event is not available for Guarantors, we should use
+        // the gender from the applicant event. If a Guarantor were to be converted to
+        // Borrower, the credit report should override the value for `@Gender`
+        if (applicant.gender) {
+            (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Gender`, applicant_gender_1.applicantGenderMapping[applicant.gender]);
+        }
+    }
+    for (const [key, value] of Object.entries(applicant)) {
         if (applicantMapping[key]) {
             switch (key) {
+                case 'applicantType':
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], applicant_type_1.applicantTypeMapping[value]);
+                    break;
                 case 'dateOfBirth':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], (0, normalise_date_1.normaliseDate)(value));
                     break;
                 case 'maritalStatus':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.maritalStatusMapping[value]);
                     break;
-                case 'citizenship':
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.countryCodeMapping[value]);
-                    break;
                 case 'residencyStatus':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.residencyStatusMapping[value]);
                     // Certain bank integrations require the ability to differentiate between permanentResident and Citizen
@@ -61,24 +81,44 @@ function transformApplicant(applicant) {
                     // If citizen this field will be always added and value will be AU.
                     // @tsilva 21/11/19
                     if (value === public_applicant_1.ResidencyStatus.AustralianCitizen) {
-                        (0, lodash_1.set)(partialApplication, applicantMapping.citizenship, lixi_internal_request_1.CountryCodeList.Au);
+                        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Citizenship`, lixi_internal_request_2.CountryCodeList.Au);
                     }
                     break;
+                case 'countryOfBirth':
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@CountryOfBirth`, enum_mappings_1.countryCodeMapping[value]);
+                    break;
+                case 'citizenship':
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Citizenship`, enum_mappings_1.countryCodeMapping[value]);
+                    break;
+                case 'title':
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.titleMapping[value]);
+                    break;
                 case 'maritalDetails':
                     const id = (0, lodash_1.get)(value, 'applicantId');
                     if (id)
                         (0, lodash_1.set)(partialApplication, applicantMapping[key], id);
                     break;
                 case 'contact':
-                    const { lixiContact, lixiAddresses } = generateContact(value, applicantId);
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], lixiContact);
-                    if (lixiAddresses.length > 0) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.Addresses, lixiAddresses);
+                    const emailAddress = (0, lodash_1.get)(value, 'emailAddress');
+                    const mobileNumber = (0, lodash_1.get)(value, 'mobileNumber');
+                    if (emailAddress) {
+                        (0, lodash_1.set)(partialApplication, applicantMapping.email, emailAddress);
+                    }
+                    if (mobileNumber) {
+                        (0, lodash_1.set)(partialApplication, applicantMapping.phone, mobileNumber.replace('+61', '0'));
                     }
                     break;
                 case 'dependants':
-                    const dependants = generateDependants(value, applicantId);
-                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.@UniqueID`, `${applicationId}-household`);
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.@UniqueID`, `${applicant.applicationId}-household`);
+                    const dependants = value.map((dependant) => ({
+                        '@Age': dependant.age,
+                        '@UniqueID': dependant.id,
+                        FinancialProvider: [
+                            {
+                                '@x_Party': applicantId,
+                            },
+                        ],
+                    }));
                     (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.Dependant`, dependants);
                     break;
                 default:
@@ -90,91 +130,3 @@ function transformApplicant(applicant) {
     return partialApplication;
 }
 exports.transformApplicant = transformApplicant;
-const contactMapping = {
-    emailAddress: 'EmailAddress.0.@Email',
-    mobileNumber: 'Mobile.@Number',
-    currentAddress: 'CurrentAddress',
-    previousAddresses: 'PreviousAddress',
-    priorAddress: 'PriorAddress',
-    mailingAddress: 'CurrentAddress.@x_MailingAddress',
-    postSettlementAddress: 'PostSettlementAddress',
-};
-/**
- * Generates a LIXI contact from given contact.
- *
- * @param contact
- * @param id
- */
-function generateContact(contact, id) {
-    const lixiContact = {};
-    const lixiAddresses = [];
-    for (const [key, value] of Object.entries(contact)) {
-        if (contactMapping[key]) {
-            switch (key) {
-                case 'currentAddress':
-                    {
-                        const addressId = `${id}-current`;
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(value, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                    }
-                    break;
-                case 'postSettlementAddress':
-                    {
-                        const addressId = `${id}-postSettlement`;
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)({ residentialAddress: value }, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                    }
-                    break;
-                case 'mailingAddress':
-                    {
-                        const addressId = `${id}-mailing`;
-                        const { lixiAddress } = (0, address_tools_1.rebuildAddress)({ residentialAddress: value }, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], addressId);
-                    }
-                    break;
-                case 'previousAddresses':
-                    {
-                        const addressId = `${id}-previous`;
-                        const previousAddresses = value.sort((lhs, rhs) => lhs.endDate.localeCompare(rhs.endDate));
-                        const previousAddress = previousAddresses.pop();
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(previousAddress, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                        // PriorAddresses
-                        previousAddresses.forEach((address, index) => {
-                            const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(address, `${id}-prior-${index}`);
-                            lixiAddresses.push(lixiAddress);
-                            (0, lodash_1.set)(lixiContact, `${contactMapping['priorAddress']}.${index}`, lixiContactAddress);
-                        });
-                    }
-                    break;
-                default:
-                    (0, lodash_1.set)(lixiContact, contactMapping[key], value);
-                    break;
-            }
-        }
-    }
-    return { lixiContact, lixiAddresses };
-}
-exports.generateContact = generateContact;
-/**
- * Generate dependants
- *
- * @param dependants
- * @param id
- */
-function generateDependants(dependants, id) {
-    return dependants.map((dependant) => ({
-        '@Age': dependant.age,
-        '@UniqueID': dependant.id,
-        FinancialProvider: [
-            {
-                '@x_Party': id,
-            },
-        ],
-    }));
-}
-exports.generateDependants = generateDependants;

package/lib/transform-events/transform-application.d.ts

@@ -1,7 +1,13 @@
 import { Payload as ApplicationPayload } from '../types/events/public-application';
 export interface TransformApplicationOptions {
     uniqueIdSuffix?: string;
+    /**
+     * Enables/disables the rate lock mapping (Used to enable the mapping in AW and disable in DW simulatenously due to having to notify integrated approval confidence lenders of schema changes if the attribute is added to schema)
+     */
     enableRateLock?: boolean;
+    /**
+     * Enables/disables the fast refi mapping (Used to enable the mapping in AW and disable in DW simulatenously due to having to notify integrated approval confidence lenders of schema changes if the attribute is added to schema)
+     */
     enableFastRefi?: boolean;
 }
 /**

package/lib/transform-events/transform-application.js

@@ -32,6 +32,12 @@ function transformApplication(opportunity, options = {}) {
     if (enableRateLock) {
         (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.FeaturesSelected}.@RateLock`, (0, transform_applicant_1.booleanMapping)(hasOptedInRateLock));
     }
+    /**
+     * Please note that fast refinance is only applicable to applications where the primary purpose of the application is Refinance
+     * Hence there is logic in the fixApplicationInconsistencies method used by the updateApplication middleware in AW that removes or defaults the value of the FastRefinance attribute
+     * based on the primary purpose of the application. This logic was placed in the fixApplicationInconsistencies method in the updateApplication middleware as this is where we know the correct primary purpose of the
+     * application.
+     */
     if (enableFastRefi) {
         (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Overview}.@FastRefinance`, (0, transform_applicant_1.booleanMapping)(isFastRefi));
     }

package/lib/transform-events/transform-asset.d.ts

@@ -1,4 +1,4 @@
-import { LivingExpense, PropertyExpense as LIXIPropertyExpense, OccupancyList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { LivingExpense, OccupancyList, PropertyExpense as LIXIPropertyExpense } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 import { PropertyType as LixiPropertyType, Residential } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
 import { Asset, Payload, PercentOwned, PropertyExpense, PropertyType } from '../types/events/public-asset';
 import { PartialApplication } from '../types/partial-application';

package/lib/transform-events/transform-asset.js

@@ -4,10 +4,13 @@ exports.normalizeAmounts = exports.determineOccupancy = exports.generateProperty
 const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
 const application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 const lixi_internal_request_2 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-const uuid_1 = require("uuid");
 const lodash_1 = require("lodash");
+const uuid_1 = require("uuid");
+const __1 = require("..");
 const logger_1 = require("../logger");
 const enum_mappings_1 = require("../types/enum-mappings");
+const builder_type_1 = require("../types/enum-mappings/builder-type");
+const construction_type_1 = require("../types/enum-mappings/construction-type");
 const public_asset_1 = require("../types/events/public-asset");
 const public_expense_1 = require("../types/events/public-expense");
 const get_financial_institution_1 = require("../utils/get-financial-institution");
@@ -15,9 +18,6 @@ const is_asset_type_1 = require("../utils/is-asset-type");
 const round_decimal_1 = require("../utils/round-decimal");
 const transform_asset_address_1 = require("./transform-asset-address");
 const transform_percent_owned_1 = require("./transform-percent-owned");
-const builder_type_1 = require("../types/enum-mappings/builder-type");
-const construction_type_1 = require("../types/enum-mappings/construction-type");
-const __1 = require("..");
 exports.propertyTypeNameList = Object.values(lixi_internal_request_2.Custom2PropertyTypeNameList);
 exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
 // will add this path to protocol
@@ -80,9 +80,11 @@ function transformAsset({ asset, applicationId, id }) {
         if (assetMapping[key]) {
             switch (key) {
                 case 'contractDetails':
-                    const { contractDate } = value;
+                    const { contractDate, estimatedSettlementDate } = value;
                     if (contractDate)
                         (0, lodash_1.set)(partialApplication, assetMapping.contractDate, contractDate);
+                    if (estimatedSettlementDate)
+                        (0, lodash_1.set)(partialApplication, assetMapping.estimatedSettlementDate, estimatedSettlementDate);
                     break;
                 case 'primaryPurpose':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], enum_mappings_1.primaryPurposeMapping[value]);
@@ -224,6 +226,7 @@ function getAssetMapping(asset) {
             address: application_paths_1.paths.Address,
             contractDetails: 'contractDetails',
             contractDate: `${application_paths_1.paths.RealEstateAsset}.ContractDetails.@ContractDate`,
+            estimatedSettlementDate: `${application_paths_1.paths.RealEstateAsset}.ContractDetails.@EstimatedSettlementDate`,
             estimatedValue,
             percentOwned,
             primaryPurpose: `${application_paths_1.paths.RealEstateAsset}.@PrimaryPurpose`,

package/lib/types/enum-mappings/applicant-gender.d.ts

@@ -0,0 +1,6 @@
+import { Gender } from '../events/public-applicant';
+import { GenderList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+export declare type ApplicantGenderMapping = {
+    [key in Gender]: GenderList;
+};
+export declare const applicantGenderMapping: ApplicantGenderMapping;

package/lib/types/enum-mappings/applicant-gender.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applicantGenderMapping = void 0;
+const public_applicant_1 = require("../events/public-applicant");
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+exports.applicantGenderMapping = {
+    [public_applicant_1.Gender.Female]: lixi_internal_request_1.GenderList.Female,
+    [public_applicant_1.Gender.Male]: lixi_internal_request_1.GenderList.Male,
+    [public_applicant_1.Gender.Undisclosed]: lixi_internal_request_1.GenderList.Undisclosed,
+    [public_applicant_1.Gender.Unknown]: lixi_internal_request_1.GenderList.Undisclosed,
+};

package/lib/types/enum-mappings/applicant-type.d.ts

@@ -0,0 +1,6 @@
+import { ApplicantTypeList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { ApplicantType } from '../events/public-applicant';
+export declare type ApplicantTypeMapping = {
+    [key in ApplicantType]: ApplicantTypeList;
+};
+export declare const applicantTypeMapping: ApplicantTypeMapping;

package/lib/types/enum-mappings/applicant-type.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applicantTypeMapping = void 0;
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+const public_applicant_1 = require("../events/public-applicant");
+exports.applicantTypeMapping = {
+    [public_applicant_1.ApplicantType.Borrower]: lixi_internal_request_1.ApplicantTypeList.Borrower,
+    [public_applicant_1.ApplicantType.BorrowerAndGuarantor]: lixi_internal_request_1.ApplicantTypeList.BorrowerAndGuarantor,
+    [public_applicant_1.ApplicantType.Guarantor]: lixi_internal_request_1.ApplicantTypeList.Guarantor,
+};

package/lib/types/events/public-applicant.d.ts

@@ -10,53 +10,140 @@ export interface PublicApplicant {
     version: string;
 }
 /**
- * create/update applicant payload
+ * trust payload.
+ *
+ * company payload.
+ *
+ * applicant payload.
  */
 export interface Payload {
+    abn?: string;
+    acn?: string;
+    actingAsFranchiseDetails?: string;
     applicantType?: ApplicantType;
     /**
      * uuid of application
      */
     applicationId: string;
+    branch?: string;
     citizenship?: Countries;
+    cityOfBirth?: string;
     /**
      * uuid of source applicant
      */
     clonedFromApplicantId?: string;
+    companyName?: string;
+    companyStructure?: CompanyStructure;
+    companyType?: CompanyType;
     contact?: Contact;
     countryOfBirth?: Countries;
     creditStatus?: CreditStatus;
+    currentLender?: string;
     /**
      * uuid of customer
      */
-    customerId: string;
+    customerId?: string;
     dateOfBirth?: string;
     dependants?: Dependant[];
+    /**
+     * 100% funding required for Term Loans
+     */
+    doesTermLoanNeed100PercentFunding?: boolean;
     employmentType?: EmploymentType;
+    /**
+     * applicant's entity. For a trust applicant this is 'TRUST'
+     *
+     * applicant's entity. For a company applicant this is 'COMPANY'
+     *
+     * applicant's entity. For a person applicant this is 'PERSON'
+     */
     entity?: Entity;
     firstName?: string;
     gender?: Gender;
     guarantorRelationshipToBorrower?: GuarantorRelationshipToBorrowerDefinition;
+    /**
+     * Has the applicant had any late payments, loan arrears or adverse credit history such as
+     * current or prior defaults or bankruptcies?
+     */
+    hadLatePaymentsOrArrearsOrAdverseCreditHistory?: boolean;
+    /**
+     * Have you had any difficulty in meeting your existing loan repayments, or had any
+     * financial judgments or legal proceedings, in the past two years?
+     */
+    hadRepaymentDifficultyOrLegalProceedings?: boolean;
+    /**
+     * The applicant has not been over the credit limit, in arrears or in hardship in relation
+     * to any existing credit or other fixed expenses
+     */
+    hasGoodConduct?: boolean;
+    /**
+     * Company doing more than 25% of business with one customer or supplier
+     */
+    hasMoreThan25PercentBusinessWithOneCustomer?: boolean;
+    hasOutstandingTax?: boolean;
+    /**
+     * Have you or a company with which you are associated had any past or current debts that
+     * were or are in default of the payment arrangement?
+     */
+    hasPastOrCurrentDebts?: boolean;
     hasSelfEmploymentProof?: boolean;
     /**
      * uuid of applicant
      */
     id: string;
+    industryCode?: string;
+    investingInPropertyDetails?: string;
     invitationStatus?: InvitationStatus;
+    isActingAsFranchise?: YesNoIntend;
+    isCommercialRelationship?: boolean;
+    isDiversified?: boolean;
     isFirstHomeBuyer?: boolean;
+    isInvestingInProperty?: YesNoIntend;
+    isPassiveEntity?: boolean;
     isPrimaryApplicant?: boolean;
+    /**
+     * Is the principal place of business leased
+     */
+    isPrincipalPlaceOfBusinessLeased?: boolean;
+    /**
+     * Is the applicant a US citizen or resident for US tax purposes?
+     */
+    isUSCitizenOrResident?: boolean;
+    isWorkingInImportExport?: YesNoIntend;
     lastName?: string;
+    legalEntitiesInGroup?: number;
+    legalEntitiesWithCurrentLender?: number;
+    mailingAddress?: Address;
     maritalDetails?: ApplicantKeyObject;
     maritalStatus?: MaritalStatus;
-    meta?: ApplicantMeta;
+    meta: ApplicantMeta;
     middleName?: string;
+    monthsWithCurrentLender?: number;
+    moreThan25PercentBusinessWithOneCustomerDetails?: string;
     /**
      * Mothers Maiden Name
      */
     mothersMaidenName?: string;
+    outstandingTaxDetails?: string;
+    principalPlaceOfBusinessLeasedDetails?: string;
+    registeredAddress?: Address;
+    registeredCountry?: Countries;
+    registeredDate?: string;
+    registeredState?: AustralianStates;
     residencyStatus?: ResidencyStatus;
+    termLoanNeed100PercentFundingDetails?: string;
     title?: Title;
     totalIncomeEstimate?: number;
+    trustName?: string;
+    trustType?: TrustType;
+    /**
+     * Have you been: bankrupt or insolvent, petitioned or aware of anyone petitioning you for
+     * bankruptcy, advised to seek bankruptcy, or associated with a company that was or
+     * threatened to be placed into administration?
+     */
+    wasBankruptOrInsolvent?: boolean;
+    workingInImportExportDetails?: string;
+    yearsOfTrading?: YearsOfTrading;
 }
 export declare enum ApplicantType {
     Borrower = "BORROWER",
@@ -304,6 +391,18 @@ export declare enum Countries {
     Zambia = "Zambia",
     Zimbabwe = "Zimbabwe"
 }
+export declare enum CompanyStructure {
+    Corporation = "CORPORATION",
+    Partnership = "PARTNERSHIP",
+    SoleTrader = "SOLE_TRADER",
+    Trust = "TRUST"
+}
+export declare enum CompanyType {
+    Incorporated = "INCORPORATED",
+    Ltd = "LTD",
+    Nl = "NL",
+    PtyLtd = "PTY_LTD"
+}
 export interface Contact {
     currentAddress?: CommonAddressProperties;
     /**
@@ -410,7 +509,8 @@ export interface ApplicantKeyObject {
     applicantId?: string;
 }
 /**
- * applicant's employment type
+ * LEGACY. DO NOT USE. Historic events only - applicant's employment type. Use the
+ * employment events instead!
  */
 export declare enum EmploymentType {
     Employee = "EMPLOYEE",
@@ -418,11 +518,16 @@ export declare enum EmploymentType {
     Unknown = "UNKNOWN"
 }
 /**
+ * applicant's entity. For a trust applicant this is 'TRUST'
+ *
+ * applicant's entity. For a company applicant this is 'COMPANY'
+ *
  * applicant's entity. For a person applicant this is 'PERSON'
  */
 export declare enum Entity {
     Company = "COMPANY",
-    Person = "PERSON"
+    Person = "PERSON",
+    Trust = "TRUST"
 }
 export declare enum Gender {
     Female = "FEMALE",
@@ -458,6 +563,11 @@ export declare enum InvitationStatus {
     Expired = "EXPIRED",
     Pending = "PENDING"
 }
+export declare enum YesNoIntend {
+    Intend = "Intend",
+    No = "No",
+    Yes = "Yes"
+}
 export declare enum MaritalStatus {
     DeFacto = "DE_FACTO",
     Divorced = "DIVORCED",
@@ -485,6 +595,16 @@ export declare enum ActionedByRole {
     Customer = "customer",
     Team = "team"
 }
+export declare enum AustralianStates {
+    Act = "ACT",
+    NT = "NT",
+    Nsw = "NSW",
+    Qld = "QLD",
+    Sa = "SA",
+    Tas = "TAS",
+    Vic = "VIC",
+    Wa = "WA"
+}
 export declare enum ResidencyStatus {
     AustralianCitizen = "AUSTRALIAN_CITIZEN",
     PermanentResident = "PERMANENT_RESIDENT",
@@ -499,7 +619,26 @@ export declare enum Title {
     Mrs = "MRS",
     Unknown = "UNKNOWN"
 }
+export declare enum TrustType {
+    CashManagementTrust = "CASH_MANAGEMENT_TRUST",
+    DiscretionaryTrust = "DISCRETIONARY_TRUST",
+    Fixed = "FIXED",
+    Hybrid = "HYBRID",
+    Other = "OTHER",
+    SuperannuationTrusts = "SUPERANNUATION_TRUSTS",
+    Unit = "UNIT"
+}
+export declare enum YearsOfTrading {
+    The1 = "1",
+    The10 = ">10",
+    The2 = "2",
+    The3 = "3",
+    The4 = "4",
+    The5 = "5",
+    The510 = "5-10"
+}
 export declare enum Type {
     CreateApplicant = "CreateApplicant",
+    DeleteApplicant = "DeleteApplicant",
     UpdateApplicant = "UpdateApplicant"
 }