@realestate/types/RESODataDictionaryV1_7/PropertyRooms.d.ts

Types for real estate

/**
 * 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 { AreaUnits } from './AreaUnits';
import { Property } from './Property';
import { RoomType } from './RoomType';
import { AreaSource } from './AreaSource';
import { HistoryTransactional } from './HistoryTransactional';
import { LinearUnits } from './LinearUnits';
import { InteriorOrRoomFeatures } from './InteriorOrRoomFeatures';
export interface PropertyRooms {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28PropertyRooms%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+%28PropertyRooms%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+%28PropertyRooms%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+%28PropertyRooms%29+Field}
   *
   * Date/time this record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomArea+Field}
   *
   * The area of the room being described. Use the RoomAreaUnits field to describe the unit of measurement
   * for the value in this field.
   */
  RoomArea?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomAreaSource+Field}
   *
   * The source of the measurement of the given room's area.
   */
  RoomAreaSource?: AreaSource;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomAreaUnits+Field}
   *
   * The unit of measurement used for the value in the RoomArea field. e.g. square feet, square meters, etc.
   */
  RoomAreaUnits?: AreaUnits;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomDescription+Field}
   *
   * A textual description of the given room.
   */
  RoomDescription?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomDimensions+Field}
   *
   * A textual description of the dimensions of the given room.
   */
  RoomDimensions?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomFeatures+Field}
   *
   * A list of features present in the given room.
   */
  RoomFeatures?: InteriorOrRoomFeatures[];

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomKey+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.
   */
  RoomKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomKeyNumeric+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.
   */
  RoomKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomLength+Field}
   *
   * A numeric representation of the length of the given room. See the RoomLengthWidthUnits for the unit of
   * measurement used for the length and width.
   */
  RoomLength?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomLengthWidthUnits+Field}
   *
   * The unit of measurement used for the value in the RoomLength and the RoomWidth fields. e.g. feet,
   * meters, etc.
   */
  RoomLengthWidthUnits?: LinearUnits;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomType+%28PropertyRooms%29+Field}
   *
   * The type of room being described by the other fields in the PropertyRooms resource.
   */
  RoomType?: RoomType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RoomWidth+Field}
   *
   * A numeric representation of the width of the given room. See the RoomLengthWidthUnits for the unit of
   * measurement used for the length and width.
   */
  RoomWidth?: number;

  Listing?: Property;
  HistoryTransactional?: HistoryTransactional[];
}