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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherPhoneExt+Field}
   *
   * The extension of the given phone number (if applicable).
   */
  OtherPhoneExt?: string;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherPhoneNumber+Field}
   *
   * The "other" phone option allowing members to convey additional phone numbers other than those already
   * covered by the MemberMobilePhone, MemberFax, etc., fields.
   */
  OtherPhoneNumber?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherPhoneType+%28OtherPhone%29+Field}
   *
   * The type of "other" phone that does not already exist in the given phone fields or if a second of any
   * type of phone field is needed. i.e. HomePhone2, BrothersPhone, etc. This is used as the list of options
   * for the Other Phone repeating elements.
   */
  OtherPhoneType?: OtherPhoneType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceName+%28OtherPhone%29+Field}
   *
   * The resource or table of the listing or other record the media relates to. i.e. Property, Member,
   * Office, etc.
   */
  ResourceName?: ResourceName;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ResourceRecordID+%28OtherPhone%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+%28OtherPhone%29+Field}
   *
   * The primary key of the related record from the source resource. For example the ListingKey, AgentKey,
   * OfficeKey, TeamKey, 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+%28OtherPhone%29+Field}
   *
   * The primary key of the related record from the source resource. For example the ListingKey, AgentKey,
   * OfficeKey, TeamKey, 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;
}