@lendi/integrations-transform 1.0.7 → 1.1.1

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

@@ -0,0 +1,485 @@
+/**
+ * Create, update or delete. UpdatePrimaryApplicant is DEPRECATED
+ */
+export interface PublicApplicant {
+    payload: Payload;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+/**
+ * create/update applicant payload
+ */
+export interface Payload {
+    applicantType?: ApplicantType;
+    /**
+     * uuid of application
+     */
+    applicationId: string;
+    citizenship?: Countries;
+    /**
+     * uuid of source applicant
+     */
+    clonedFromApplicantId?: string;
+    contact?: Contact;
+    countryOfBirth?: Countries;
+    creditStatus?: CreditStatus;
+    /**
+     * uuid of customer
+     */
+    customerId: string;
+    dateOfBirth?: string;
+    dependants?: Dependant[];
+    employmentType?: EmploymentType;
+    entity?: Entity;
+    firstName?: string;
+    gender?: Gender;
+    hasSelfEmploymentProof?: boolean;
+    /**
+     * uuid of applicant
+     */
+    id: string;
+    invitationStatus?: InvitationStatus;
+    isFirstHomeBuyer?: boolean;
+    isPrimaryApplicant?: boolean;
+    lastName?: string;
+    maritalDetails?: ApplicantKeyObject;
+    maritalStatus?: MaritalStatus;
+    meta?: ApplicantMeta;
+    middleName?: string;
+    /**
+     * Mothers Maiden Name
+     */
+    mothersMaidenName?: string;
+    residencyStatus?: ResidencyStatus;
+    title?: Title;
+    totalIncomeEstimate?: number;
+}
+export declare enum ApplicantType {
+    Borrower = "BORROWER",
+    BorrowerAndGuarantor = "BORROWER_AND_GUARANTOR",
+    Guarantor = "GUARANTOR"
+}
+export declare enum Countries {
+    Afghanistan = "Afghanistan",
+    Albania = "Albania",
+    Algeria = "Algeria",
+    AmericanSamoa = "American Samoa",
+    Andorra = "Andorra",
+    Angola = "Angola",
+    Anguilla = "Anguilla",
+    Antarctica = "Antarctica",
+    AntiguaAndBarbuda = "Antigua And Barbuda",
+    Argentina = "Argentina",
+    Armenia = "Armenia",
+    Aruba = "Aruba",
+    Australia = "Australia",
+    Austria = "Austria",
+    Azerbaijan = "Azerbaijan",
+    Bahamas = "Bahamas",
+    Bahrain = "Bahrain",
+    Bangladesh = "Bangladesh",
+    Barbados = "Barbados",
+    Belarus = "Belarus",
+    Belgium = "Belgium",
+    Belize = "Belize",
+    Benin = "Benin",
+    Bermuda = "Bermuda",
+    Bhutan = "Bhutan",
+    Bolivia = "Bolivia",
+    BosniaAndHerzegovina = "Bosnia And Herzegovina",
+    Botswana = "Botswana",
+    BouvetIsland = "Bouvet Island",
+    Brazil = "Brazil",
+    BritishIndianOceanTerritory = "British Indian Ocean Territory",
+    BritishVirginIslands = "British Virgin Islands",
+    BruneiDarussalam = "Brunei Darussalam",
+    Bulgaria = "Bulgaria",
+    BurkinaFaso = "Burkina Faso",
+    Burundi = "Burundi",
+    Cambodia = "Cambodia",
+    Cameroon = "Cameroon",
+    Canada = "Canada",
+    CapeVerde = "Cape Verde",
+    CaymanIslands = "Cayman Islands",
+    CentralAfricanRepublic = "Central African Republic",
+    Chad = "Chad",
+    Chile = "Chile",
+    China = "China",
+    ChristmasIsland = "Christmas Island",
+    CocosKeelingIslands = "Cocos (Keeling) Islands",
+    Colombia = "Colombia",
+    Comoros = "Comoros",
+    CookIslands = "Cook Islands",
+    CostaRica = "Costa Rica",
+    CoteDIvoire = "Cote D'ivoire",
+    Croatia = "Croatia",
+    Cuba = "Cuba",
+    Cyprus = "Cyprus",
+    CzechRepublic = "Czech Republic",
+    DemocraticPeopleSRepublicOfKorea = "Democratic People's Republic of Korea",
+    DemocraticRepublicOfTheCongo = "Democratic Republic Of The Congo",
+    Denmark = "Denmark",
+    Djibouti = "Djibouti",
+    Dominica = "Dominica",
+    DominicanRepublic = "Dominican Republic",
+    EastTimor = "East Timor",
+    Ecuador = "Ecuador",
+    Egypt = "Egypt",
+    ElSalvador = "El Salvador",
+    EquatorialGuinea = "Equatorial Guinea",
+    Eritrea = "Eritrea",
+    Estonia = "Estonia",
+    Ethiopia = "Ethiopia",
+    FalklandIslands = "Falkland Islands",
+    FaroeIslands = "Faroe Islands",
+    FederatedStatesOfMicronesia = "Federated States Of Micronesia",
+    Fiji = "Fiji",
+    Finland = "Finland",
+    France = "France",
+    FrenchGuiana = "French Guiana",
+    FrenchPolynesia = "French Polynesia",
+    FrenchSouthernTerritories = "French Southern Territories",
+    Gabon = "Gabon",
+    Gambia = "Gambia",
+    Georgia = "Georgia",
+    Germany = "Germany",
+    Ghana = "Ghana",
+    Gibraltar = "Gibraltar",
+    Greece = "Greece",
+    Greenland = "Greenland",
+    Grenada = "Grenada",
+    Guadeloupe = "Guadeloupe",
+    Guam = "Guam",
+    Guatemala = "Guatemala",
+    Guinea = "Guinea",
+    GuineaBissau = "Guinea-bissau",
+    Guyana = "Guyana",
+    Haiti = "Haiti",
+    HeardIslandAndMcdonaldIslands = "Heard Island And Mcdonald Islands",
+    HolySeeVaticanCityState = "Holy See (Vatican City State)",
+    Honduras = "Honduras",
+    HongKong = "Hong Kong",
+    Hungary = "Hungary",
+    Iceland = "Iceland",
+    India = "India",
+    Indonesia = "Indonesia",
+    Iran = "Iran",
+    Iraq = "Iraq",
+    Ireland = "Ireland",
+    Israel = "Israel",
+    Italy = "Italy",
+    Jamaica = "Jamaica",
+    Japan = "Japan",
+    Jordan = "Jordan",
+    Kazakstan = "Kazakstan",
+    Kenya = "Kenya",
+    Kiribati = "Kiribati",
+    Kosovo = "Kosovo",
+    Kuwait = "Kuwait",
+    Kyrgyzstan = "Kyrgyzstan",
+    Laos = "Laos",
+    Latvia = "Latvia",
+    Lebanon = "Lebanon",
+    Lesotho = "Lesotho",
+    Liberia = "Liberia",
+    LibyanArabJamahiriya = "Libyan Arab Jamahiriya",
+    Liechtenstein = "Liechtenstein",
+    Lithuania = "Lithuania",
+    Luxembourg = "Luxembourg",
+    Macau = "Macau",
+    Macedonia = "Macedonia",
+    Madagascar = "Madagascar",
+    Malawi = "Malawi",
+    Malaysia = "Malaysia",
+    Maldives = "Maldives",
+    Mali = "Mali",
+    Malta = "Malta",
+    MarshallIslands = "Marshall Islands",
+    Martinique = "Martinique",
+    Mauritania = "Mauritania",
+    Mauritius = "Mauritius",
+    Mayotte = "Mayotte",
+    Mexico = "Mexico",
+    Monaco = "Monaco",
+    Mongolia = "Mongolia",
+    Montenegro = "Montenegro",
+    Montserrat = "Montserrat",
+    Morocco = "Morocco",
+    Mozambique = "Mozambique",
+    Myanmar = "Myanmar",
+    Namibia = "Namibia",
+    Nauru = "Nauru",
+    Nepal = "Nepal",
+    Netherlands = "Netherlands",
+    NetherlandsAntilles = "Netherlands Antilles",
+    NewCaledonia = "New Caledonia",
+    NewZealand = "New Zealand",
+    Nicaragua = "Nicaragua",
+    Niger = "Niger",
+    Nigeria = "Nigeria",
+    Niue = "Niue",
+    NorfolkIsland = "Norfolk Island",
+    NorthernMarianaIslands = "Northern Mariana Islands",
+    Norway = "Norway",
+    Oman = "Oman",
+    Pakistan = "Pakistan",
+    Palau = "Palau",
+    PalestinianTerritory = "Palestinian Territory",
+    Panama = "Panama",
+    PapuaNewGuinea = "Papua New Guinea",
+    Paraguay = "Paraguay",
+    Peru = "Peru",
+    Philippines = "Philippines",
+    Pitcairn = "Pitcairn",
+    Poland = "Poland",
+    Portugal = "Portugal",
+    PuertoRico = "Puerto Rico",
+    Qatar = "Qatar",
+    RepublicOfMoldova = "Republic Of Moldova",
+    Romania = "Romania",
+    RussianFederation = "Russian Federation",
+    Rwanda = "Rwanda",
+    SANMarino = "San Marino",
+    SaintHelena = "Saint Helena",
+    SaintKittsAndNevis = "Saint Kitts And Nevis",
+    SaintLucia = "Saint Lucia",
+    SaintPierreAndMiquelon = "Saint Pierre And Miquelon",
+    SaintVincentAndTheGrenadines = "Saint Vincent And The Grenadines",
+    Samoa = "Samoa",
+    SaoTomeAndPrincipe = "Sao Tome And Principe",
+    SaudiArabia = "Saudi Arabia",
+    Senegal = "Senegal",
+    Serbia = "Serbia",
+    Seychelles = "Seychelles",
+    SierraLeone = "Sierra Leone",
+    Singapore = "Singapore",
+    Slovakia = "Slovakia",
+    Slovenia = "Slovenia",
+    SolomonIslands = "Solomon Islands",
+    Somalia = "Somalia",
+    SouthAfrica = "South Africa",
+    SouthGeorgiaAndTheSouthSandwichIslands = "South Georgia And The South Sandwich Islands",
+    Spain = "Spain",
+    SriLanka = "Sri Lanka",
+    Sudan = "Sudan",
+    Suriname = "Suriname",
+    SvalbardAndJanMayen = "Svalbard And Jan Mayen",
+    Swaziland = "Swaziland",
+    Sweden = "Sweden",
+    Switzerland = "Switzerland",
+    SyrianArabRepublic = "Syrian Arab Republic",
+    Taiwan = "Taiwan",
+    Tajikistan = "Tajikistan",
+    Tanzania = "Tanzania",
+    Thailand = "Thailand",
+    TheRepublicOfSouthKorea = "The Republic of South Korea",
+    Togo = "Togo",
+    Tokelau = "Tokelau",
+    Tonga = "Tonga",
+    TrinidadAndTobago = "Trinidad And Tobago",
+    Tunisia = "Tunisia",
+    Turkey = "Turkey",
+    Turkmenistan = "Turkmenistan",
+    TurksAndCaicosIslands = "Turks And Caicos Islands",
+    Tuvalu = "Tuvalu",
+    USVirginIslands = "US Virgin Islands",
+    Uganda = "Uganda",
+    Ukraine = "Ukraine",
+    UnitedArabEmirates = "United Arab Emirates",
+    UnitedKingdom = "United Kingdom",
+    UnitedStatesMinorOutlyingIslands = "United States Minor Outlying Islands",
+    UnitedStatesOfAmerica = "United States of America",
+    Uruguay = "Uruguay",
+    Uzbekistan = "Uzbekistan",
+    Vanuatu = "Vanuatu",
+    Venezuela = "Venezuela",
+    Vietnam = "Vietnam",
+    WallisAndFutuna = "Wallis And Futuna",
+    WesternSahara = "Western Sahara",
+    Yemen = "Yemen",
+    Zambia = "Zambia",
+    Zimbabwe = "Zimbabwe"
+}
+export interface Contact {
+    currentAddress?: CommonAddressProperties;
+    /**
+     * The applicant email
+     */
+    emailAddress?: string;
+    /**
+     * applicant's mailing address being captured as part of funnels 5 (post product select)
+     */
+    mailingAddress?: Address;
+    /**
+     * applicant's mobile number formatted in +611234567890
+     */
+    mobileNumber?: string;
+    /**
+     * applicant's post settlement address being captured as part of funnels 5 (post product
+     * select)
+     */
+    postSettlementAddress?: Address;
+    previousAddresses?: PreviousAddress[];
+}
+export interface CommonAddressProperties {
+    externalId?: string;
+    housingStatus?: HousingStatusList;
+    residentialAddress?: Address;
+    startDate?: string;
+}
+export declare enum HousingStatusList {
+    Boarding = "Boarding",
+    Caravan = "Caravan",
+    Other = "Other",
+    OwnHome = "Own Home",
+    OwnHomeMortgage = "Own Home Mortgage",
+    Renting = "Renting",
+    SuppliedByEmployer = "Supplied by Employer",
+    WithParents = "With Parents"
+}
+/**
+ * applicant's mailing address being captured as part of funnels 5 (post product select)
+ *
+ * applicant's post settlement address being captured as part of funnels 5 (post product
+ * select)
+ */
+export interface Address {
+    city?: string;
+    country?: Countries;
+    formatted?: string;
+    postcode?: string;
+    standard?: AddressStandard;
+    state?: string;
+}
+export interface AddressStandard {
+    /**
+     * The building name
+     */
+    buildingName?: string;
+    /**
+     * Postal address, usually a PO Box or Locked Bag
+     */
+    deliveryAddress?: string;
+    level?: string;
+    /**
+     * The lot number
+     */
+    lotSection?: string;
+    streetName?: string;
+    streetNumber?: string;
+    /**
+     * The street suffix
+     */
+    streetSuffix?: string;
+    streetType?: string;
+    unit?: string;
+}
+export interface PreviousAddress {
+    endDate?: string;
+    externalId?: string;
+    housingStatus?: HousingStatusList;
+    residentialAddress?: Address;
+    startDate?: string;
+}
+/**
+ * current credit status of the applicant (Customer declared value)
+ */
+export declare enum CreditStatus {
+    Average = "AVERAGE",
+    Excellent = "EXCELLENT",
+    Fair = "FAIR",
+    Unknown = "UNKNOWN"
+}
+export interface Dependant {
+    age?: number;
+    /**
+     * Id for entity.
+     */
+    id?: string;
+    /**
+     * Whether dependant was added for this applicant.
+     */
+    isAddedOnThisApplicant?: boolean;
+    sharedWith?: ApplicantKeyObject;
+}
+export interface ApplicantKeyObject {
+    applicantId?: string;
+}
+/**
+ * applicant's employment type
+ */
+export declare enum EmploymentType {
+    Employee = "EMPLOYEE",
+    SelfEmployed = "SELF_EMPLOYED",
+    Unknown = "UNKNOWN"
+}
+/**
+ * applicant's entity. For a person applicant this is 'PERSON'
+ */
+export declare enum Entity {
+    Company = "COMPANY",
+    Person = "PERSON"
+}
+export declare enum Gender {
+    Female = "FEMALE",
+    Male = "MALE",
+    Undisclosed = "UNDISCLOSED",
+    Unknown = "UNKNOWN"
+}
+/**
+ * different invitation statuses an applicant can have
+ */
+export declare enum InvitationStatus {
+    Accepted = "ACCEPTED",
+    Cancelled = "CANCELLED",
+    Expired = "EXPIRED",
+    Pending = "PENDING"
+}
+export declare enum MaritalStatus {
+    DeFacto = "DE_FACTO",
+    Divorced = "DIVORCED",
+    Married = "MARRIED",
+    Single = "SINGLE",
+    Unknown = "UNKNOWN"
+}
+/**
+ * The metadata of the applicant
+ */
+export interface ApplicantMeta {
+    /**
+     * uuid of user who made the action (create/update/delete)
+     */
+    actionedBy: string;
+    /**
+     * role of the user that made the action
+     */
+    actionedByRole: ActionedByRole;
+}
+/**
+ * role of the user that made the action
+ */
+export declare enum ActionedByRole {
+    Customer = "customer",
+    Team = "team"
+}
+export declare enum ResidencyStatus {
+    AustralianCitizen = "AUSTRALIAN_CITIZEN",
+    PermanentResident = "PERMANENT_RESIDENT",
+    TemporaryResident = "TEMPORARY_RESIDENT",
+    Unknown = "UNKNOWN"
+}
+export declare enum Title {
+    DR = "DR",
+    MS = "MS",
+    Miss = "MISS",
+    Mr = "MR",
+    Mrs = "MRS",
+    Unknown = "UNKNOWN"
+}
+export declare enum Type {
+    CreateApplicant = "CreateApplicant",
+    UpdateApplicant = "UpdateApplicant"
+}