Name API object

Hierarchy

Constructors

  • Builds a name object for a contact, required for contacts. The object requires a formatted_name and at least another property.

    Parameters

    • formatted_name: string

      Full name, as it normally appears

    • Optional first_name: string

      First name

    • Optional last_name: string

      Last name

    • Optional middle_name: string

      Middle name

    • Optional suffix: string

      Name suffix

    • Optional prefix: string

      Name prefix

    Returns Name

    Throws

    If no other component apart from formatted_name is defined

Properties

first_name?: string

The first name of the contact

formatted_name: string

The formatted name of the contact

last_name?: string

The last name of the contact

middle_name?: string

The middle name of the contact

prefix?: string

The prefix of the contact

suffix?: string

The suffix of the contact

Accessors

  • get _many(): false
  • Returns false

Methods

Generated using TypeDoc