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

package/lib/schemas/public-applicant-event.json

@@ -1,7 +1,15 @@
 {
   "definitions": {
-    "Payload": {
-      "$ref": "#/definitions/payload"
+    "payload": {
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/applicantDefinition"
+        },
+        {
+          "$ref": "#/definitions/deleteApplicantDefinition"
+        }
+      ]
     },
     "id": {
       "type": "string",
@@ -41,7 +49,8 @@
         },
         "age": {
           "type": "number",
-          "minimum": 0
+          "minimum": 0,
+          "maximum": 100
         },
         "isAddedOnThisApplicant": {
           "type": "boolean",
@@ -61,35 +70,7 @@
     },
     "employmentType": {
       "enum": ["EMPLOYEE", "SELF_EMPLOYED", "UNKNOWN"],
-      "description": "applicant's employment type"
-    },
-    "guarantorRelationshipToBorrowerApplicantId": {
-      "$ref": "#/definitions/id",
-      "description": "Applicant Id of borrower that has relationship with guarantor."
-    },
-    "guarantorRelationshipToBorrowerType": {
-      "enum": ["Father", "Mother", "Spouse", "Brother", "Sister", "Son", "Daughter", "Other Relative", "Other"],
-      "description": "The relationship between borrower and guarantor."
-    },
-    "guarantorRelationshipToBorrowerTypeOther": {
-      "type": "string",
-      "description": "Description of relationship between borrower and guarantor when other."
-    },
-    "guarantorRelationshipToBorrowerDefinition": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "applicantId": {
-          "$ref": "#/definitions/guarantorRelationshipToBorrowerApplicantId"
-        },
-        "type": {
-          "$ref": "#/definitions/guarantorRelationshipToBorrowerType"
-        },
-        "typeOther": {
-          "$ref": "#/definitions/guarantorRelationshipToBorrowerTypeOther"
-        }
-      },
-      "required": ["applicantId", "type"]
+      "description": "LEGACY. DO NOT USE. Historic events only - applicant's employment type. Use the employment events instead!"
     },
     "isPrimaryApplicant": {
       "type": "boolean"
@@ -121,16 +102,21 @@
         "$ref": "#/definitions/dependant"
       }
     },
