Skip to Content

The PimTrashedCollection type of the TypeScript SDK, which calendars.listTrash and addressbooks.listTrash take or answer.

type PimTrashedCollection = {
  color: string | null
  components: ('VEVENT' | 'VTODO')[] | null
  createdAt: number
  description: string | null
  displayName: string | null
  expiresAt: number
  id: string
  kind: ('calendar' | 'addressbook')
  name: string
  objectCount: number
  role: string | null
  trashedAt: number
}

Fields

FieldTypeDescription
colorstring | null
components('VEVENT' | 'VTODO')[] | nullSupported primary components, in VEVENT then VTODO order; null for addressbooks. Legacy mixed calendars may also retain journals or unparsed resources. Narrowing refuses with components_conflict and a count of incompatible live and restorable trashed objects.
createdAtnumberCreation timestamp in epoch seconds
descriptionstring | null
displayNamestring | null
expiresAtnumberWhen the purge duty removes it and its members for good, in epoch seconds
idstringCollection ULID: the same id it had, and will have again
kind('calendar' | 'addressbook')Collection type ('calendar' or 'addressbook')
namestringURL slug it had; a restore refuses (409 name_taken) while a live collection holds it
objectCountnumberMembers that went with it, and come back with it
rolestring | nullSpecial role ('tasks'), or null; the default collection cannot be deleted
trashedAtnumberWhen it was deleted, in epoch seconds

Used by

MethodWhat it does
calendars.listTrashList deleted calendars
addressbooks.listTrashList deleted addressbooks

On this page