Function update

Returns <T extends UpdatePersonInput>(updated: T) => Promise<T>

a function for updating a person

• • <T extends UpdatePersonInput>(updated: T): Promise<T>

  • Updates an existing person to have the provided data.

    Type Parameters

    • T extends UpdatePersonInput

    Parameters

    • updated: T

      the updated person data. The complete data for the person must be provided. Existing fields not included in the updated data will be removed from the person. If the provided parent lineage is hydrated (e.g. for a PersonWithLineage), the lineage will be properly dehydrated before being stored.

    Returns Promise<T>

    the updated person with the new _rev value

    Throws

    InvalidArgumentError if _id is not provided

    Throws

    ResourceNotFoundError if _id does not identify an existing person contact

    Throws

    InvalidArgumentError if _rev is not provided or does not match the person's current _rev value

    Throws

    InvalidArgumentError if name is not provided

    Throws

    InvalidArgumentError if any of the following read-only properties are changed: reported_date, parent, type, contact_type