@realestate/types/RESODataDictionaryV1_7/Contacts.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 { Languages } from './Languages';
import { PreferredAddress } from './PreferredAddress';
import { OUID } from './OUID';
import { CountyOrParish } from './CountyOrParish';
import { Member } from './Member';
import { OtherPhoneType } from './OtherPhoneType';
import { Country } from './Country';
import { PreferredPhone } from './PreferredPhone';
import { ContactType } from './ContactType';
import { SocialMediaType } from './SocialMediaType';
import { StateOrProvince } from './StateOrProvince';
import { HistoryTransactional } from './HistoryTransactional';
import { ContactStatus } from './ContactStatus';
import { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface Contacts {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Anniversary+Field}
   *
   * The wedding anniversary of the contact; month, day and year.
   */
  Anniversary?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AssistantEmail+Field}
   *
   * Email address of the contact's assistant.
   */
  AssistantEmail?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AssistantName+Field}
   *
   * Name of the contact's assistant.
   */
  AssistantName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AssistantPhone+Field}
   *
   * Phone number of the contact's assistant.
   */
  AssistantPhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AssistantPhoneExt+Field}
   *
   * Phone number extension of the contact's assistant.
   */
  AssistantPhoneExt?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Birthdate+Field}
   *
   * The birthday of the contact; month, day and year.
   */
  Birthdate?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/BusinessFax+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  BusinessFax?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Children+Field}
   *
   * A list of the names of the contact's children in a comma separated list.
   */
  Children?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Company+Field}
   *
   * The contact's company or employer.
   */
  Company?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactKeyNumeric+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the ContactKey is the system unique
   * identifier from the system that the record was retrieved. This may be identical to the related xxxId.
   * This is the numeric only key and used as an alternative to the ContactKey field.
   */
  ContactKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactLoginId+Field}
   *
   * The local, well-known identifier for the contact. This value may not be unique, specifically in the case
   * of aggregation systems, this value should be the identifier from the original system and is used by the
   * Contact to logon to a client portal in that system.
   */
  ContactLoginId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactPassword+Field}
   *
   * A client password that the member wishes to share with other systems. Normal security considerations
   * apply and are the responsibility of the entity utilizing this field.
   */
  ContactPassword?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactStatus+Field}
   *
   * The status of the contact. Active, Inactive, On Vacation, Deleted, etc.,
   */
  ContactStatus?: ContactStatus;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactType+Field}
   *
   * The type of contact. i.e. Business, Friend, Family, Prospect, Ready to Buy, etc.
   */
  ContactType?: ContactType[];

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Department+Field}
   *
   * The department in which the contact works.
   */
  Department?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/DirectPhone+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  DirectPhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Email+Field}
   *
   * The preferred Email address of the contact.
   */
  Email?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Email2+Field}
   *
   * The secondary email address of the contact.
   */
  Email2?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Email3+Field}
   *
   * The tertiary email address of the contact.
   */
  Email3?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FirstName+Field}
   *
   * The first name of the Contact.
   */
  FirstName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FullName+Field}
   *
   * The full name of the Contact. (First Middle Last) or a alternate full name.
   */
  FullName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeAddress1+Field}
   *
   * The street number, direction, name and suffix of the contact's home.
   */
  HomeAddress1?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeAddress2+Field}
   *
   * The unit/suite number of the contact's home.
   */
  HomeAddress2?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeCarrierRoute+Field}
   *
   * The group of addresses to which the USPS assigns the same code to aid in mail delivery. For the USPS,
   * these codes are 9 digits: 5 numbers for the ZIP Code, one letter for the carrier route type, and 3
   * numbers for the carrier route number.
   */
  HomeCarrierRoute?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeCity+Field}
   *
   * The city of the contact's home.
   */
  HomeCity?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeCountry+Field}
   *
   * The country abbreviation in a postal address.
   */
  HomeCountry?: Country;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeCountyOrParish+Field}
   *
   * The county or parish in which the contact's home is addressed.
   */
  HomeCountyOrParish?: CountyOrParish;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeFax+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  HomeFax?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomePhone+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  HomePhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomePostalCode+Field}
   *
   * The postal code of the contact's home.
   */
  HomePostalCode?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomePostalCodePlus4+Field}
   *
   * The extension of the postal/zip code. i.e. +4
   */
  HomePostalCodePlus4?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/HomeStateOrProvince+Field}
   *
   * The state or province in which the contact's home is addressed.
   */
  HomeStateOrProvince?: StateOrProvince;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/JobTitle+%28Contacts%29+Field}
   *
   * The title or position of the contact within their organization.
   */
  JobTitle?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Language+Field}
   *
   * The languages spoken by the contact.
   */
  Language?: Languages[];

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/LastName+Field}
   *
   * The last name of the Contact.
   */
  LastName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/LeadSource+Field}
   *
   * The source or person that provided the contact.
   */
  LeadSource?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MiddleName+Field}
   *
   * The middle name of the Contact.
   */
  MiddleName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MobilePhone+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  MobilePhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28Contacts%29+Field}
   *
   * Date/time the contact record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NamePrefix+Field}
   *
   * Prefix to the name (e.g. Dr. Mr. Ms. etc.)
   */
  NamePrefix?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NameSuffix+Field}
   *
   * Suffix to the surname (e.g. Esq., Jr., III etc.)
   */
  NameSuffix?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Nickname+Field}
   *
   * An alternate name used by the Contact, usually as a substitute for the first name.
   */
  Nickname?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Notes+Field}
   *
   * Notes about the client.
   */
  Notes?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficePhone+%28Contacts%29+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  OfficePhone?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28Contacts%29+Field}
   *
   * Date/time the contact record was originally input into the source system.
   */
  OriginalEntryTimestamp?: Date;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherAddress1+Field}
   *
   * The other street number, direction, name and suffix of the contact.
   */
  OtherAddress1?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherAddress2+Field}
   *
   * The other unit/suite number of the contact.
   */
  OtherAddress2?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherCarrierRoute+Field}
   *
   * The group of addresses to which the USPS assigns the same code to aid in mail delivery. For the USPS,
   * these codes are 9 digits: 5 numbers for the ZIP Code, one letter for the carrier route type, and 3
   * numbers for the carrier route number.
   */
  OtherCarrierRoute?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherCity+Field}
   *
   * The other city of the contact.
   */
  OtherCity?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherCountry+Field}
   *
   * The other country abbreviation in a postal address.
   */
  OtherCountry?: Country;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherCountyOrParish+Field}
   *
   * The other county or parish in which contact is addressed.
   */
  OtherCountyOrParish?: CountyOrParish;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherPhoneType+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/OtherPostalCode+Field}
   *
   * The other postal code of the contact.
   */
  OtherPostalCode?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherPostalCodePlus4+Field}
   *
   * The other extension of the postal/zip code. i.e. +4
   */
  OtherPostalCodePlus4?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OtherStateOrProvince+Field}
   *
   * The other state or province in which the contact is addressed.
   */
  OtherStateOrProvince?: StateOrProvince;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OwnerMemberID+Field}
   *
   * The local, well-known identifier for the member owning the contact.
   */
  OwnerMemberID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OwnerMemberKey+Field}
   *
   * The unique identifier (key) of the member owning the contact. This is a foreign key relating to the
   * Member resource's MemberKey.
   */
  OwnerMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OwnerMemberKeyNumeric+Field}
   *
   * The unique identifier (key) of the member owning the contact. 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
   * OwnerMemberKey field.
   */
  OwnerMemberKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Pager+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  Pager?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/PhoneTTYTDD+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  PhoneTTYTDD?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/PreferredAddress+Field}
   *
   * A list of the address options Home, Work and Other used to determine the address preferred by the client.
   */
  PreferredAddress?: PreferredAddress;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/PreferredPhone+Field}
   *
   * A list of the phone options Office, Mobile, Direct, Voicemail, Other used to determine the phone
   * preferred by the client.
   */
  PreferredPhone?: PreferredPhone;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ReferredBy+Field}
   *
   * Name of the person who referred the contact.
   */
  ReferredBy?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SocialMediaType+%28Contacts%29+Field}
   *
   * A list of types of sites, blog, social media, the Contact 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/SourceSystemContactKey+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.
   */
  SourceSystemContactKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemID+%28Contacts%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+%28Contacts%29+Field}
   *
   * The name of the immediate 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/SpousePartnerName+Field}
   *
   * The contact's spouse or partner.
   */
  SpousePartnerName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TollFreePhone+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  TollFreePhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/VoiceMail+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  VoiceMail?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkAddress1+Field}
   *
   * The street number, direction, name and suffix of the contact's work.
   */
  WorkAddress1?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkAddress2+Field}
   *
   * The unit/suite number of the contact's work.
   */
  WorkAddress2?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkCarrierRoute+Field}
   *
   * The group of addresses to which the USPS assigns the same code to aid in mail delivery. For the USPS,
   * these codes are 9 digits: 5 numbers for the ZIP Code, one letter for the carrier route type, and 3
   * numbers for the carrier route number.
   */
  WorkCarrierRoute?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkCity+Field}
   *
   * The city of the contact's work.
   */
  WorkCity?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkCountry+Field}
   *
   * The country abbreviation in a postal address.
   */
  WorkCountry?: Country;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkCountyOrParish+Field}
   *
   * The county or parish in which the contact's work is addressed.
   */
  WorkCountyOrParish?: CountyOrParish;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkPostalCode+Field}
   *
   * The postal code of the contact's work.
   */
  WorkPostalCode?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkPostalCodePlus4+Field}
   *
   * The extension of the postal/zip code. i.e. +4
   */
  WorkPostalCodePlus4?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/WorkStateOrProvince+Field}
   *
   * The state or province in which the contact's work is addressed.
   */
  WorkStateOrProvince?: StateOrProvince;

  OriginatingSystem?: OUID;
  SourceSystem?: OUID;
  OwnerMember?: Member;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
  SocialMedia?: SocialMedia[];
}