@lendi/integrations-transform 1.0.7 → 1.1.1

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

@@ -0,0 +1,469 @@
+/**
+ * Create, update or delete
+ */
+export interface PublicAsset {
+    payload: AssetDefinition;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+/**
+ * create/update Asset payload
+ */
+export interface AssetDefinition {
+    applicationId: string;
+    asset: Asset;
+    /**
+     * uuid of asset
+     */
+    id: string;
+    meta?: Meta;
+}
+export interface Asset {
+    address?: Address;
+    constructionDetails?: ConstructionDetails;
+    contractDetails?: ContractDetails;
+    contractPriceAmount?: number;
+    description?: string;
+    estimatedValue?: number;
+    financialInstitution?: string;
+    financialInstitutionShortName?: string;
+    knockDownToRebuild?: boolean;
+    make?: string;
+    model?: string;
+    percentOwned?: PercentOwned;
+    primaryPurpose?: PrimaryPurpose;
+    propertyStatus?: PropertyStatus;
+    propertyType?: PropertyType;
+    toBePurchased?: boolean;
+    toBeSold?: boolean;
+    toBeUsedAsSecurity?: boolean;
+    type: AssetType;
+    year?: number;
+    zoneType?: ZoneType;
+}
+export interface Address {
+    /**
+     * The city / suburb name
+     */
+    city?: string;
+    country?: Countries;
+    /**
+     * A formatted version of the address
+     */
+    formatted?: string;
+    /**
+     * N digit postcode (for AU addresses, usually 4)
+     */
+    postcode?: string;
+    standard?: AddressStandard;
+    /**
+     * The state name
+     */
+    state?: string;
+}
+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 AddressStandard {
+    /**
+     * The building name
+     */
+    buildingName?: string;
+    /**
+     * Postal address, usually a PO Box or Locked Bag
+     */
+    deliveryAddress?: string;
+    /**
+     * The level of the unit/apartment
+     */
+    level?: string;
+    /**
+     * The lot number
+     */
+    lotSection?: string;
+    /**
+     * The street name
+     */
+    streetName?: string;
+    /**
+     * The street number
+     */
+    streetNumber?: string;
+    /**
+     * The street suffix
+     */
+    streetSuffix?: string;
+    /**
+     * The type of the street i.e. road
+     */
+    streetType?: string;
+    /**
+     * The unit number
+     */
+    unit?: string;
+}
+export interface ConstructionDetails {
+    /**
+     * Indicates whether it should be coded as vacant land loan or a construction loan
+     */
+    buildIn6Months?: boolean;
+    buildPriceAmount?: number;
+    landEstimatedValue?: number;
+}
+/**
+ * Details of the purchase/sale price as specified in the Contract of Sale
+ */
+export interface ContractDetails {
+    /**
+     * The date of the Contract of Sale.
+     */
+    contractDate?: string;
+    /**
+     * Captures the total purchase/sale price as specified in the Contract of Sale.
+     */
+    contractPriceAmount?: number;
+    /**
+     * The purchase date of the property, or the proposed settlement date for a property being
+     * purchased or sold
+     */
+    estimatedSettlementDate?: string;
+}
+export interface PercentOwned {
+    owners?: ApplicantOwnership[];
+    /**
+     * Indicate whether ownership proportions are equal, specified individually for each one or
+     * not specified.
+     */
+    proportions?: Proportions;
+}
+export interface ApplicantOwnership {
+    /**
+     * The applicant Identifier
+     */
+    applicantId: string;
+    customerId?: string;
+    /**
+     * how much percent for the corresponding applicant
+     */
+    percent: number;
+}
+/**
+ * Indicate whether ownership proportions are equal, specified individually for each one or
+ * not specified.
+ */
+export declare enum Proportions {
+    Equal = "EQUAL",
+    NotSpecified = "NOT_SPECIFIED",
+    Specified = "SPECIFIED"
+}
+export declare enum PrimaryPurpose {
+    Investment = "INVESTMENT",
+    OwnerOccupied = "OWNER_OCCUPIED"
+}
+export declare enum PropertyStatus {
+    Established = "ESTABLISHED",
+    NewBuilding = "NEW_BUILDING",
+    OffThePlan = "OFF_THE_PLAN",
+    VacantLand = "VACANT_LAND"
+}
+export declare enum PropertyType {
+    ApartmentUnitLessThan50M2 = "APARTMENT_UNIT_LESS_THAN_50M2",
+    ApartmentUnitMoreThan50M2 = "APARTMENT_UNIT_MORE_THAN_50M2",
+    Duplex = "DUPLEX",
+    FullyDetachedHouse = "FULLY_DETACHED_HOUSE",
+    KitHome = "KIT_HOME",
+    Land = "LAND",
+    MultiDwellingSingleTitle = "MULTI_DWELLING_SINGLE_TITLE",
+    PropertyOver10_Ha = "PROPERTY_OVER_10_HA",
+    SemiDetachedHouse = "SEMI_DETACHED_HOUSE",
+    ServicedApartment = "SERVICED_APARTMENT",
+    StudentAccommodation = "STUDENT_ACCOMMODATION",
+    Studio = "STUDIO",
+    Terrace = "TERRACE",
+    Townhouse = "TOWNHOUSE",
+    Villa = "VILLA",
+    WarehouseApartment = "WAREHOUSE_APARTMENT"
+}
+export declare enum AssetType {
+    Gifts = "GIFTS",
+    HomeContents = "HOME_CONTENTS",
+    ManagedFunds = "MANAGED_FUNDS",
+    OtherAsset = "OTHER_ASSET",
+    Property = "PROPERTY",
+    SavingCheckAccount = "SAVING_CHECK_ACCOUNT",
+    Shares = "SHARES",
+    Superannuation = "SUPERANNUATION",
+    TermDeposit = "TERM_DEPOSIT",
+    Vehicle = "VEHICLE"
+}
+export declare enum ZoneType {
+    Commercial = "COMMERCIAL",
+    Industrial = "INDUSTRIAL",
+    Residential = "RESIDENTIAL",
+    Rural = "RURAL"
+}
+/**
+ * The metadata of the alieo
+ */
+export interface Meta {
+    /**
+     * 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 Type {
+    AssetCreated = "AssetCreated",
+    AssetUpdated = "AssetUpdated"
+}