@realestate/types/RESODataDictionaryV1_7/ContactListingNotes.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 { NotedBy } from './NotedBy';
import { Contacts } from './Contacts';
export interface ContactListingNotes {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactKey+%28ContactListingNotes%29+Field}
   *
   * Key of the corresponding Contact record. ContactKey and the ListingKey are used as a compound key for
   * this record.
   */
  ContactKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactKeyNumeric+%28ContactListingNotes%29+Field}
   *
   * Numeric only key of the corresponding Contact record. ContactKeyNumeric and the ListingKeyNumeric are
   * used as a compound key for this record.
   */
  ContactKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactListingNotesKey+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
   * from the system that the record was just retrieved. This may be identical to the related xxxId
   * identifier, but the key is guaranteed unique for this record set..
   */
  ContactListingNotesKey?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28ContactListingNotes%29+Field}
   *
   * ID for the corresponding listing record.
   */
  ListingId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKey+%28ContactListingNotes%29+Field}
   *
   * Key of the corresponding Listing record. ContactKey and the ListingKey are used as a compound key for
   * this record.
   */
  ListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKeyNumeric+%28ContactListingNotes%29+Field}
   *
   * Numeric only key of the corresponding Listing record. ContactKeyNumeric and the ListingKeyNumeric are
   * used as a compound key for this record.
   */
  ListingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28ContactListingNotes%29+Field}
   *
   * The Date/Time this note was written.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NoteContents+Field}
   *
   * The contents of the note.
   */
  NoteContents?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NotedBy+Field}
   *
   * The individual who wrote this note, the Agent or Contact.
   */
  NotedBy?: NotedBy;

  Contact?: Contacts;
}