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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28SocialMedia%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/ResourceName+%28SocialMedia%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+%28SocialMedia%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+%28SocialMedia%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+%28SocialMedia%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;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SocialMediaType+%28SocialMedia%29+Field}
   *
   * A list of types of sites, blog, social media, the Member URL or ID is referring to. i.e. Website, Blog,
   * Facebook, Twitter, LinkedIn, Skype, etc., This list is used to populate the Type with repeating Social
   * Media URL or ID types.
   */
  SocialMediaType?: SocialMediaType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SocialMediaUrlOrId+Field}
   *
   * The website URL or ID of social media site or account of the member. This is a repeating element.
   * Replace [Type] with any of the options from the SocialMediaType field to create a unique field for that
   * type of social media. For example: SocialMediaFacebookUrlOrID, SocialMediaSkypeUrlOrID, etc.
   */
  SocialMediaUrlOrId?: string;
}