@realestate/types
Version:
Types for real estate
124 lines (112 loc) • 6.16 kB
TypeScript
/**
* Copyright (c) 2023 ListBird. All Rights Reserved.
*
* This software product includes software or other works developed by RESO,
* subject to the RESO End User License published at www.reso.org.
*
* Any modifications, derivative works, or redistributions of this source must
* maintain this copyright notice. See the RESO EULA for more information.
*/
import { HistoryTransactional } from './HistoryTransactional';
import { PowerProductionAnnualStatus } from './PowerProductionAnnualStatus';
import { PowerProductionType } from './PowerProductionType';
import { Property } from './Property';
export interface PropertyPowerProduction {
/**
* {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28PropertyPowerProduction%29+Field}
*
* This is the foreign ID relating to the Property Resource. The well known identifier for the listing. The
* value may be identical to that of the Listing Key, but the Listing ID is intended to be the value used by
* a human to retrieve the information about a specific listing. In a multiple originating system or a
* merged system, this value may not be unique and may require the use of the provider system to create a
* synthetic unique value.
*/
ListingId?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/ListingKey+%28PropertyPowerProduction%29+Field}
*
* This is the foreign key relating to the Property Resource. A unique identifier for this record from the
* immediate source. This is a string that can include URI or other forms. Alternatively use the
* ListingKeyNumeric for a numeric only key field. This is the local key of the system. When records are
* received from other systems, a local key is commonly applied. If conveying the original keys from the
* source or originating systems, see SourceSystemKey and OriginatingSystemKey.
*/
ListingKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/ListingKeyNumeric+%28PropertyPowerProduction%29+Field}
*
* This is the foreign key relating to the property resource. A unique identifier for this record from the
* immediate source. This is the numeric only key and used as an alternative to the ListingKey fields. This
* is the local key of the system. When records are received from other systems, a local key is commonly
* applied. If conveying the original keys from the source or originating systems, see SourceSystemKey and
* OriginatingSystemKey.
*/
ListingKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28PropertyPowerProduction%29+Field}
*
* Date/time this record was last modified.
*/
ModificationTimestamp?: Date;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionAnnual+Field}
*
* The most important metric of a renewables system is the amount of power it produces per year. This number
* can be actual or estimated. Annual production for systems producing electricity like wind or solar are
* measured in kilowatt hours (kWh) per year. A kWh is like a measure of the distance traveled per hour for
* a car – how far did it go over a certain period of time. Annual production is influenced by the size of
* the system, the conditions (How shady are the trees? How many cloudy days?, and the installation. Sellers
* typically have access to software that provides historical production totals.
*/
PowerProductionAnnual?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionAnnualStatus+Field}
*
* The most important metric of a renewables system is the amount of power it produces per year. This
* number can be actual or estimated, or a combination if less than 12 months of actual data is available
* (any missing months of actual data is extrapolated). This field allows the status of the number shown in
* the PowerProducationAnnual to be clarified.
*/
PowerProductionAnnualStatus?: PowerProductionAnnualStatus;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionKey+Field}
*
* A unique identifier for this record. This is a string that can include URI or other forms. Alternatively
* use the "...KeyNumeric" for a numeric only key field. This is the local key of the system.
*/
PowerProductionKey?: string;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionKeyNumeric+Field}
*
* A unique identifier for this record. This is the numeric only key and used as an alternative to the
* string Key field. This is the local key of the system.
*/
PowerProductionKeyNumeric?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionSize+Field}
*
* The “capacity” of a renewables system. Size is measured in kilowatts (kW) DC (referring to direct
* current). A kW indicates how much power the system can produce under standard conditions, like the size
* of a car engine. Renewables systems are sized when they are installed to cover all or a portion of the
* power needs of the property. Therefore, a system designed to produce 50% of the power needs will be sized
* smaller than a system on the exact same property designed to produce 100%. Size may be influenced by
* available space at the property, orientation, landscaping, etc.
*/
PowerProductionSize?: number;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionType+%28PropertyPowerProduction%29+Field}
*
* This field is a list of the type of power production system available on the property.
*/
PowerProductionType?: PowerProductionType;
/**
* {@link https://ddwiki.reso.org/display/DDW17/PowerProductionYearInstall+Field}
*
* The year a renewables system was installed. Ideally this should be the year the system was
* interconnected with the grid and began producing power. Renewables systems have a limited lifespan and
* year installed helps buyers and appraisers determine remaining useful life of the system.
*/
PowerProductionYearInstall?: number;
Listing?: Property;
HistoryTransactional?: HistoryTransactional[];
}