@realestate/types/RESODataDictionaryV1_7/HistoryTransactional.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 { OUID } from './OUID';
import { ChangeType } from './ChangeType';
import { Member } from './Member';
export interface HistoryTransactional {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangeType+Field}
   *
   * Description of the last major change on the listing, i.e. price reduction, back on market, etc. May be
   * used to display on a summary view of listing results to quickly identify listings that have had major
   * changes recently.
   */
  ChangeType?: ChangeType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberID+%28HistoryTransactional%29+Field}
   *
   * The local, well-know identifier of the member (user) who made the change.
   */
  ChangedByMemberID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberKey+%28HistoryTransactional%29+Field}
   *
   * The unique identifier of the member (user) who made the change. This is a foreign key relating to the
   * Member resource's MemberKey.
   */
  ChangedByMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberKeyNumeric+%28HistoryTransactional%29+Field}
   *
   * The unique identifier of the member (user) who made the change. 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
   * ChangedByMemberKey field.
   */
  ChangedByMemberKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ClassName+%28HistoryTransactional%29+Field}
   *
   * Name of the class which this history record applies.
   */
  ClassName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FieldKey+Field}
   *
   * The unique identifier of the field whose data is being changed. This is a foreign key relating to the
   * field found in the resource per the ResourceName.
   */
  FieldKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FieldKeyNumeric+Field}
   *
   * The unique identifier of the field whose data is being changed. This is a foreign key relating to the
   * field found in the resource per the ResourceName. This is the numeric only key and used as an
   * alternative to the FieldKey field.
   */
  FieldKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FieldName+Field}
   *
   * The name of the field whose data is being changed.
   */
  FieldName?: string;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28HistoryTransactional%29+Field}
   *
   * Timestamp of the last major change on the listing (see also MajorChangeType).
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NewValue+Field}
   *
   * The new value applied to the named field.
   */
  NewValue?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemID+%28HistoryTransactional%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 History
   * 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/OriginatingSystemName+%28HistoryTransactional%29+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * History is originally input. The legal name of the company.
   */
  OriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/PreviousValue+Field}
   *
   * The value found in the named field prior to the change represented by this record.
   */
  PreviousValue?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceName+%28HistoryTransactional%29+Field}
   *
   * The name of the resource which this history record applies.
   */
  ResourceName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceRecordID+%28HistoryTransactional%29+Field}
   *
   * The well known identifier of the related record from the source resource. 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.
   */
  ResourceRecordID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceRecordKey+%28HistoryTransactional%29+Field}
   *
   * The primary key of the related record from the source resource. For example the ListingKey, AgentKey,
   * OfficeKey, etc. This is the system you are connecting to and not necessarily the original source of the
   * record. This is a foreign key from the resource selected in the ResourceName field.
   */
  ResourceRecordKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceRecordKeyNumeric+%28HistoryTransactional%29+Field}
   *
   * The primary key of the related record from the source resource. For example the ListingKey, AgentKey,
   * OfficeKey, etc. This is the system you are connecting to and not necessarily the original source of the
   * record. This is a foreign key from the resource selected in the ResourceName field. This is the numeric
   * only key and used as an alternative to the ResourceRecordKey field.
   */
  ResourceRecordKeyNumeric?: number;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemID+%28HistoryTransactional%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/SourceSystemName+%28HistoryTransactional%29+Field}
   *
   * The name of the History record provider. The system from which the record was directly received. The
   * legal name of the company.
   */
  SourceSystemName?: string;

  ChangedByMember?: Member;
  OriginatingSystem?: OUID;
  SourceSystem?: OUID;
}