@realestate/types/RESODataDictionaryV1_7/OpenHouse.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 { Attended } from './Attended';
import { OpenHouseStatus } from './OpenHouseStatus';
import { Property } from './Property';
import { OUID } from './OUID';
import { OpenHouseType } from './OpenHouseType';
import { Member } from './Member';
import { HistoryTransactional } from './HistoryTransactional';
import { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface OpenHouse {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AppointmentRequiredYN+Field}
   *
   * Indicates whether or not the OpenHouse requires an appointment.
   */
  AppointmentRequiredYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28OpenHouse%29+Field}
   *
   * The well known identifier for the listing related to this Open House. 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+%28OpenHouse%29+Field}
   *
   * A unique identifier for the listing record related to this Open House. This may be a number, or string
   * that can include URI or other forms. This is the system you are connecting to and not necessarily the
   * original source of the record. This may be a foreign key from the resource selected in the ResourceName
   * field.
   */
  ListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKeyNumeric+%28OpenHouse%29+Field}
   *
   * A unique identifier for the listing record related to this Open House. This may be a number, or string
   * that can include URI or other forms. This is the system you are connecting to and not necessarily the
   * original source of the record. This may be a foreign key from the resource selected in the ResourceName
   * field. This is the numeric only key and used as an alternative to the ListingKey field.
   */
  ListingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28OpenHouse%29+Field}
   *
   * The transactional timestamp automatically recorded by the MLS system representing the date/time the Open
   * House was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseAttendedBy+Field}
   *
   * Will the open house be attended by a licensed agent? Options are attended by agent, attended by the
   * seller or unattended.
   */
  OpenHouseAttendedBy?: Attended;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseDate+Field}
   *
   * The date on which the open house will occur.
   */
  OpenHouseDate?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseEndTime+Field}
   *
   * The time the open house ends.
   */
  OpenHouseEndTime?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseId+Field}
   *
   * The well-known identifier for the Open House resource. The value may be identical to that of the
   * OpenHouseKey, but the OpenHouseId intended to be the value used by a human to retrieve the information
   * about a specific open house. 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.
   */
  OpenHouseId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseKey+Field}
   *
   * A unique identifier for this record from the immediate source. This may be a number, or string that can
   * include URI or other forms. This is the system you are connecting to and not necessarily the original
   * source of the record.
   */
  OpenHouseKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseKeyNumeric+Field}
   *
   * A unique identifier for this record from the immediate source. This may be a number, or string that can
   * include URI or other forms. This is the system you are connecting to and not necessarily the original
   * source of the record. This is the numeric only key and used as an alternative to the OpenHouseKey field.
   */
  OpenHouseKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseRemarks+Field}
   *
   * Comments, instructions or information about the open house.
   */
  OpenHouseRemarks?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseStartTime+Field}
   *
   * The time the open house begins.
   */
  OpenHouseStartTime?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseStatus+Field}
   *
   * Status of the open house, i.e. Active, Cancelled, Ended.
   */
  OpenHouseStatus?: OpenHouseStatus;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OpenHouseType+Field}
   *
   * The type of open house. i.e. Public, Broker, Office, Association, Private (invitation or targeted
   * publication).
   */
  OpenHouseType?: OpenHouseType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28OpenHouse%29+Field}
   *
   * The transactional timestamp automatically recorded by the MLS system representing the date/time the Open
   * House was entered and made visible to members of the MLS.
   */
  OriginalEntryTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemID+%28OpenHouse%29+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Originating record provider. The Originating system is the
   * system with authoritative control over the record. For example; the name of the MLS where the Open House
   * was input. In cases where the Originating system was not where the record originated (the authoritative
   * system), see the Originating System fields.
   */
  OriginatingSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemKey+%28OpenHouse%29+Field}
   *
   * The system key, a unique record identifier, from the Originating system. The Originating system is the
   * system with authoritative control over the record. For example, the Multiple Listing Service where the
   * Open House was input. There may be cases where the Source System (how you received the record) is not
   * the Originating System. See Source System Key for more information.
   */
  OriginatingSystemKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemName+%28OpenHouse%29+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the Open
   * House is originally input. The legal name of the company.
   */
  OriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Refreshments+Field}
   *
   * A description of the refreshments that will be served at the open house.
   */
  Refreshments?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentFirstName+Field}
   *
   * The first name of the showing agent.
   */
  ShowingAgentFirstName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentKey+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the ListAgentKey is the system unique
   * identifier from the system that the record was retrieved. This may be identical to the related xxxId.
   * This is a foreign key relating to the Member resource's MemberKey.
   */
  ShowingAgentKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentKeyNumeric+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the ListAgentKey is the system unique
   * identifier from the system that the record was retrieved. This may be identical to the related xxxId.
   * This is a foreign key relating to the Member resource's MemberKey. This is the numeric only key and used
   * as an alternative to the ShowingAgentKey field.
   */
  ShowingAgentKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentLastName+Field}
   *
   * The last name of the showing agent.
   */
  ShowingAgentLastName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentMlsID+Field}
   *
   * The local, well-known identifier for the member. This value may not be unique, specifically in the case
   * of aggregation systems, this value should be the identifier from the original system.
   */
  ShowingAgentMlsID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemID+%28OpenHouse%29+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Source record provider. The source system is the system from
   * which the record was directly received. In cases where the source system was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  SourceSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemKey+%28OpenHouse%29+Field}
   *
   * The system key, a unique record identifier, from the Source System. The Source System is the system from
   * which the record was directly received. In cases where the Source System was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  SourceSystemKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemName+%28OpenHouse%29+Field}
   *
   * The name of the Open House record provider. The system from which the record was directly received. The
   * legal name of the company.
   */
  SourceSystemName?: string;

  Listing?: Property;
  OriginatingSystem?: OUID;
  ShowingAgent?: Member;
  SourceSystem?: OUID;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
  SocialMedia?: SocialMedia[];
}