@realestate/types/RESODataDictionaryV1_7/OUID.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 { OrganizationType } from './OrganizationType';
import { AOR } from './AOR';
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 { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface OUID {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberID+%28OUID%29+Field}
   *
   * The local, well-know identifier of the member (user) who made the change.
   */
  ChangedByMemberID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberKey+%28OUID%29+Field}
   *
   * The unique identifier of the member (user) who made the change. This is a foreign key relating to the
   * Member resource's MemberKey.
   */
  ChangedByMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ChangedByMemberKeyNumeric+%28OUID%29+Field}
   *
   * The unique identifier of the member (user) who made the change. 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
   * ChangedByMemberKey field.
   */
  ChangedByMemberKeyNumeric?: number;

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationAorOuid+Field}
   *
   * The OUID for the Organization's Association of REALTORS if applicable.
   */
  OrganizationAorOuid?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationAorOuidKey+Field}
   *
   * The OrganizationUniqueIdKey of the AOR from the system serving the OUID resource.
   */
  OrganizationAorOuidKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationAorOuidKeyNumeric+Field}
   *
   * The OrganizationUniqueIdKey of the AOR from the system serving the OUID resource. This is the numeric
   * only key and used as an alternative to the OrganizationAorOuidKey field.
   */
  OrganizationAorOuidKeyNumeric?: number;

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationComments+Field}
   *
   * Comments or notes about the Organization.
   */
  OrganizationComments?: string;

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationContactJobTitle+Field}
   *
   * The title or position of the Organization Contact.
   */
  OrganizationContactJobTitle?: string;

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

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

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

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationMemberCount+Field}
   *
   * The total number of active members in the Organization if applicable.
   */
  OrganizationMemberCount?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationMlsCode+Field}
   *
   * If the organization is an MLS it is likely they already have an ID or code based on their name or an
   * abbreviation. This field supports the continued use/reference to that legacy code.
   */
  OrganizationMlsCode?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationMlsVendorName+Field}
   *
   * If the organization uses an MLS system, this is the textual name of the vendor.
   */
  OrganizationMlsVendorName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationMlsVendorOuid+Field}
   *
   * If the organization uses an MLS system, this is that vendor's OUID.
   */
  OrganizationMlsVendorOuid?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationName+Field}
   *
   * The textual name of the organization represented by a given OUID record.
   */
  OrganizationName?: string;

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

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

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

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

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

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

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationStatus+Field}
   *
   * Is the Organization active or inactive. 1 or true is active, 0 or false is inactive. This field is not
   * nullable.
   */
  OrganizationStatus?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationStatusChangeTimestamp+Field}
   *
   * The date/time of when the Organization Status was last changed.
   */
  OrganizationStatusChangeTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationType+Field}
   *
   * The type of organization. i.e. MLS, Vendor, Association, etc. This is not a substitute or alternative
   * for the Office resource, however it may be that a brokerage has a record in this table for a non-listing
   * purpose.
   */
  OrganizationType?: OrganizationType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationUniqueId+Field}
   *
   * The OUID. This is the unique ID assigned to organizations included in the OUID resource. Assignment of
   * OUIDs will be centralized and may not be created by systems hosting the OUID resource. Contact
   * info@RESO.org for information on obtaining an OUID.
   */
  OrganizationUniqueId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationUniqueIdKey+Field}
   *
   * The key field used by the system hosting a table of OUIDs. This key is likely to be unique to each
   * hosting system and is not meant to be a universal ID for an organization, but rather a key used by
   * clients of the hosting system. The actual OUID is the Organization Unique ID field.
   */
  OrganizationUniqueIdKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OrganizationUniqueIdKeyNumeric+Field}
   *
   * The key field used by the system hosting a table of OUIDs. This key is likely to be unique to each
   * hosting system and is not meant to be a universal ID for an organization, but rather a key used by
   * clients of the hosting system. The actual OUID is the Organization Unique ID field. This is the numeric
   * only key and used as an alternative to the OrganizationUniqueIdKey field.
   */
  OrganizationUniqueIdKeyNumeric?: number;

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

  ChangedByMember?: Member;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
  SocialMedia?: SocialMedia[];
}