@realestate/types/RESODataDictionaryV1_7/Member.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 { AOR } from './AOR';
import { CountyOrParish } from './CountyOrParish';
import { SyndicateTo } from './SyndicateTo';
import { OUID } from './OUID';
import { MemberMlsSecurityClass } from './MemberMlsSecurityClass';
import { Country } from './Country';
import { MemberStatus } from './MemberStatus';
import { MemberOtherPhoneType } from './MemberOtherPhoneType';
import { MemberType } from './MemberType';
import { SocialMediaType } from './SocialMediaType';
import { StateOrProvince } from './StateOrProvince';
import { Office } from './Office';
import { MemberDesignation } from './MemberDesignation';
import { HistoryTransactional } from './HistoryTransactional';
import { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface Member {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/JobTitle+Field}
   *
   * The title or position of the member within their organization.
   */
  JobTitle?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/LastLoginTimestamp+Field}
   *
   * Date/time the member last logged into the source or other system.
   */
  LastLoginTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberAOR+Field}
   *
   * The Member's Primary Board or Association of REALTORS.
   */
  MemberAOR?: AOR;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberAORkeyNumeric+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the MemberAORkey 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 MemberAORkey field.
   */
  MemberAORkeyNumeric?: number;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberAssociationComments+Field}
   *
   * The association's notes regarding the member.
   */
  MemberAssociationComments?: string;

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberDesignation+Field}
   *
   * Designations and certifications acknowledging experience and expertise in various real estate sectors are
   * awarded by NAR and each affiliated group upon completion of required courses.
   */
  MemberDesignation?: MemberDesignation[];

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

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberIsAssistantTo+Field}
   *
   * The MemberMlsId of the Agent/Broker that this member is an assistant. The typical use will be to add the
   * agent's ID to this field when editing the member record of the assistant.
   */
  MemberIsAssistantTo?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberKey+Field}
   *
   * A unique identifier for this record from the immediate source. This is a string that can include URI or
   * other forms. Alternatively use the MemberKeyNumeric for a numeric only key field. This is the local key
   * of the system. When records are received from other systems, a local key is commonly applied. If
   * conveying the original keys from the source or originating systems, see SourceSystemMemberKey and
   * OriginatingSystemMemberKey.
   */
  MemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberKeyNumeric+Field}
   *
   * A unique identifier for this record from the immediate source. This is the numeric only key and used as
   * an alternative to the MemberKey fields. This is the local key of the system. When records are received
   * from other systems, a local key is commonly applied. If conveying the original keys from the source or
   * originating systems, see SourceSystemMemberKey and OriginatingSystemMemberKey.
   */
  MemberKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberLanguages+Field}
   *
   * The languages the member speaks.
   */
  MemberLanguages?: Languages[];

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberLoginId+Field}
   *
   * The ID used to logon to the MLS system.
   */
  MemberLoginId?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberMlsAccessYN+Field}
   *
   * Does the member have access to the MLS system.
   */
  MemberMlsAccessYN?: boolean;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberMlsSecurityClass+Field}
   *
   * The MLS security group or class given to the member.
   */
  MemberMlsSecurityClass?: MemberMlsSecurityClass;

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberNationalAssociationId+Field}
   *
   * The national association ID of the member. i.e. in the U.S. is the NRDS number.
   */
  MemberNationalAssociationId?: string;

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberOtherPhoneType+Field}
   *
   * The type of "other" phone. i.e. Preferred, Office, Mobile, Direct, Home, Fax, Pager, Voicemail, Toll
   * Free, SMS, 1, 2, 3, First, Second, Third, etc.. This is used as the list of options for the Member Other
   * Phone repeating elements.
   */
  MemberOtherPhoneType?: MemberOtherPhoneType;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberPhoneTTYTDD+Field}
   *
   * (Telecommunications Device for the Deaf/TeleTYpewriter) A user terminal with keyboard input and printer
   * or display output used by the hearing and speech impaired. The device contains a modem and is used over a
   * standard analog phone line. If a recipient does not have a corresponding terminal device, TDD/TTY users
   * dial a relay service composed of operators who receive the typed messages, call the recipients and speak
   * the messages to them. The operators also type the responses back to the TDD/TTY user.
   */
  MemberPhoneTTYTDD?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberPostalCode+Field}
   *
   * The postal code of the member.
   */
  MemberPostalCode?: string;

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberStateLicense+Field}
   *
   * The license of the Member. Separate multiple licenses with a comma and space.
   */
  MemberStateLicense?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberStateLicenseState+Field}
   *
   * The state in which the member is licensed.
   */
  MemberStateLicenseState?: StateOrProvince;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberStatus+Field}
   *
   * Is the account active, inactive or under disciplinary action.
   */
  MemberStatus?: MemberStatus;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberType+Field}
   *
   * The type of member. i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO,
   * Realtor, Association Staff, MLS Staff, etc.
   */
  MemberType?: MemberType;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28Member%29+Field}
   *
   * Date/time the roster (member or office) record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeKey+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. This is a foreign key relating to the
   * Office resource's OfficeKey.
   */
  OfficeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeKeyNumeric+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. This is a foreign key relating to the
   * Office resource's OfficeKey. This is the numeric only key and used as an alternative to the MemberAORkey
   * field.
   */
  OfficeKeyNumeric?: number;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeName+Field}
   *
   * The legal name of the brokerage.
   */
  OfficeName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28Member%29+Field}
   *
   * Date/time the roster (member or office) record was originally input into the source system.
   */
  OriginalEntryTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemID+%28Member%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 member 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/OriginatingSystemMemberKey+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
   * member 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.
   */
  OriginatingSystemMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemName+%28Member%29+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * member is originally input by the member. The legal name of the company.
   */
  OriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SocialMediaType+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/SourceSystemID+%28Member%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/SourceSystemMemberKey+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.
   */
  SourceSystemMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemName+%28Member%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/SyndicateTo+%28Member%29+Field}
   *
   * When permitted by the broker, the options made by the individual agent on where they would like their
   * listings syndicated. i.e. Zillow, Trulia, Homes.com, etc.
   */
  SyndicateTo?: SyndicateTo[];

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