@simplyhomes/sos-sdk/dist/generated/src/models/SoSRentalListingEntityBase.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 { SoSRentalListingEntityStatus } from './SoSRentalListingEntityStatus';
import type { SoSRentalListingEntityTenantType } from './SoSRentalListingEntityTenantType';
/**
 *
 * @export
 * @interface SoSRentalListingEntityBase
 */
export interface SoSRentalListingEntityBase {
    /**
     * Unique rental listing identifier
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    rlid: number;
    /**
     * Unit ID reference - every rental listing must be associated with a specific unit
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    unitId: number;
    /**
     * Current status of the rental listing
     * @type {SoSRentalListingEntityStatus}
     * @memberof SoSRentalListingEntityBase
     */
    status?: SoSRentalListingEntityStatus;
    /**
     * Type of tenant for this listing
     * @type {SoSRentalListingEntityTenantType}
     * @memberof SoSRentalListingEntityBase
     */
    tenantType?: SoSRentalListingEntityTenantType;
    /**
     * Monthly rent price for the listing
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    listingRentPrice?: number;
    /**
     * Number of showings conducted
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    showingCount?: number;
    /**
     * Number of applications received
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    applicantCount?: number;
    /**
     * Number of Section 8 inspections conducted
     * @type {number}
     * @memberof SoSRentalListingEntityBase
     */
    section8InspectionCount?: number;
    /**
     * URL for listing on Zéro (affordable housing platform)
     * @type {string}
     * @memberof SoSRentalListingEntityBase
     */
    zeroListingUrl?: string;
    /**
     * URL for listing on affordable housing platform
     * @type {string}
     * @memberof SoSRentalListingEntityBase
     */
    affordableHousingListingUrl?: string;
    /**
     * Additional notes about the rental listing
     * @type {string}
     * @memberof SoSRentalListingEntityBase
     */
    notes?: string;
    /**
     * Date when PM walkthrough was conducted
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    pmWalkthroughDate?: string;
    /**
     * Date when unit was prepared for market
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    prepareForMarketDate?: string;
    /**
     * Date when listing was published
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    listingPublishDate?: string;
    /**
     * Date of first showing
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    firstShowingDate?: string;
    /**
     * Date when first application was received
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    firstApplicationDate?: string;
    /**
     * Date when tenant was selected
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    tenantSelectDate?: string;
    /**
     * Date when RFTA (Request for Tenancy Approval) was submitted
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    rftaSubmissionDate?: string;
    /**
     * Date when RFTA was approved
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    rftaApprovalDate?: string;
    /**
     * Date of Section 8 inspection
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    section8InspectionDate?: string;
    /**
     * Date when Section 8 inspection passed
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    section8PassedDate?: string;
    /**
     * When the rental listing was created
     * @type {Date}
     * @memberof SoSRentalListingEntityBase
     */
    createdAt?: string;
}
/**
 * Check if a given object implements the SoSRentalListingEntityBase interface.
 */
export declare function instanceOfSoSRentalListingEntityBase(value: object): value is SoSRentalListingEntityBase;
export declare function SoSRentalListingEntityBaseFromJSON(json: any): SoSRentalListingEntityBase;
export declare function SoSRentalListingEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSRentalListingEntityBase;
export declare function SoSRentalListingEntityBaseToJSON(json: any): SoSRentalListingEntityBase;
export declare function SoSRentalListingEntityBaseToJSONTyped(value?: SoSRentalListingEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSRentalListingEntityBase.d.ts.map