Function update

Returns <T extends Place.v1.Place | PlaceWithLineage>(
    updated: UpdatePlaceInput<T>,
) => Promise<T>

a function for updating a place

• • <T extends Place.v1.Place | PlaceWithLineage>(
        updated: UpdatePlaceInput<T>,
    ): Promise<T>

  • Updates an existing place to have the provided data.

    Type Parameters

    • T extends Place.v1.Place | PlaceWithLineage

    Parameters

    • updated: UpdatePlaceInput<T>

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

    Returns Promise<T>

    the updated place with the new _rev value

    Throws

    InvalidArgumentError if _id is not provided

    Throws

    ResourceNotFoundError if _id does not identify an existing place contact

    Throws

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

    Throws

    InvalidArgumentError if name is not provided

    Throws

    InvalidArgumentError if the provided contact is not the identifier of a valid person contact

    Throws

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