Calendar

Summary

A calendar is a collection of related events, encompassing additional metadata such as summary, default time zone, location, and more. Each calendar is uniquely identified by an ID, which is an email address. Calendars can have multiple owners, enhancing collaborative management and flexibility. An event, as a part of the calendar, is an object associated with a specific date or time range. Identified by a unique ID, events incorporate various details including start and end date-times, summary, description, location, status, reminders, attachments, and more. This structure facilitates efficient organization and management of events, streamlining tracking and coordination within the system.

A calendar can be provided by third parties, like Google, Microsoft or TimeTime itself.

Schema

Name	Data Type	Description
id	string	The unique identifier for the calendar, formatted as UUID.
name	string	The name of the calendar.
description	string	A brief description of the calendar.
defaultTimeZone	string	The default time zone for the calendar.
tags	object	Arbitrary key/value collection for storing metadata.
owner	Object<Owner>	The owner of the calendar, which can be either a user or an organization.

Certainly! Below is the updated documentation and tables for the CalendarOwner schema, explaining how the type property acts as a discriminator to determine whether the owner is a user or an organization.

Owner

The CalendarOwner schema in the API is designed to identify the owner of a calendar. It can be one of two types:

• CalendarOwnerUser
• CalendarOwnerOrg

The type property is used as a discriminator to distinguish between these two types.

CalendarOwnerUser

Name	Type	Description
id	String	The unique identifier of the user, formatted as UUID.
type	CalendarOwnerUser	Discriminator for identifying the owner type.

CalendarOwnerOrg

Name	Type	Description
id	String	The unique identifier of the organization, formatted as UUID.
type	CalendarOwnerOrg	Discriminator for identifying the owner type.

These tables and the accompanying explanation provide a clear understanding of how the CalendarOwner schema works, specifically how the type property is utilized to differentiate between a user and an organization as the owner of a calendar.

Examples

{
  "owner": {
    "type": "CalendarOwnerOrg",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "TimeTime holidays",
  "description": "",
  "defaultTimeZone": "Europe/Madrid",
  "tags": {
    "color": "red",
  }
}