@simplyhomes/sos-client/dist/client/properties/getById/types.d.ts

Client SDK for SimplyHomes SOS API

export type Group = {
    lineItems: LineItem[];
    isMultiSelect?: boolean;
    simplyResponsibleByDefault?: boolean;
};
type LineItem = {
    title: string;
    isDefault?: boolean;
    allowances: number[];
    type: 'gas' | 'gas-customer-charge' | 'electricity' | 'electricity-customer-charge' | 'water' | 'sewer' | 'trash' | 'appliances';
};
export declare class SDK_GetPropertyByPid_Param_Dto {
    propertyId: string;
}
export type SDK_GetPropertyById_IncludedFieldsType = 'leads' | 'utilitiesConfiguration' | 'threads';
export declare class SDK_GetPropertyByPid_Body_Dto {
    included?: SDK_GetPropertyById_IncludedFieldsType[];
}
export declare class SDK_GetPropertyByPid_Source_Property_Unit {
    uid: number;
    bed: number;
    bath: number;
    grossRentFinal: number;
    utilitiesTenantPayingFinal: number;
    hcvRentFinal: number;
    hcvRent: number;
    hcvSource: string;
}
export declare class SDK_GetPropertyByPid_Source_Property {
    pid: string;
    addressOneLine: string;
    askingPrice: number;
    sqft: number;
    units: SDK_GetPropertyByPid_Source_Property_Unit[];
}
export declare class SDK_GetPropertyByPid_Source {
    sid: string;
    createdAt: string;
    source: string;
}
export type SDK_GetPropertyByPid_Property_Utilities_Allowances = Record<string, Group>;
export declare class SDK_GetPropertyByPid_Property_Characteristics {
    waterSupply?: string;
    sewageType?: string;
    drainType?: string;
    construction?: string;
    foundation?: string;
    siding?: string;
    roofType?: string;
    roofAge?: string;
    stories?: string;
}
export declare class SDK_GetPropertyByPid_Property_FeaturesAndAmenities {
    hasAttic?: boolean;
    hasDeck?: boolean;
    hasPatio?: boolean;
    hasCommonSpace?: boolean;
    hasYard?: boolean;
    hasElevator?: boolean;
    hasBasement?: boolean;
    hasCommonLaundry?: boolean;
    hasGarage?: boolean;
    hasGate?: boolean;
    hasPool?: boolean;
    hasPorch?: boolean;
    hasSidewalk?: boolean;
    hasDriveway?: boolean;
    hasExteriorStairs?: boolean;
}
export declare class SDK_GetPropertyByPid_Property_Overview_Source {
    sourceId: number;
    sourceType: string;
}
export declare class SDK_GetPropertyByPid_Property_Overview_HousingAuthority {
    housingAuthorityId: number;
    housingAuthorityName: string;
}
export declare class SDK_GetPropertyByPid_Property_Overview_Neighborhood {
    neighborhoodId: string;
    neighborhoodName?: string;
}
export declare class SDK_GetPropertyByPid_Property_Overview {
    propertyId: string;
    placeId?: string;
    propertyStatus?: string;
    offerPrice?: number;
    askingPrice?: number;
    asIsValue?: number;
    renoAmount?: number;
    arv?: number;
    capRate?: number;
    arvUplift?: number;
    maxPriceArvUplift?: number;
    maxPriceCapRate?: number;
    allIn?: number;
    sqft?: number;
    yearBuilt?: number;
    source?: SDK_GetPropertyByPid_Property_Overview_Source;
    housingAuthority?: SDK_GetPropertyByPid_Property_Overview_HousingAuthority;
    neighborhood?: SDK_GetPropertyByPid_Property_Overview_Neighborhood;
    oneLineAddress: string;
    cityTown?: string;
    state?: string;
    propertyType?: string;
    characteristics?: SDK_GetPropertyByPid_Property_Characteristics;
    featuresAndAmenities?: SDK_GetPropertyByPid_Property_FeaturesAndAmenities;
}
export declare class SDK_GetPropertyByPid_Property_UnitDetails_RoomsStories {
    bedrooms: number;
    bathrooms: number;
    stories?: number;
}
export declare class SDK_GetPropertyByPid_Property_UnitDetails_Ren {
    hcv_rent?: number;
    hcvTotalUtilityAllowance?: number;
    hcvEstimatedGrossRent?: number;
    housingAuthority?: SDK_GetPropertyByPid_Property_Overview_HousingAuthority;
}
export declare class SDK_GetPropertyByPid_Property_UnitDetails_AccessDetails {
    type?: string;
    code?: string;
    owner?: number;
}
export declare class SDK_GetPropertyByPid_Unit_Details_Photos {
    iuid: string;
    cfWebpOriginal?: string;
    cfWebpThumbnail150?: string;
    cfWebpThumbnail400?: string;
}
export declare class SDK_GetPropertyByPid_Property_UnitDetails_Details {
    exists?: boolean;
    serialValue?: string;
    model?: string;
    condition?: string;
    photos?: SDK_GetPropertyByPid_Unit_Details_Photos[];
}
export declare class SDK_GetPropertyByPid_Property_UnitDetail {
    unitId: number;
    roomStories: SDK_GetPropertyByPid_Property_UnitDetails_RoomsStories;
    rent?: SDK_GetPropertyByPid_Property_UnitDetails_Ren;
    utilitiesConfiguration?: Record<string, any>[];
    accessDetails?: SDK_GetPropertyByPid_Property_UnitDetails_AccessDetails;
    refrigeratorDetails?: SDK_GetPropertyByPid_Property_UnitDetails_Details;
    stoveDetails?: SDK_GetPropertyByPid_Property_UnitDetails_Details;
    microwaveDetails?: SDK_GetPropertyByPid_Property_UnitDetails_Details;
    hvacDetails?: SDK_GetPropertyByPid_Property_UnitDetails_Details;
}
export declare class SDK_GetPropertyByPid_Property_Area_Market {
    marketId: number;
    marketName: string;
}
export declare class SDK_GetPropertyByPid_Property_Area_County {
    countyId: string;
    countyName?: string;
}
export declare class SDK_GetPropertyByPid_Property_Area_PropertyManager {
    propertyManagerId: number;
    propertyManagerName: string;
}
export declare class SDK_GetPropertyByPid_Property_Area_HousingAuthority {
    type: string;
    paymentStandard: string;
}
export declare class SDK_GetPropertyByPid_Property_Area {
    county?: SDK_GetPropertyByPid_Property_Area_County;
    zipcode?: string;
    market?: SDK_GetPropertyByPid_Property_Area_Market;
    propertyManager?: SDK_GetPropertyByPid_Property_Area_PropertyManager;
    neighborhood?: SDK_GetPropertyByPid_Property_Overview_Neighborhood;
    housingAuthority?: SDK_GetPropertyByPid_Property_Area_HousingAuthority;
}
export declare class SDK_GetPropertyByPid_Property_TaxHistory {
    apn?: string;
    fips?: string;
    assessedLandValue?: number;
    assessedImprovementValue?: number;
    assessedTotalValue?: number;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting_PurchaseDetails {
    targetPurchasePrice?: number;
    arvUplift?: number;
    capRateHcvRent?: number;
    maxPriceArvUplift?: number;
    maxPriceCapRate?: number;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting_FeesAndCosts {
    allInCost?: number;
    estimatedGrossHud?: number;
    contractPrice?: number;
    titleInsurance?: number;
    transferTax?: number;
    coreClosingCost?: number;
    estimatedAcquisitionCost?: number;
    postPurchaseCost?: number;
    ownerReserveAmount?: number;
    pmReserveAmount?: number;
    pmOnboardingAmount?: number;
    estimatedRenovationCost?: number;
}
export declare class SoSPropertyEntity_UnderwritingModels_Expenses {
    name?: string;
    monthly?: number;
}
export declare class SoSPropertyEntity_UnderwritingModels_Settings {
    simply_paying_utils?: boolean;
    monthly_rent?: number;
    pm_fees_percentage?: number;
    am_fees_percentage?: number;
    vacancy_percentage?: number;
}
export declare class SoSPropertyEntity_UnderwritingModel_Overrides {
    pm_fees_monthly?: number;
    am_fees_monthly?: number;
    vacancy_monthly?: number;
    repair_and_maintainance_monthly?: number;
    insurance_monthly?: number;
    tax_monthly?: number;
    utilities_simply_paying_monthly?: number;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModel {
    name?: string;
    settings?: SoSPropertyEntity_UnderwritingModels_Settings;
    overrides?: SoSPropertyEntity_UnderwritingModel_Overrides;
    expenses?: SoSPropertyEntity_UnderwritingModels_Expenses[];
    applicable?: boolean;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModelsCalculated {
    cap_rate?: number;
    max_price_cap_rate?: number;
    max_price_cap_rate_tries?: number;
    arv_uplift?: number;
    max_price_arv_uplift?: number;
    max_price_arv_uplift_tries?: number;
    noi_monthly?: number;
    pm_fees_monthly?: number;
    am_fees_monthly?: number;
    vacancy_monthly?: number;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModelsMaxPrice {
    max_price_cap_rate_tries?: number;
    max_price_cap_rate?: number;
    max_price_arv_uplift_tries?: number;
    max_price_arv_uplift?: number;
}
export declare class SDK_GetPropertyByPid_Property_Underwriting {
    purchaseDetails?: SDK_GetPropertyByPid_Property_Underwriting_PurchaseDetails;
    feesAndCosts?: SDK_GetPropertyByPid_Property_Underwriting_FeesAndCosts;
    underwritingModels?: SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModel;
    underwritingModelsCalculated?: SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModelsCalculated;
    underwritingModelsMaxPrices?: SDK_GetPropertyByPid_Property_Underwriting_UnderwritingModelsMaxPrice;
    utilitiesAllowances?: SDK_GetPropertyByPid_Property_Utilities_Allowances;
}
export declare class SDK_GetPropertyByPid_Property_Source {
    type?: string;
    dateAdded?: string;
    askingPrice?: number;
    estimatedReno?: number;
}
export declare class SDK_GetPropertyByPid_Property_Lead_Offer {
    offerId: number;
    status: string;
}
export declare class SDK_GetPropertyByPid_Property_Lead_Property {
    propertyId: string;
    addressOneLine: string;
}
export declare class SDK_GetPropertyByPid_Property_Lead {
    name?: string;
    status?: string;
    propertiesCount?: number;
    createdAt?: string;
    assignees?: string[];
    offers?: SDK_GetPropertyByPid_Property_Lead_Offer[];
    properties?: SDK_GetPropertyByPid_Property_Lead_Property[];
    threads?: number[];
}
export declare class SDK_GetPropertyByPid_Property {
    overview: SDK_GetPropertyByPid_Property_Overview;
    unitDetails: SDK_GetPropertyByPid_Property_UnitDetail[];
    area: SDK_GetPropertyByPid_Property_Area;
    taxHistory: SDK_GetPropertyByPid_Property_TaxHistory;
    underwriting: SDK_GetPropertyByPid_Property_Underwriting;
    source: SDK_GetPropertyByPid_Property_Source;
    leads?: SDK_GetPropertyByPid_Property_Lead[];
}
export declare class SDK_GetPropertyByPid_Response_Dto {
    property: SDK_GetPropertyByPid_Property | null;
}
export type SDK_GetPropertyByPid_Params = SDK_GetPropertyByPid_Param_Dto & SDK_GetPropertyByPid_Body_Dto;
export {};