-    "firstName": {
+    "name": {
       "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "firstName": {
+      "$ref": "#/definitions/name",
       "description": "customer's first name"
     },
     "middleName": {
-      "type": "string",
+      "$ref": "#/definitions/name",
       "description": "customer's middle name"
     },
     "lastName": {
-      "type": "string",
+      "$ref": "#/definitions/name",
       "description": "customer's last name"
     },
     "title": {
@@ -399,7 +385,7 @@
       "type": "string",
       "example": "Ohio"
     },
-    "AustralianStates": {
+    "australianStates": {
       "example": "NSW",
       "type": "string",
       "enum": ["QLD", "NSW", "VIC", "WA", "SA", "TAS", "ACT", "NT"]
@@ -409,22 +395,27 @@
       "format": "date",
       "example": "2018-07-17"
     },
-    "AddressStandard": {
+    "addressStandard": {
       "type": "object",
       "additionalProperties": false,
       "properties": {
         "buildingName": {
           "description": "The building name",
-          "type": "string"
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
         },
         "deliveryAddress": {
           "description": "Postal address, usually a PO Box or Locked Bag",
           "type": "string",
-          "example": "PO Box 1"
+          "example": "PO Box 1",
+          "maxLength": 512
         },
         "lotSection": {
           "description": "The lot number",
-          "type": "string"
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
         },
         "streetName": {
           "type": "string"
@@ -435,7 +426,8 @@
         "streetSuffix": {
           "description": "The street suffix",
           "type": "string",
-          "example": "North"
+          "example": "North",
+          "maxLength": 128
         },
         "streetType": {
           "type": "string"
@@ -453,14 +445,15 @@
       "additionalProperties": false,
       "properties": {
         "postcode": {
-          "type": "string"
+          "type": "string",
+          "maxLength": 32
         },
         "state": {
           "example": "NSW",
           "type": "string",
           "anyOf": [
             {
-              "$ref": "#/definitions/AustralianStates"
+              "$ref": "#/definitions/australianStates"
             },
             {
               "$ref": "#/definitions/otherState"
@@ -477,7 +470,7 @@
           "type": "string"
         },
         "standard": {
-          "$ref": "#/definitions/AddressStandard"
+          "$ref": "#/definitions/addressStandard"
         }
       }
     },
@@ -553,15 +546,72 @@
       "enum": ["ACCEPTED", "PENDING", "CANCELLED", "EXPIRED"],
       "description": "different invitation statuses an applicant can have"
     },
-    "entity": {
-      "enum": ["PERSON", "COMPANY"],
-      "description": "applicant's entity. For a person applicant this is 'PERSON'"
-    },
     "isFirstHomeBuyer": {
       "type": "boolean",
       "description": "Whether it's the applicants first home purchase."
     },
-    "payload": {
+    "guarantorRelationshipToBorrowerApplicantId": {
+      "$ref": "#/definitions/id",
+      "description": "Applicant Id of borrower that has relationship with guarantor."
+    },
+    "guarantorRelationshipToBorrowerType": {
+      "enum": ["Father", "Mother", "Spouse", "Brother", "Sister", "Son", "Daughter", "Other Relative", "Other"],
+      "description": "The relationship between borrower and guarantor."
+    },
+    "guarantorRelationshipToBorrowerTypeOther": {
+      "type": "string",
+      "description": "Description of relationship between borrower and guarantor when other."
+    },
+    "guarantorRelationshipToBorrowerDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "applicantId": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerApplicantId"
+        },
+        "type": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerType"
+        },
+        "typeOther": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerTypeOther"
+        }
+      },
+      "required": ["applicantId", "type"]
+    },
+    "cityOfBirth": {
+      "type": "string",
+      "example": "Sydney"
+    },
+    "industryCode": {
+      "type": "string",
+      "pattern": "^\\d{4}$",
+      "description": "ANZSIC business code lookup "
+    },
+    "isPassiveEntity": {
+      "type": "boolean",
+      "description": "If the entity's primary business activity is investing"
+    },
+    "legalEntities": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 1000000
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "numOfMonths": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 1200
+    },
+    "yesNoIntend": {
+      "type": "string",
+      "enum": ["Yes", "No", "Intend"]
+    },
+
+    "personApplicantDefinition": {
       "type": "object",
       "additionalProperties": false,
       "properties": {
@@ -584,21 +634,19 @@
         "meta": {
           "$ref": "#/definitions/applicantMeta"
         },
+        "entity": {
+          "enum": ["PERSON"],
+          "description": "applicant's entity. For a person applicant this is 'PERSON'"
+        },
         "applicantType": {
           "$ref": "#/definitions/applicantType"
         },
         "creditStatus": {
           "$ref": "#/definitions/creditStatus"
         },
-        "entity": {
-          "$ref": "#/definitions/entity"
-        },
         "employmentType": {
           "$ref": "#/definitions/employmentType"
         },
-        "guarantorRelationshipToBorrower": {
-          "$ref": "#/definitions/guarantorRelationshipToBorrowerDefinition"
-        },
         "isPrimaryApplicant": {
           "$ref": "#/definitions/isPrimaryApplicant"
         },
@@ -647,6 +695,9 @@
         "countryOfBirth": {
           "$ref": "#/definitions/countries"
         },
+        "cityOfBirth": {
+          "$ref": "#/definitions/cityOfBirth"
+        },
         "citizenship": {
           "$ref": "#/definitions/countries"
         },
@@ -656,28 +707,323 @@
         },
         "isFirstHomeBuyer": {
           "$ref": "#/definitions/isFirstHomeBuyer"
+        },
+        "guarantorRelationshipToBorrower": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerDefinition"
+        }
+      },
+      "required": ["id", "applicationId", "customerId", "meta", "entity", "applicantType"],
+      "description": "applicant payload."
+    },
+
+    "trustType": {
+      "enum": [
+        "CASH_MANAGEMENT_TRUST",
+        "DISCRETIONARY_TRUST",
+        "FIXED",
+        "HYBRID",
+        "SUPERANNUATION_TRUSTS",
+        "UNIT",
+        "OTHER"
+      ]
+    },
+    "trustApplicantDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
+        },
+        "applicantType": {
+          "$ref": "#/definitions/applicantType"
+        },
+        "entity": {
+          "enum": ["TRUST"],
+          "description": "applicant's entity. For a trust applicant this is 'TRUST'"
+        },
+        "trustName": {
+          "$ref": "#/definitions/name"
+        },
+        "trustType": {
+          "$ref": "#/definitions/trustType"
+        },
+        "registeredDate": {
+          "$ref": "#/definitions/date"
+        },
+        "registeredCountry": {
+          "$ref": "#/definitions/countries"
+        },
+        "registeredAddress": {
+          "$ref": "#/definitions/address"
+        },
+        "mailingAddress": {
+          "$ref": "#/definitions/address"
+        },
+        "industryCode": {
+          "$ref": "#/definitions/industryCode"
+        },
+        "isPassiveEntity": {
+          "$ref": "#/definitions/isPassiveEntity"
         }
       },
