@simplyhomes/sos-sdk/dist/generated/src/models/SoSUnitEntityBase.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.
 */
import type { SoSUnitEntityRentometerV1SummaryData } from './SoSUnitEntityRentometerV1SummaryData';
import type { SoSUnitEntityUtilitiesTenantResponsibility } from './SoSUnitEntityUtilitiesTenantResponsibility';
import type { SoSUnitEntityUtilitiesConfigItem } from './SoSUnitEntityUtilitiesConfigItem';
/**
 *
 * @export
 * @interface SoSUnitEntityBase
 */
export interface SoSUnitEntityBase {
    /**
     * Unique unit identifier
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    uid: number;
    /**
     * Unit name or identifier
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    name?: string;
    /**
     * Number of bedrooms
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    bedrooms: number;
    /**
     * Number of bathrooms
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    bathrooms: number;
    /**
     * Number of stories
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    stories?: number;
    /**
     * Property ID reference
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    propertyId: string;
    /**
     * Gross monthly rent
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    grossRent?: number;
    /**
     * Manual override for gross rent
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    grossRentOverride?: number;
    /**
     * Final gross rent after overrides
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    grossRentFinal?: number;
    /**
     * Utilities Simply is paying monthly
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    utilitiesSimplyPaying?: number;
    /**
     * Override for utilities Simply is paying
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    utilitiesSimplyPayingOverride?: number;
    /**
     * Utilities tenant is paying monthly
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    utilitiesTenantPaying?: number;
    /**
     * Override for utilities tenant is paying
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    utilitiesTenantPayingOverride?: number;
    /**
     * Final utilities tenant is paying after overrides
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    utilitiesTenantPayingFinal?: number;
    /**
     * Housing Choice Voucher rent amount
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    hcvRent?: number;
    /**
     * Final HCV rent after overrides
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    hcvRentFinal?: number;
    /**
     * Override for HCV rent
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    hcvRentOverride?: number;
    /**
     * Type of access method for the unit
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    accessDetailType?: string;
    /**
     * Access code for the unit
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    accessDetailCode?: string;
    /**
     * Configuration mapping utility line items to their groups
     * @type {Array<SoSUnitEntityUtilitiesConfigItem>}
     * @memberof SoSUnitEntityBase
     */
    utilitiesConfig?: Array<SoSUnitEntityUtilitiesConfigItem>;
    /**
     * Defines which utilities the tenant is responsible for paying
     * @type {SoSUnitEntityUtilitiesTenantResponsibility}
     * @memberof SoSUnitEntityBase
     */
    utilitiesTenantResponsibility?: SoSUnitEntityUtilitiesTenantResponsibility;
    /**
     * Whether refrigerator exists in unit
     * @type {boolean}
     * @memberof SoSUnitEntityBase
     */
    refrigeratorDetailsExists?: boolean;
    /**
     * Refrigerator serial number
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    refrigeratorDetailsSerial?: string;
    /**
     * Refrigerator model
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    refrigeratorDetailsModel?: string;
    /**
     * Refrigerator condition
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    refrigeratorDetailsCondition?: string;
    /**
     * Whether stove exists in unit
     * @type {boolean}
     * @memberof SoSUnitEntityBase
     */
    stoveDetailsExists?: boolean;
    /**
     * Stove serial number
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    stoveDetailsSerial?: string;
    /**
     * Stove model
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    stoveDetailsModel?: string;
    /**
     * Stove condition
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    stoveDetailsCondition?: string;
    /**
     * Whether microwave exists in unit
     * @type {boolean}
     * @memberof SoSUnitEntityBase
     */
    microwaveDetailsExists?: boolean;
    /**
     * Microwave serial number
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    microwaveDetailsSerial?: string;
    /**
     * Microwave model
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    microwaveDetailsModel?: string;
    /**
     * Microwave condition
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    microwaveDetailsCondition?: string;
    /**
     * Whether HVAC system exists in unit
     * @type {boolean}
     * @memberof SoSUnitEntityBase
     */
    hvacDetailsExists?: boolean;
    /**
     * HVAC system serial number
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    hvacDetailsSerial?: string;
    /**
     * HVAC system model
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    hvacDetailsModel?: string;
    /**
     * HVAC system condition
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    hvacDetailsCondition?: string;
    /**
     * Array of refrigerator photo URLs
     * @type {Array<string>}
     * @memberof SoSUnitEntityBase
     */
    refrigeratorDetailsPhotos?: Array<string>;
    /**
     * Array of stove photo URLs
     * @type {Array<string>}
     * @memberof SoSUnitEntityBase
     */
    stoveDetailsPhotos?: Array<string>;
    /**
     * Array of microwave photo URLs
     * @type {Array<string>}
     * @memberof SoSUnitEntityBase
     */
    microwaveDetailsPhotos?: Array<string>;
    /**
     * Array of HVAC system photo URLs
     * @type {Array<string>}
     * @memberof SoSUnitEntityBase
     */
    hvacDetailsPhotos?: Array<string>;
    /**
     * Current rental status of the unit
     * @type {string}
     * @memberof SoSUnitEntityBase
     */
    rentalStatus?: string;
    /**
     * Actual rent being charged
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    rentalActualRent?: number;
    /**
     * Market rent data from Rentometer V1 API service
     * @type {SoSUnitEntityRentometerV1SummaryData}
     * @memberof SoSUnitEntityBase
     */
    rentometerV1SummaryData?: SoSUnitEntityRentometerV1SummaryData;
    /**
     * Average market rent for similar units
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    marketRentAverage?: number;
    /**
     * Median market rent for similar units
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    marketRentMedian?: number;
    /**
     * 25th percentile market rent
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    marketRent25Percentile?: number;
    /**
     * 75th percentile market rent
     * @type {number}
     * @memberof SoSUnitEntityBase
     */
    marketRent75Percentile?: number;
}
/**
 * Check if a given object implements the SoSUnitEntityBase interface.
 */
export declare function instanceOfSoSUnitEntityBase(value: object): value is SoSUnitEntityBase;
export declare function SoSUnitEntityBaseFromJSON(json: any): SoSUnitEntityBase;
export declare function SoSUnitEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSUnitEntityBase;
export declare function SoSUnitEntityBaseToJSON(json: any): SoSUnitEntityBase;
export declare function SoSUnitEntityBaseToJSONTyped(value?: SoSUnitEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSUnitEntityBase.d.ts.map