Skip to main content

Module types

Module types 

Source
Expand description

JSON REST API types for contacts and address books.

The shape is structured-only: server owns vCard generation and field extraction; clients never see raw vCard text. Custom vCard properties sent by external CardDAV clients are preserved in the stored blob but invisible to JSON responses.

Structs§

AddressBookCreate
AddressBookOutput
AddressBookPatch
ContactInput
Body for POST /api/address-books/{abId}/contacts (create) and PUT /api/address-books/{abId}/contacts/{uid} (replace).
ContactListItem
Summary row for list endpoints (omits emails[]/phones[] detail to keep list responses small).
ContactName
vCard N (structured name) property.
ContactOutput
Full contact response including server-side metadata and optional live profile overlay.
ContactPatch
Body for PATCH /api/address-books/{abId}/contacts/{uid}. Each field uses Patch<T> so clients can distinguish “leave alone” from “clear”.
ImportContactsError
ImportContactsQuery
ImportContactsResult
ListContactsQuery
ProfileOverlay
Live profile data returned alongside a contact that has profileIdTag set. Fetched per-request from the tenant’s profiles table; never written into storage.
TypedValue
A value with TYPE and PREF parameters — covers EMAIL, TEL, URL, etc.

Enums§

ImportConflictMode
How to handle a vCard whose UID matches an existing contact in the address book.