-      "required": ["id", "applicationId", "customerId"],
-      "description": "create/update applicant payload"
+      "required": ["id", "applicationId", "meta", "entity", "applicantType"],
+      "description": "trust payload."
+    },
+
+    "abn": {
+      "type": "string",
+      "pattern": "^\\d{11}$",
+      "description": "Company ABN Number"
+    },
+    "acn": {
+      "type": "string",
+      "pattern": "^\\d{9}$",
+      "description": "Australian Company Number"
+    },
+    "yearsOfTrading": {
+      "type": "string",
+      "enum": ["1", "2", "3", "4", "5", "5-10", ">10"]
+    },
+    "companyType": {
+      "enum": ["INCORPORATED", "LTD", "NL", "PTY_LTD"]
+    },
+    "companyStructure": {
+      "enum": ["SOLE_TRADER", "PARTNERSHIP", "CORPORATION", "TRUST"]
+    },
+    "companyApplicantDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of applicant"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
+        },
+        "applicantType": {
+          "$ref": "#/definitions/applicantType"
+        },
+        "entity": {
+          "enum": ["COMPANY"],
+          "description": "applicant's entity. For a company applicant this is 'COMPANY'"
+        },
+        "companyName": {
+          "$ref": "#/definitions/name"
+        },
+        "companyType": {
+          "$ref": "#/definitions/companyType"
+        },
+        "companyStructure": {
+          "$ref": "#/definitions/companyStructure"
+        },
+        "industryCode": {
+          "$ref": "#/definitions/industryCode"
+        },
+        "isDiversified": {
+          "type": "boolean"
+        },
+        "legalEntitiesInGroup": {
+          "$ref": "#/definitions/legalEntities"
+        },
+        "isPassiveEntity": {
+          "$ref": "#/definitions/isPassiveEntity"
+        },
+        "isCommercialRelationship": {
+          "type": "boolean"
+        },
+        "abn": {
+          "$ref": "#/definitions/abn"
+        },
+        "acn": {
+          "$ref": "#/definitions/acn"
+        },
+        "registeredState": {
+          "$ref": "#/definitions/australianStates"
+        },
+        "registeredDate": {
+          "$ref": "#/definitions/date"
+        },
+        "yearsOfTrading": {
+          "$ref": "#/definitions/yearsOfTrading"
+        },
+        "currentLender": {
+          "$ref": "#/definitions/name"
+        },
+        "legalEntitiesWithCurrentLender": {
+          "$ref": "#/definitions/legalEntities"
+        },
+        "monthsWithCurrentLender": {
+          "$ref": "#/definitions/numOfMonths"
+        },
+        "branch": {
+          "$ref": "#/definitions/name"
+        },
+        "hasMoreThan25PercentBusinessWithOneCustomer": {
+          "type": "boolean",
+          "description": "Company doing more than 25% of business with one customer or supplier"
+        },
+        "moreThan25PercentBusinessWithOneCustomerDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "hasOutstandingTax": {
+          "type": "boolean"
+        },
+        "outstandingTaxDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "isPrincipalPlaceOfBusinessLeased": {
+          "type": "boolean",
+          "description": "Is the principal place of business leased"
+        },
+        "principalPlaceOfBusinessLeasedDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "doesTermLoanNeed100PercentFunding": {
+          "type": "boolean",
+          "description": "100% funding required for Term Loans"
+        },
+        "termLoanNeed100PercentFundingDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "isActingAsFranchise": {
+          "$ref": "#/definitions/yesNoIntend"
+        },
+        "actingAsFranchiseDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "isWorkingInImportExport": {
+          "$ref": "#/definitions/yesNoIntend"
+        },
+        "workingInImportExportDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "isInvestingInProperty": {
+          "$ref": "#/definitions/yesNoIntend"
+        },
+        "investingInPropertyDetails": {
+          "$ref": "#/definitions/description"
+        },
+        "hasGoodConduct": {
+          "type": "boolean",
+          "description": "The applicant has not been over the credit limit, in arrears or in hardship in relation to any existing credit or other fixed expenses"
+        },
+        "wasBankruptOrInsolvent": {
+          "type": "boolean",
+          "description": "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?"
+        },
+        "hasPastOrCurrentDebts": {
+          "type": "boolean",
+          "description": "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?"
+        },
+        "hadRepaymentDifficultyOrLegalProceedings": {
+          "type": "boolean",
+          "description": "Have you had any difficulty in meeting your existing loan repayments, or had any financial judgments or legal proceedings, in the past two years?"
+        },
+        "isUSCitizenOrResident": {
+          "type": "boolean",
+          "description": "Is the applicant a US citizen or resident for US tax purposes?"
+        },
+        "hadLatePaymentsOrArrearsOrAdverseCreditHistory": {
+          "type": "boolean",
+          "description": "Has the applicant had any late payments, loan arrears or adverse credit history such as current or prior defaults or bankruptcies?"
+        }
+      },
+      "required": ["id", "applicationId", "meta", "entity", "applicantType"],
+      "description": "company payload."
+    },
+
+    "applicantDefinition": {
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/trustApplicantDefinition"
+        },
+        {
+          "$ref": "#/definitions/companyApplicantDefinition"
+        },
+        {
+          "$ref": "#/definitions/personApplicantDefinition"
+        }
+      ],
+      "discriminator": {
+        "propertyName": "entity"
+      }
+    },
+
+    "deleteApplicantDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
+        }
+      },
+      "required": ["id", "applicationId", "meta"]
     }
   },
   "type": "object",
