@realestate/types/RESODataDictionaryV1_7/Prospecting.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 { ScheduleType } from './ScheduleType';
import { Media } from './Media';
import { DailySchedule } from './DailySchedule';
import { ReasonActiveOrDisabled } from './ReasonActiveOrDisabled';
import { Member } from './Member';
import { Contacts } from './Contacts';
import { HistoryTransactional } from './HistoryTransactional';
import { SavedSearch } from './SavedSearch';
export interface Prospecting {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ActiveYN+Field}
   *
   * If set to True, the given auto email is active. False records may be disabled or waiting activation.
   */
  ActiveYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/BccEmailList+Field}
   *
   * A comma separate list of email addresses that are the "BCC", or Blind Carbon Copy, address the auto
   * emails are being sent to.
   */
  BccEmailList?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/BccMeYN+Field}
   *
   * When set to True, the auto mail is also sent as a Blind Carbon Copy to the Member who created the Auto
   * Email.
   */
  BccMeYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/CcEmailList+Field}
   *
   * A comma separate list of email addresses that are the "CC", or Carbon Copy, address the auto emails are
   * being sent to.
   */
  CcEmailList?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ClientActivatedYN+Field}
   *
   * If set to True, the client has clicked through to accept automatic of emails. Recipant acceptance is an
   * important part of CAN-SPAM and other bulk automatic emailing regulations.
   */
  ClientActivatedYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ConciergeNotificationsYN+Field}
   *
   * If set to True, notifications are to be sent to the member when the auto email is in Concierge mode.
   */
  ConciergeNotificationsYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ConciergeYN+Field}
   *
   * When set to True, the auto mail is in Concierge mode and to be approved by the member before sent to the
   * client.
   */
  ConciergeYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactKey+%28Prospecting%29+Field}
   *
   * This is the foreign key relating to the Contact resource. A unique identifier for this record from the
   * immediate source. This is a string that can include URI or other forms. Alternatively use the
   * ContactKeyNumeric 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 SourceSystemKey and OriginatingSystemKey variants.
   */
  ContactKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ContactKeyNumeric+%28Prospecting%29+Field}
   *
   * This is the foreign key relating to the Contact resource. A unique identifier for this record from the
   * immediate source. This is the numeric only key and used as an alternative to the ContactKey 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
   * SourceSystemKeyNumeric and OriginatingSystemKeyNumeric variants.
   */
  ContactKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/DailySchedule+Field}
   *
   * When Daily is selected as the ScheduleType, a list of days of the week and AM or PM options.
   */
  DailySchedule?: DailySchedule[];

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/DisplayTemplateID+Field}
   *
   * The system ID of the display that has been related, or set as the default, to this saved search.
   */
  DisplayTemplateID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Language+%28Prospecting%29+Field}
   *
   * The language that will be used in the given auto email.
   */
  Language?: Languages;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/LastNewChangedTimestamp+Field}
   *
   * Timestamp of when the prospector last found new or modified listings for this auto-email.
   */
  LastNewChangedTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/LastViewedTimestamp+Field}
   *
   * A timestamp of when the auto email was last viewed by the client in the portal.
   */
  LastViewedTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MessageNew+Field}
   *
   * The body of the auto email message when the first email is sent for the prospecting campaign.
   */
  MessageNew?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MessageRevise+Field}
   *
   * The body of the auto email message to be used when the criteria or settings of this auto email have been
   * modified.
   */
  MessageRevise?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MessageUpdate+Field}
   *
   * The body of the auto email message for subsequent email messages after the first email is sent. If a
   * first email option isn't used, this field is used for all emails including the first.
   */
  MessageUpdate?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28Prospecting%29+Field}
   *
   * The date/time this prospecting record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/NextSendTimestamp+Field}
   *
   * A timestamp of when the auto email is schedule to next send.
   */
  NextSendTimestamp?: Date;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OwnerMemberKey+%28Prospecting%29+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+%28Prospecting%29+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/ProspectingKey+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 ProspectKeyNumeric 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 SourceSystemKey and
   * OriginatingSystemKey variants.
   */
  ProspectingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ProspectingKeyNumeric+Field}
   *
   * A unique identifier for this record from the immediate source. This is the numeric only key and used as
   * an alternative to the ProspectKey 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 SourceSystemKeyNumeric and OriginatingSystemKeyNumeric variants.
   */
  ProspectingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ReasonActiveOrDisabled+Field}
   *
   * A list of reasons the Auto Email was set to inactive or set back to active. e.g. AgentDisabled,
   * OverLimit, No Listings Found, Re-Activated, Client Disabled, etc.
   */
  ReasonActiveOrDisabled?: ReasonActiveOrDisabled;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SavedSearchKey+%28Prospecting%29+Field}
   *
   * This is the foreign key relating to the SavedSearch resource. A unique identifier for this record from
   * the immediate source. This is a string that can include URI or other forms. Alternatively use the
   * SavedSearchKeyNumeric 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 SourceSystemKey and OriginatingSystemKey variants.
   */
  SavedSearchKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SavedSearchKeyNumeric+%28Prospecting%29+Field}
   *
   * This is the foreign key relating to the SavedSearch resource. A unique identifier for this record from
   * the immediate source. This is the numeric only key and used as an alternative to the SavedSearchKey
   * 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
   * SourceSystemKeyNumeric and OriginatingSystemKeyNumeric variants.
   */
  SavedSearchKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ScheduleType+Field}
   *
   * A selection of the type of schedule that the auto email will be sent. Daily, Monthly or ASAP.
   */
  ScheduleType?: ScheduleType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Subject+Field}
   *
   * The subject line of the auto email being sent.
   */
  Subject?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ToEmailList+Field}
   *
   * A comma separate list of email addresses that are the "To" address the auto emails are being sent to.
   */
  ToEmailList?: string;

  Contact?: Contacts;
  OwnerMember?: Member;
  SavedSearch?: SavedSearch;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
}