@simplyhomes/sos-sdk/dist/generated/src/models/SoSUnitEntityRentometerV1SummaryData.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * API v4
 * Swagger documentation for API v4
 *
 * The version of the OpenAPI document: 4.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface SoSUnitEntityRentometerV1SummaryData
 */
export interface SoSUnitEntityRentometerV1SummaryData {
    /**
     * Address of the unit
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    address: string;
    /**
     * Latitude coordinate
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    latitude: string;
    /**
     * Longitude coordinate
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    longitude: string;
    /**
     * Number of bedrooms
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    bedrooms: number;
    /**
     * Number of bathrooms as string
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    baths: string;
    /**
     * Type of building
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    building_type: string;
    /**
     * Number of days to look back for data
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    look_back_days: number;
    /**
     * Mean rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    mean: number;
    /**
     * Median rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    median: number;
    /**
     * Minimum rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    min: number;
    /**
     * Maximum rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    max: number;
    /**
     * 25th percentile rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    percentile_25: number;
    /**
     * 75th percentile rent value
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    percentile_75: number;
    /**
     * Standard deviation of rent values
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    std_dev: number;
    /**
     * Number of samples in the data set
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    samples: number;
    /**
     * Search radius in miles
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    radius_miles: number;
    /**
     * URL for quick view of the data
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    quickview_url: string;
    /**
     * Remaining API credits
     * @type {number}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    credits_remaining: number;
    /**
     * API token used for the request
     * @type {string}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    token: string;
    /**
     * Timestamp when the data was retrieved
     * @type {Date}
     * @memberof SoSUnitEntityRentometerV1SummaryData
     */
    timestamp: string;
}
/**
 * Check if a given object implements the SoSUnitEntityRentometerV1SummaryData interface.
 */
export declare function instanceOfSoSUnitEntityRentometerV1SummaryData(value: object): value is SoSUnitEntityRentometerV1SummaryData;
export declare function SoSUnitEntityRentometerV1SummaryDataFromJSON(json: any): SoSUnitEntityRentometerV1SummaryData;
export declare function SoSUnitEntityRentometerV1SummaryDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSUnitEntityRentometerV1SummaryData;
export declare function SoSUnitEntityRentometerV1SummaryDataToJSON(json: any): SoSUnitEntityRentometerV1SummaryData;
export declare function SoSUnitEntityRentometerV1SummaryDataToJSONTyped(value?: SoSUnitEntityRentometerV1SummaryData | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSUnitEntityRentometerV1SummaryData.d.ts.map