-  "title": "The applicant event schema",
+  "title": "The applicant-person/company/trust event schema",
   "description": "Create, update or delete. UpdatePrimaryApplicant is DEPRECATED",
-  "additionalProperties": false,
-  "properties": {
-    "version": {
-      "type": "string",
-      "description": "schema version"
+  "allOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "version": {
+          "type": "string",
+          "description": "schema version"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["DeleteApplicant", "UpdateApplicant", "CreateApplicant"]
+        },
+        "payload": {
+          "$ref": "#/definitions/payload"
+        }
+      },
+      "required": ["version", "payload", "type"]
     },
-    "type": {
-      "type": "string",
-      "enum": ["UpdateApplicant", "CreateApplicant"]
+    {
+      "if": {
+        "properties": { "type": { "const": "DeleteApplicant" } }
+      },
+      "then": {
+        "properties": { "payload": { "$ref": "#/definitions/deleteApplicantDefinition" } }
+      }
     },
-    "payload": {
-      "$ref": "#/definitions/Payload"
+    {
+      "if": {
+        "properties": { "type": { "const": "UpdateApplicant" } }
+      },
+      "then": {
+        "properties": { "payload": { "$ref": "#/definitions/applicantDefinition" } }
+      }
+    },
+    {
+      "if": {
+        "properties": { "type": { "const": "CreateApplicant" } }
+      },
+      "then": {
+        "properties": { "payload": { "$ref": "#/definitions/applicantDefinition" } }
+      }
     }
-  },
-  "required": ["version", "payload", "type"]
+  ]
 }

package/lib/schemas/public-application-event.json

@@ -152,7 +152,7 @@
           "$ref": "#/definitions/hidden"
         },
         "brand": {
-          "enum": ["lendi", "domain", "domain variation", "lendi variation"]
+          "enum": ["lendi", "domain", "domain variation", "lendi variation", "aussie"]
         },
         "hasOptedInRateLock": {
           "$ref": "#/definitions/hasOptedInRateLock"

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

@@ -1,34 +1,4 @@
 import { YesNoList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { Contact, Dependant, Payload as ApplicantPayload } from '../types/events/public-applicant';
+import { Payload as ApplicantPayload } from '../types/events/public-applicant';
 export declare const booleanMapping: (input?: boolean) => YesNoList;
-/**
- * Transforms a partial Applicant event to a partial LIXI application.
- *
- * @param applicant: A partial applicant.
- * @param applicant
- * @returns partialApplication an incomplete application.
- */
-export declare function transformApplicant(applicant: ApplicantPayload): {};
-/**
- * Generates a LIXI contact from given contact.
- *
- * @param contact
- * @param id
- */
-export declare function generateContact(contact: Contact, id: string): {
-    lixiContact: {};
-    lixiAddresses: any[];
-};
-/**
- * Generate dependants
- *
- * @param dependants
- * @param id
- */
-export declare function generateDependants(dependants: Dependant[], id: string): {
-    '@Age': number;
-    '@UniqueID': string;
-    FinancialProvider: {
-        '@x_Party': string;
-    }[];
-}[];
+export declare function transformApplicant(applicant: ApplicantPayload): import("../types/recursive-partial").RecursivePartial<import("@lendi/integrations-credit-protocol/types/lixi-internal-request").InternalRequest>;