@simplyhomes/sos-sdk/dist/generated/src/models/SoSMarketEntityBase.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 SoSMarketEntityBase
 */
export interface SoSMarketEntityBase {
    /**
     * Unique market identifier
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    mid: number;
    /**
     * Market name
     * @type {string}
     * @memberof SoSMarketEntityBase
     */
    name: string;
    /**
     * Geographic area covered by this market (PostGIS geometry)
     * @type {object}
     * @memberof SoSMarketEntityBase
     */
    area: object;
    /**
     * Default owner ID for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    defaultOwnerId: number;
    /**
     * Threshold NOI cap rate for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    thresholdNoiCapRate?: number;
    /**
     * Threshold ARV uplift percentage for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    thresholdArvUplift?: number;
    /**
     * Title insurance percentage for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    titleInsurancePercentage?: number;
    /**
     * Default term template ID for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    defaultTermTemplateId: number;
    /**
     * Expected vacancy percentage for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    vacancyPercentage?: number;
    /**
     * Expected repair and maintenance percentage for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    repairAndMaintenancePercentage?: number;
    /**
     * Replacement cost per square foot for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    replacementCostPerFeet?: number;
    /**
     * Default county ID for this market
     * @type {string}
     * @memberof SoSMarketEntityBase
     */
    defaultCountyId?: string;
    /**
     * Default title company ID for this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    defaultTitleCompanyId?: number;
    /**
     * Organization ID that owns this market
     * @type {number}
     * @memberof SoSMarketEntityBase
     */
    organizationId?: number;
}
/**
 * Check if a given object implements the SoSMarketEntityBase interface.
 */
export declare function instanceOfSoSMarketEntityBase(value: object): value is SoSMarketEntityBase;
export declare function SoSMarketEntityBaseFromJSON(json: any): SoSMarketEntityBase;
export declare function SoSMarketEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSMarketEntityBase;
export declare function SoSMarketEntityBaseToJSON(json: any): SoSMarketEntityBase;
export declare function SoSMarketEntityBaseToJSONTyped(value?: SoSMarketEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSMarketEntityBase.d.ts.map