@realestate/types/RESODataDictionaryV1_7/Queue.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 { QueueTransactionType } from './QueueTransactionType';
import { ResourceName } from './ResourceName';
import { OUID } from './OUID';
import { ClassName } from './ClassName';
export interface Queue {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ClassName+%28Queue%29+Field}
   *
   * Name of the class which this queue record is referencing.
   */
  ClassName?: ClassName;

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/QueueTransactionType+Field}
   *
   * The type of change that the queue transaction record is representing. For example, add, change, delete,
   * etc.
   */
  QueueTransactionType?: QueueTransactionType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceName+%28Queue%29+Field}
   *
   * The name of the resource which this queue record is referencing.
   */
  ResourceName?: ResourceName;

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

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

  OriginatingSystem?: OUID;
  SourceSystem?: OUID;
}