@realestate/types/RESODataDictionaryV1_7/Teams.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 { OUID } from './OUID';
import { CountyOrParish } from './CountyOrParish';
import { Member } from './Member';
import { Country } from './Country';
import { SocialMediaType } from './SocialMediaType';
import { StateOrProvince } from './StateOrProvince';
import { HistoryTransactional } from './HistoryTransactional';
import { TeamStatus } from './TeamStatus';
import { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface Teams {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28Teams%29+Field}
   *
   * Date/time the roster (Team or office) record was last modified.
   */
  ModificationTimestamp?: Date;

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemName+%28Teams%29+Field}
   *
   * The name of the Team 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/TeamAddress1+Field}
   *
   * The street number, direction, name and suffix of the Team.
   */
  TeamAddress1?: string;

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamDescription+Field}
   *
   * A description or marketing information about the team.
   */
  TeamDescription?: string;

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamKey+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the TeamKey is the system unique
   * identifier from the system that the record was retrieved.
   */
  TeamKey?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamLeadKey+Field}
   *
   * The unique system identifier of the team's lead member.
   */
  TeamLeadKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamLeadKeyNumeric+Field}
   *
   * The unique system identifier of the team's lead member. This is the numeric only key and used as an
   * alternative to the TeamLeadKey field.
   */
  TeamLeadKeyNumeric?: number;

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

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamName+Field}
   *
   * The name under which the team operates. If a business this may be a DBA.
   */
  TeamName?: string;

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

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

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

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

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

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

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

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

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

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

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

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