{"note":"OpenAPI conversion -- returning structured metadata","name":"google-calendar","description":"Calendar API","version":"v3","base_url":"https://www.googleapis.com/calendar/v3","endpoints":37,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Calendar API\n@base https://www.googleapis.com/calendar/v3\n@version v3\n@auth OAuth2 | OAuth2\n@endpoints 37\n@hint download_for_search\n@toc calendars(24), channels(1), colors(1), freeBusy(1), users(10)\n\n@group calendars\n@endpoint POST /calendars\n@desc Creates a secondary calendar.\n@optional {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str # Description of the calendar. Optional., etag: str # ETag of the resource., id: str # Identifier of the calendar. To retrieve IDs call the calendarList.list() method., kind: str=calendar#calendar # Type of the resource (\"calendar#calendar\")., location: str # Geographic location of the calendar as free-form text. Optional., summary: str # Title of the calendar., timeZone: str # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.}\n@returns(200) {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str, etag: str, id: str, kind: str, location: str, summary: str, timeZone: str} # Successful response\n\n@endpoint DELETE /calendars/{calendarId}\n@desc Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@returns(200) Successful response\n\n@endpoint GET /calendars/{calendarId}\n@desc Returns metadata for a calendar.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@returns(200) {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str, etag: str, id: str, kind: str, location: str, summary: str, timeZone: str} # Successful response\n\n@endpoint PATCH /calendars/{calendarId}\n@desc Updates metadata for a calendar. This method supports patch semantics.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str # Description of the calendar. Optional., etag: str # ETag of the resource., id: str # Identifier of the calendar. To retrieve IDs call the calendarList.list() method., kind: str=calendar#calendar # Type of the resource (\"calendar#calendar\")., location: str # Geographic location of the calendar as free-form text. Optional., summary: str # Title of the calendar., timeZone: str # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.}\n@returns(200) {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str, etag: str, id: str, kind: str, location: str, summary: str, timeZone: str} # Successful response\n\n@endpoint PUT /calendars/{calendarId}\n@desc Updates metadata for a calendar.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str # Description of the calendar. Optional., etag: str # ETag of the resource., id: str # Identifier of the calendar. To retrieve IDs call the calendarList.list() method., kind: str=calendar#calendar # Type of the resource (\"calendar#calendar\")., location: str # Geographic location of the calendar as free-form text. Optional., summary: str # Title of the calendar., timeZone: str # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.}\n@returns(200) {conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, description: str, etag: str, id: str, kind: str, location: str, summary: str, timeZone: str} # Successful response\n\n@endpoint GET /calendars/{calendarId}/acl\n@desc Returns the rules in the access control list for the calendar.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., pageToken: str # Token specifying which result page to return. Optional., showDeleted: bool # Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.}\n@returns(200) {etag: str, items: [map], kind: str, nextPageToken: str, nextSyncToken: str} # Successful response\n\n@endpoint POST /calendars/{calendarId}/acl\n@desc Creates an access control rule.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {sendNotifications: bool # Whether to send notifications about the calendar sharing change. Optional. The default is True., etag: str # ETag of the resource., id: str # Identifier of the Access Control List (ACL) rule. See Sharing calendars., kind: str=calendar#aclRule # Type of the resource (\"calendar#aclRule\")., role: str # The role assigned to the scope. Possible values are:   - \"none\" - Provides no access.  - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., scope: map{type: str, value: str} # The extent to which calendar access is granted by this ACL rule.}\n@returns(200) {etag: str, id: str, kind: str, role: str, scope: map{type: str, value: str}} # Successful response\n\n@endpoint POST /calendars/{calendarId}/acl/watch\n@desc Watch for changes to ACL resources.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., pageToken: str # Token specifying which result page to return. Optional., showDeleted: bool # Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries., address: str # The address where notifications are delivered for this channel., expiration: str(int64) # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional., id: str # A UUID or similar unique string that identifies this channel., kind: str=api#channel # Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\"., params: map # Additional parameters controlling delivery channel behavior. Optional., payload: bool # A Boolean value to indicate whether payload is wanted. Optional., resourceId: str # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions., resourceUri: str # A version-specific identifier for the watched resource., token: str # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional., type: str # The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.}\n@returns(200) {address: str, expiration: str(int64), id: str, kind: str, params: map, payload: bool, resourceId: str, resourceUri: str, token: str, type: str} # Successful response\n\n@endpoint DELETE /calendars/{calendarId}/acl/{ruleId}\n@desc Deletes an access control rule.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., ruleId: str # ACL rule identifier.}\n@returns(200) Successful response\n\n@endpoint GET /calendars/{calendarId}/acl/{ruleId}\n@desc Returns an access control rule.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., ruleId: str # ACL rule identifier.}\n@returns(200) {etag: str, id: str, kind: str, role: str, scope: map{type: str, value: str}} # Successful response\n\n@endpoint PATCH /calendars/{calendarId}/acl/{ruleId}\n@desc Updates an access control rule. This method supports patch semantics.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., ruleId: str # ACL rule identifier.}\n@optional {sendNotifications: bool # Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True., etag: str # ETag of the resource., id: str # Identifier of the Access Control List (ACL) rule. See Sharing calendars., kind: str=calendar#aclRule # Type of the resource (\"calendar#aclRule\")., role: str # The role assigned to the scope. Possible values are:   - \"none\" - Provides no access.  - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., scope: map{type: str, value: str} # The extent to which calendar access is granted by this ACL rule.}\n@returns(200) {etag: str, id: str, kind: str, role: str, scope: map{type: str, value: str}} # Successful response\n\n@endpoint PUT /calendars/{calendarId}/acl/{ruleId}\n@desc Updates an access control rule.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., ruleId: str # ACL rule identifier.}\n@optional {sendNotifications: bool # Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True., etag: str # ETag of the resource., id: str # Identifier of the Access Control List (ACL) rule. See Sharing calendars., kind: str=calendar#aclRule # Type of the resource (\"calendar#aclRule\")., role: str # The role assigned to the scope. Possible values are:   - \"none\" - Provides no access.  - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., scope: map{type: str, value: str} # The extent to which calendar access is granted by this ACL rule.}\n@returns(200) {etag: str, id: str, kind: str, role: str, scope: map{type: str, value: str}} # Successful response\n\n@endpoint POST /calendars/{calendarId}/clear\n@desc Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@returns(200) Successful response\n\n@endpoint GET /calendars/{calendarId}/events\n@desc Returns events on the specified calendar.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., eventTypes: [str] # Event types to return. Optional. Possible values are:  - \"default\"  - \"focusTime\"  - \"outOfOffice\"This parameter can be repeated multiple times to return events of different types. Currently, this is the only allowed value for this field:  - [\"default\", \"focusTime\", \"outOfOffice\"] This value will be the default.  If you're enrolled in the Working Location developer preview program, in addition to the default value above you can also set the \"workingLocation\" event type:  - [\"default\", \"focusTime\", \"outOfOffice\", \"workingLocation\"]  - [\"workingLocation\"] Additional combinations of these 4 event types will be made available in later releases. Developer Preview., iCalUID: str # Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., maxResults: int # Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional., orderBy: str(startTime/updated) # The order of the events returned in the result. Optional. The default is an unspecified, stable order., pageToken: str # Token specifying which result page to return. Optional., privateExtendedProperty: [str] # Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints., q: str # Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email. Optional., sharedExtendedProperty: [str] # Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints., showDeleted: bool # Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False., showHiddenInvitations: bool # Whether to include hidden invitations in the result. Optional. The default is False., singleEvents: bool # Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.  These are:  - iCalUID  - orderBy  - privateExtendedProperty  - q  - sharedExtendedProperty  - timeMin  - timeMax  - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries., timeMax: str # Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin., timeMin: str # Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax., timeZone: str # Time zone used in the response. Optional. The default is the time zone of the calendar., updatedMin: str # Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.}\n@returns(200) {accessRole: str, defaultReminders: [map], description: str, etag: str, items: [map], kind: str, nextPageToken: str, nextSyncToken: str, summary: str, timeZone: str, updated: str(date-time)} # Successful response\n\n@endpoint POST /calendars/{calendarId}/events\n@desc Creates an event.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {conferenceDataVersion: int # Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false., supportsAttachments: bool # Whether API client performing operation supports event attachments. Optional. The default is False., anyoneCanAddSelf: bool=false # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False., attachments: [map{fileId: str, fileUrl: str, iconLink: str, mimeType: str, title: str}] # File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,, attendees: [map{additionalGuests: int(int32), comment: str, displayName: str, email: str, id: str, optional: bool, organizer: bool, resource: bool, responseStatus: str, self: bool}] # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list., attendeesOmitted: bool=false # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False., colorId: str # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the  colors endpoint). Optional., conferenceData: map{conferenceId: str, conferenceSolution: map, createRequest: map, entryPoints: [map], notes: str, parameters: map, signature: str}, created: str(date-time) # Creation time of the event (as a RFC3339 timestamp). Read-only., creator: map{displayName: str, email: str, id: str, self: bool} # The creator of the event. Read-only., description: str # Description of the event. Can contain HTML. Optional., end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool=false # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False., etag: str # ETag of the resource., eventType: str=default # Specific type of the event. Read-only. Possible values are:   - \"default\" - A regular event or not further specified.  - \"outOfOffice\" - An out-of-office event.  - \"focusTime\" - A focus-time event.  - \"workingLocation\" - A working location event. Developer Preview., extendedProperties: map{private: map, shared: map} # Extended properties of the event., gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)} # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata., guestsCanInviteOthers: bool=true # Whether attendees other than the organizer can invite others to the event. Optional. The default is True., guestsCanModify: bool=false # Whether attendees other than the organizer can modify the event. Optional. The default is False., guestsCanSeeOtherGuests: bool=true # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True., hangoutLink: str # An absolute link to the Google Hangout associated with this event. Read-only., htmlLink: str # An absolute link to this event in the Google Calendar Web UI. Read-only., iCalUID: str # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method., id: str # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:   - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938  - the length of the ID must be between 5 and 1024 characters  - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs., kind: str=calendar#event # Type of the resource (\"calendar#event\")., location: str # Geographic location of the event as free-form text. Optional., locked: bool=false # Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only., organizer: map{displayName: str, email: str, id: str, self: bool} # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event., originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool=false # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False., recurrence: [str] # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events., recurringEventId: str # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable., reminders: map{overrides: [map], useDefault: bool} # Information about the event's reminders for the authenticated user., sequence: int(int32) # Sequence number as per iCalendar., source: map{title: str, url: str} # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event., start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str # Status of the event. Optional. Possible values are:   - \"confirmed\" - The event is confirmed. This is the default status.  - \"tentative\" - The event is tentatively confirmed.  - \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:   - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.   - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated.   On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated., summary: str # Title of the event., transparency: str=opaque # Whether the event blocks time on the calendar. Optional. Possible values are:   - \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.  - \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI., updated: str(date-time) # Last modification time of the event (as a RFC3339 timestamp). Read-only., visibility: str=default # Visibility of the event. Optional. Possible values are:   - \"default\" - Uses the default visibility for events on the calendar. This is the default value.  - \"public\" - The event is public and event details are visible to all readers of the calendar.  - \"private\" - The event is private and only event attendees may view event details.  - \"confidential\" - The event is private. This value is provided for compatibility reasons., workingLocationProperties: map{customLocation: map, homeOffice: any, officeLocation: map}}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint POST /calendars/{calendarId}/events/import\n@desc Imports an event. This operation is used to add a private copy of an existing event to a calendar.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {conferenceDataVersion: int # Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0., supportsAttachments: bool # Whether API client performing operation supports event attachments. Optional. The default is False., anyoneCanAddSelf: bool=false # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False., attachments: [map{fileId: str, fileUrl: str, iconLink: str, mimeType: str, title: str}] # File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,, attendees: [map{additionalGuests: int(int32), comment: str, displayName: str, email: str, id: str, optional: bool, organizer: bool, resource: bool, responseStatus: str, self: bool}] # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list., attendeesOmitted: bool=false # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False., colorId: str # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the  colors endpoint). Optional., conferenceData: map{conferenceId: str, conferenceSolution: map, createRequest: map, entryPoints: [map], notes: str, parameters: map, signature: str}, created: str(date-time) # Creation time of the event (as a RFC3339 timestamp). Read-only., creator: map{displayName: str, email: str, id: str, self: bool} # The creator of the event. Read-only., description: str # Description of the event. Can contain HTML. Optional., end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool=false # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False., etag: str # ETag of the resource., eventType: str=default # Specific type of the event. Read-only. Possible values are:   - \"default\" - A regular event or not further specified.  - \"outOfOffice\" - An out-of-office event.  - \"focusTime\" - A focus-time event.  - \"workingLocation\" - A working location event. Developer Preview., extendedProperties: map{private: map, shared: map} # Extended properties of the event., gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)} # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata., guestsCanInviteOthers: bool=true # Whether attendees other than the organizer can invite others to the event. Optional. The default is True., guestsCanModify: bool=false # Whether attendees other than the organizer can modify the event. Optional. The default is False., guestsCanSeeOtherGuests: bool=true # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True., hangoutLink: str # An absolute link to the Google Hangout associated with this event. Read-only., htmlLink: str # An absolute link to this event in the Google Calendar Web UI. Read-only., iCalUID: str # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method., id: str # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:   - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938  - the length of the ID must be between 5 and 1024 characters  - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs., kind: str=calendar#event # Type of the resource (\"calendar#event\")., location: str # Geographic location of the event as free-form text. Optional., locked: bool=false # Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only., organizer: map{displayName: str, email: str, id: str, self: bool} # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event., originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool=false # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False., recurrence: [str] # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events., recurringEventId: str # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable., reminders: map{overrides: [map], useDefault: bool} # Information about the event's reminders for the authenticated user., sequence: int(int32) # Sequence number as per iCalendar., source: map{title: str, url: str} # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event., start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str # Status of the event. Optional. Possible values are:   - \"confirmed\" - The event is confirmed. This is the default status.  - \"tentative\" - The event is tentatively confirmed.  - \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:   - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.   - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated.   On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated., summary: str # Title of the event., transparency: str=opaque # Whether the event blocks time on the calendar. Optional. Possible values are:   - \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.  - \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI., updated: str(date-time) # Last modification time of the event (as a RFC3339 timestamp). Read-only., visibility: str=default # Visibility of the event. Optional. Possible values are:   - \"default\" - Uses the default visibility for events on the calendar. This is the default value.  - \"public\" - The event is public and event details are visible to all readers of the calendar.  - \"private\" - The event is private and only event attendees may view event details.  - \"confidential\" - The event is private. This value is provided for compatibility reasons., workingLocationProperties: map{customLocation: map, homeOffice: any, officeLocation: map}}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint POST /calendars/{calendarId}/events/quickAdd\n@desc Creates an event based on a simple text string.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., text: str # The text describing the event to be created.}\n@optional {sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Guests who should receive notifications about the creation of the new event.}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint POST /calendars/{calendarId}/events/watch\n@desc Watch for changes to Events resources.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., eventTypes: [str] # Event types to return. Optional. Possible values are:  - \"default\"  - \"focusTime\"  - \"outOfOffice\"This parameter can be repeated multiple times to return events of different types. Currently, this is the only allowed value for this field:  - [\"default\", \"focusTime\", \"outOfOffice\"] This value will be the default.  If you're enrolled in the Working Location developer preview program, in addition to the default value above you can also set the \"workingLocation\" event type:  - [\"default\", \"focusTime\", \"outOfOffice\", \"workingLocation\"]  - [\"workingLocation\"] Additional combinations of these 4 event types will be made available in later releases. Developer Preview., iCalUID: str # Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., maxResults: int # Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional., orderBy: str(startTime/updated) # The order of the events returned in the result. Optional. The default is an unspecified, stable order., pageToken: str # Token specifying which result page to return. Optional., privateExtendedProperty: [str] # Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints., q: str # Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email. Optional., sharedExtendedProperty: [str] # Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints., showDeleted: bool # Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False., showHiddenInvitations: bool # Whether to include hidden invitations in the result. Optional. The default is False., singleEvents: bool # Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.  These are:  - iCalUID  - orderBy  - privateExtendedProperty  - q  - sharedExtendedProperty  - timeMin  - timeMax  - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries., timeMax: str # Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin., timeMin: str # Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax., timeZone: str # Time zone used in the response. Optional. The default is the time zone of the calendar., updatedMin: str # Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time., address: str # The address where notifications are delivered for this channel., expiration: str(int64) # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional., id: str # A UUID or similar unique string that identifies this channel., kind: str=api#channel # Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\"., params: map # Additional parameters controlling delivery channel behavior. Optional., payload: bool # A Boolean value to indicate whether payload is wanted. Optional., resourceId: str # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions., resourceUri: str # A version-specific identifier for the watched resource., token: str # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional., type: str # The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.}\n@returns(200) {address: str, expiration: str(int64), id: str, kind: str, params: map, payload: bool, resourceId: str, resourceUri: str, token: str, type: str} # Successful response\n\n@endpoint DELETE /calendars/{calendarId}/events/{eventId}\n@desc Deletes an event.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., eventId: str # Event identifier.}\n@optional {sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Guests who should receive notifications about the deletion of the event.}\n@returns(200) Successful response\n\n@endpoint GET /calendars/{calendarId}/events/{eventId}\n@desc Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., eventId: str # Event identifier.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., timeZone: str # Time zone used in the response. Optional. The default is the time zone of the calendar.}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint PATCH /calendars/{calendarId}/events/{eventId}\n@desc Updates an event. This method supports patch semantics.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., eventId: str # Event identifier.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., conferenceDataVersion: int # Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Guests who should receive notifications about the event update (for example, title changes, etc.)., supportsAttachments: bool # Whether API client performing operation supports event attachments. Optional. The default is False., anyoneCanAddSelf: bool=false # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False., attachments: [map{fileId: str, fileUrl: str, iconLink: str, mimeType: str, title: str}] # File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,, attendees: [map{additionalGuests: int(int32), comment: str, displayName: str, email: str, id: str, optional: bool, organizer: bool, resource: bool, responseStatus: str, self: bool}] # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list., attendeesOmitted: bool=false # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False., colorId: str # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the  colors endpoint). Optional., conferenceData: map{conferenceId: str, conferenceSolution: map, createRequest: map, entryPoints: [map], notes: str, parameters: map, signature: str}, created: str(date-time) # Creation time of the event (as a RFC3339 timestamp). Read-only., creator: map{displayName: str, email: str, id: str, self: bool} # The creator of the event. Read-only., description: str # Description of the event. Can contain HTML. Optional., end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool=false # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False., etag: str # ETag of the resource., eventType: str=default # Specific type of the event. Read-only. Possible values are:   - \"default\" - A regular event or not further specified.  - \"outOfOffice\" - An out-of-office event.  - \"focusTime\" - A focus-time event.  - \"workingLocation\" - A working location event. Developer Preview., extendedProperties: map{private: map, shared: map} # Extended properties of the event., gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)} # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata., guestsCanInviteOthers: bool=true # Whether attendees other than the organizer can invite others to the event. Optional. The default is True., guestsCanModify: bool=false # Whether attendees other than the organizer can modify the event. Optional. The default is False., guestsCanSeeOtherGuests: bool=true # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True., hangoutLink: str # An absolute link to the Google Hangout associated with this event. Read-only., htmlLink: str # An absolute link to this event in the Google Calendar Web UI. Read-only., iCalUID: str # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method., id: str # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:   - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938  - the length of the ID must be between 5 and 1024 characters  - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs., kind: str=calendar#event # Type of the resource (\"calendar#event\")., location: str # Geographic location of the event as free-form text. Optional., locked: bool=false # Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only., organizer: map{displayName: str, email: str, id: str, self: bool} # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event., originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool=false # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False., recurrence: [str] # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events., recurringEventId: str # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable., reminders: map{overrides: [map], useDefault: bool} # Information about the event's reminders for the authenticated user., sequence: int(int32) # Sequence number as per iCalendar., source: map{title: str, url: str} # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event., start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str # Status of the event. Optional. Possible values are:   - \"confirmed\" - The event is confirmed. This is the default status.  - \"tentative\" - The event is tentatively confirmed.  - \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:   - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.   - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated.   On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated., summary: str # Title of the event., transparency: str=opaque # Whether the event blocks time on the calendar. Optional. Possible values are:   - \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.  - \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI., updated: str(date-time) # Last modification time of the event (as a RFC3339 timestamp). Read-only., visibility: str=default # Visibility of the event. Optional. Possible values are:   - \"default\" - Uses the default visibility for events on the calendar. This is the default value.  - \"public\" - The event is public and event details are visible to all readers of the calendar.  - \"private\" - The event is private and only event attendees may view event details.  - \"confidential\" - The event is private. This value is provided for compatibility reasons., workingLocationProperties: map{customLocation: map, homeOffice: any, officeLocation: map}}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint PUT /calendars/{calendarId}/events/{eventId}\n@desc Updates an event.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., eventId: str # Event identifier.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., conferenceDataVersion: int # Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Guests who should receive notifications about the event update (for example, title changes, etc.)., supportsAttachments: bool # Whether API client performing operation supports event attachments. Optional. The default is False., anyoneCanAddSelf: bool=false # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False., attachments: [map{fileId: str, fileUrl: str, iconLink: str, mimeType: str, title: str}] # File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,, attendees: [map{additionalGuests: int(int32), comment: str, displayName: str, email: str, id: str, optional: bool, organizer: bool, resource: bool, responseStatus: str, self: bool}] # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list., attendeesOmitted: bool=false # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False., colorId: str # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the  colors endpoint). Optional., conferenceData: map{conferenceId: str, conferenceSolution: map, createRequest: map, entryPoints: [map], notes: str, parameters: map, signature: str}, created: str(date-time) # Creation time of the event (as a RFC3339 timestamp). Read-only., creator: map{displayName: str, email: str, id: str, self: bool} # The creator of the event. Read-only., description: str # Description of the event. Can contain HTML. Optional., end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool=false # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False., etag: str # ETag of the resource., eventType: str=default # Specific type of the event. Read-only. Possible values are:   - \"default\" - A regular event or not further specified.  - \"outOfOffice\" - An out-of-office event.  - \"focusTime\" - A focus-time event.  - \"workingLocation\" - A working location event. Developer Preview., extendedProperties: map{private: map, shared: map} # Extended properties of the event., gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)} # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata., guestsCanInviteOthers: bool=true # Whether attendees other than the organizer can invite others to the event. Optional. The default is True., guestsCanModify: bool=false # Whether attendees other than the organizer can modify the event. Optional. The default is False., guestsCanSeeOtherGuests: bool=true # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True., hangoutLink: str # An absolute link to the Google Hangout associated with this event. Read-only., htmlLink: str # An absolute link to this event in the Google Calendar Web UI. Read-only., iCalUID: str # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method., id: str # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:   - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938  - the length of the ID must be between 5 and 1024 characters  - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs., kind: str=calendar#event # Type of the resource (\"calendar#event\")., location: str # Geographic location of the event as free-form text. Optional., locked: bool=false # Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only., organizer: map{displayName: str, email: str, id: str, self: bool} # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event., originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool=false # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False., recurrence: [str] # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events., recurringEventId: str # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable., reminders: map{overrides: [map], useDefault: bool} # Information about the event's reminders for the authenticated user., sequence: int(int32) # Sequence number as per iCalendar., source: map{title: str, url: str} # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event., start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str # Status of the event. Optional. Possible values are:   - \"confirmed\" - The event is confirmed. This is the default status.  - \"tentative\" - The event is tentatively confirmed.  - \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:   - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.   - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated.   On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated., summary: str # Title of the event., transparency: str=opaque # Whether the event blocks time on the calendar. Optional. Possible values are:   - \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.  - \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI., updated: str(date-time) # Last modification time of the event (as a RFC3339 timestamp). Read-only., visibility: str=default # Visibility of the event. Optional. Possible values are:   - \"default\" - Uses the default visibility for events on the calendar. This is the default value.  - \"public\" - The event is public and event details are visible to all readers of the calendar.  - \"private\" - The event is private and only event attendees may view event details.  - \"confidential\" - The event is private. This value is provided for compatibility reasons., workingLocationProperties: map{customLocation: map, homeOffice: any, officeLocation: map}}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endpoint GET /calendars/{calendarId}/events/{eventId}/instances\n@desc Returns instances of the specified recurring event.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword., eventId: str # Recurring event identifier.}\n@optional {alwaysIncludeEmail: bool # Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)., maxAttendees: int # The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional., maxResults: int # Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional., originalStart: str # The original start time of the instance in the result. Optional., pageToken: str # Token specifying which result page to return. Optional., showDeleted: bool # Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False., timeMax: str # Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset., timeMin: str # Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset., timeZone: str # Time zone used in the response. Optional. The default is the time zone of the calendar.}\n@returns(200) {accessRole: str, defaultReminders: [map], description: str, etag: str, items: [map], kind: str, nextPageToken: str, nextSyncToken: str, summary: str, timeZone: str, updated: str(date-time)} # Successful response\n\n@endpoint POST /calendars/{calendarId}/events/{eventId}/move\n@desc Moves an event to another calendar, i.e. changes an event's organizer.\n@required {calendarId: str # Calendar identifier of the source calendar where the event currently is on., eventId: str # Event identifier., destination: str # Calendar identifier of the target calendar where the event is to be moved to.}\n@optional {sendNotifications: bool # Deprecated. Please use sendUpdates instead.  Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false., sendUpdates: str(all/externalOnly/none) # Guests who should receive notifications about the change of the event's organizer.}\n@returns(200) {anyoneCanAddSelf: bool, attachments: [map], attendees: [map], attendeesOmitted: bool, colorId: str, conferenceData: map{conferenceId: str, conferenceSolution: map{iconUri: str, key: map{type: str}, name: str}, createRequest: map{conferenceSolutionKey: map{type: str}, requestId: str, status: map{statusCode: str}}, entryPoints: [map], notes: str, parameters: map{addOnParameters: map{parameters: map}}, signature: str}, created: str(date-time), creator: map{displayName: str, email: str, id: str, self: bool}, description: str, end: map{date: str(date), dateTime: str(date-time), timeZone: str}, endTimeUnspecified: bool, etag: str, eventType: str, extendedProperties: map{private: map, shared: map}, gadget: map{display: str, height: int(int32), iconLink: str, link: str, preferences: map, title: str, type: str, width: int(int32)}, guestsCanInviteOthers: bool, guestsCanModify: bool, guestsCanSeeOtherGuests: bool, hangoutLink: str, htmlLink: str, iCalUID: str, id: str, kind: str, location: str, locked: bool, organizer: map{displayName: str, email: str, id: str, self: bool}, originalStartTime: map{date: str(date), dateTime: str(date-time), timeZone: str}, privateCopy: bool, recurrence: [str], recurringEventId: str, reminders: map{overrides: [map], useDefault: bool}, sequence: int(int32), source: map{title: str, url: str}, start: map{date: str(date), dateTime: str(date-time), timeZone: str}, status: str, summary: str, transparency: str, updated: str(date-time), visibility: str, workingLocationProperties: map{customLocation: map{label: str}, homeOffice: any, officeLocation: map{buildingId: str, deskId: str, floorId: str, floorSectionId: str, label: str}}} # Successful response\n\n@endgroup\n\n@group channels\n@endpoint POST /channels/stop\n@desc Stop watching resources through this channel\n@optional {address: str # The address where notifications are delivered for this channel., expiration: str(int64) # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional., id: str # A UUID or similar unique string that identifies this channel., kind: str=api#channel # Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\"., params: map # Additional parameters controlling delivery channel behavior. Optional., payload: bool # A Boolean value to indicate whether payload is wanted. Optional., resourceId: str # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions., resourceUri: str # A version-specific identifier for the watched resource., token: str # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional., type: str # The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.}\n@returns(200) Successful response\n\n@endgroup\n\n@group colors\n@endpoint GET /colors\n@desc Returns the color definitions for calendars and events.\n@returns(200) {calendar: map, event: map, kind: str, updated: str(date-time)} # Successful response\n\n@endgroup\n\n@group freeBusy\n@endpoint POST /freeBusy\n@desc Returns free/busy information for a set of calendars.\n@optional {calendarExpansionMax: int(int32) # Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50., groupExpansionMax: int(int32) # Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100., items: [map{id: str}] # List of calendars and/or groups to query., timeMax: str(date-time) # The end of the interval for the query formatted as per RFC3339., timeMin: str(date-time) # The start of the interval for the query formatted as per RFC3339., timeZone: str=UTC # Time zone used in the response. Optional. The default is UTC.}\n@returns(200) {calendars: map, groups: map, kind: str, timeMax: str(date-time), timeMin: str(date-time)} # Successful response\n\n@endgroup\n\n@group users\n@endpoint GET /users/me/calendarList\n@desc Returns the calendars on the user's calendar list.\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., minAccessRole: str(freeBusyReader/owner/reader/writer) # The minimum access role for the user in the returned entries. Optional. The default is no restriction., pageToken: str # Token specifying which result page to return. Optional., showDeleted: bool # Whether to include deleted calendar list entries in the result. Optional. The default is False., showHidden: bool # Whether to show hidden entries. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.}\n@returns(200) {etag: str, items: [map], kind: str, nextPageToken: str, nextSyncToken: str} # Successful response\n\n@endpoint POST /users/me/calendarList\n@desc Inserts an existing calendar into the user's calendar list.\n@optional {colorRgbFormat: bool # Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False., accessRole: str # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:   - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., backgroundColor: str # The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., colorId: str # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional., conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map{method: str, minutes: int(int32)}] # The default reminders that the authenticated user has for this calendar., deleted: bool=false # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False., description: str # Description of the calendar. Optional. Read-only., etag: str # ETag of the resource., foregroundColor: str # The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., hidden: bool=false # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true., id: str # Identifier of the calendar., kind: str=calendar#calendarListEntry # Type of the resource (\"calendar#calendarListEntry\")., location: str # Geographic location of the calendar as free-form text. Optional. Read-only., notificationSettings: map{notifications: [map]} # The notifications that the authenticated user is receiving for this calendar., primary: bool=false # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False., selected: bool=false # Whether the calendar content shows up in the calendar UI. Optional. The default is False., summary: str # Title of the calendar. Read-only., summaryOverride: str # The summary that the authenticated user has set for this calendar. Optional., timeZone: str # The time zone of the calendar. Optional. Read-only.}\n@returns(200) {accessRole: str, backgroundColor: str, colorId: str, conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map], deleted: bool, description: str, etag: str, foregroundColor: str, hidden: bool, id: str, kind: str, location: str, notificationSettings: map{notifications: [map]}, primary: bool, selected: bool, summary: str, summaryOverride: str, timeZone: str} # Successful response\n\n@endpoint POST /users/me/calendarList/watch\n@desc Watch for changes to CalendarList resources.\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., minAccessRole: str(freeBusyReader/owner/reader/writer) # The minimum access role for the user in the returned entries. Optional. The default is no restriction., pageToken: str # Token specifying which result page to return. Optional., showDeleted: bool # Whether to include deleted calendar list entries in the result. Optional. The default is False., showHidden: bool # Whether to show hidden entries. Optional. The default is False., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries., address: str # The address where notifications are delivered for this channel., expiration: str(int64) # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional., id: str # A UUID or similar unique string that identifies this channel., kind: str=api#channel # Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\"., params: map # Additional parameters controlling delivery channel behavior. Optional., payload: bool # A Boolean value to indicate whether payload is wanted. Optional., resourceId: str # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions., resourceUri: str # A version-specific identifier for the watched resource., token: str # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional., type: str # The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.}\n@returns(200) {address: str, expiration: str(int64), id: str, kind: str, params: map, payload: bool, resourceId: str, resourceUri: str, token: str, type: str} # Successful response\n\n@endpoint DELETE /users/me/calendarList/{calendarId}\n@desc Removes a calendar from the user's calendar list.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@returns(200) Successful response\n\n@endpoint GET /users/me/calendarList/{calendarId}\n@desc Returns a calendar from the user's calendar list.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@returns(200) {accessRole: str, backgroundColor: str, colorId: str, conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map], deleted: bool, description: str, etag: str, foregroundColor: str, hidden: bool, id: str, kind: str, location: str, notificationSettings: map{notifications: [map]}, primary: bool, selected: bool, summary: str, summaryOverride: str, timeZone: str} # Successful response\n\n@endpoint PATCH /users/me/calendarList/{calendarId}\n@desc Updates an existing calendar on the user's calendar list. This method supports patch semantics.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {colorRgbFormat: bool # Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False., accessRole: str # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:   - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., backgroundColor: str # The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., colorId: str # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional., conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map{method: str, minutes: int(int32)}] # The default reminders that the authenticated user has for this calendar., deleted: bool=false # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False., description: str # Description of the calendar. Optional. Read-only., etag: str # ETag of the resource., foregroundColor: str # The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., hidden: bool=false # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true., id: str # Identifier of the calendar., kind: str=calendar#calendarListEntry # Type of the resource (\"calendar#calendarListEntry\")., location: str # Geographic location of the calendar as free-form text. Optional. Read-only., notificationSettings: map{notifications: [map]} # The notifications that the authenticated user is receiving for this calendar., primary: bool=false # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False., selected: bool=false # Whether the calendar content shows up in the calendar UI. Optional. The default is False., summary: str # Title of the calendar. Read-only., summaryOverride: str # The summary that the authenticated user has set for this calendar. Optional., timeZone: str # The time zone of the calendar. Optional. Read-only.}\n@returns(200) {accessRole: str, backgroundColor: str, colorId: str, conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map], deleted: bool, description: str, etag: str, foregroundColor: str, hidden: bool, id: str, kind: str, location: str, notificationSettings: map{notifications: [map]}, primary: bool, selected: bool, summary: str, summaryOverride: str, timeZone: str} # Successful response\n\n@endpoint PUT /users/me/calendarList/{calendarId}\n@desc Updates an existing calendar on the user's calendar list.\n@required {calendarId: str # Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.}\n@optional {colorRgbFormat: bool # Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False., accessRole: str # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:   - \"freeBusyReader\" - Provides read access to free/busy information.  - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.  - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.  - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs., backgroundColor: str # The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., colorId: str # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional., conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map{method: str, minutes: int(int32)}] # The default reminders that the authenticated user has for this calendar., deleted: bool=false # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False., description: str # Description of the calendar. Optional. Read-only., etag: str # ETag of the resource., foregroundColor: str # The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional., hidden: bool=false # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true., id: str # Identifier of the calendar., kind: str=calendar#calendarListEntry # Type of the resource (\"calendar#calendarListEntry\")., location: str # Geographic location of the calendar as free-form text. Optional. Read-only., notificationSettings: map{notifications: [map]} # The notifications that the authenticated user is receiving for this calendar., primary: bool=false # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False., selected: bool=false # Whether the calendar content shows up in the calendar UI. Optional. The default is False., summary: str # Title of the calendar. Read-only., summaryOverride: str # The summary that the authenticated user has set for this calendar. Optional., timeZone: str # The time zone of the calendar. Optional. Read-only.}\n@returns(200) {accessRole: str, backgroundColor: str, colorId: str, conferenceProperties: map{allowedConferenceSolutionTypes: [str]}, defaultReminders: [map], deleted: bool, description: str, etag: str, foregroundColor: str, hidden: bool, id: str, kind: str, location: str, notificationSettings: map{notifications: [map]}, primary: bool, selected: bool, summary: str, summaryOverride: str, timeZone: str} # Successful response\n\n@endpoint GET /users/me/settings\n@desc Returns all user settings for the authenticated user.\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., pageToken: str # Token specifying which result page to return. Optional., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.}\n@returns(200) {etag: str, items: [map], kind: str, nextPageToken: str, nextSyncToken: str} # Successful response\n\n@endpoint POST /users/me/settings/watch\n@desc Watch for changes to Settings resources.\n@optional {maxResults: int # Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional., pageToken: str # Token specifying which result page to return. Optional., syncToken: str # Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries., address: str # The address where notifications are delivered for this channel., expiration: str(int64) # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional., id: str # A UUID or similar unique string that identifies this channel., kind: str=api#channel # Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\"., params: map # Additional parameters controlling delivery channel behavior. Optional., payload: bool # A Boolean value to indicate whether payload is wanted. Optional., resourceId: str # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions., resourceUri: str # A version-specific identifier for the watched resource., token: str # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional., type: str # The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.}\n@returns(200) {address: str, expiration: str(int64), id: str, kind: str, params: map, payload: bool, resourceId: str, resourceUri: str, token: str, type: str} # Successful response\n\n@endpoint GET /users/me/settings/{setting}\n@desc Returns a single user setting.\n@required {setting: str # The id of the user setting.}\n@returns(200) {etag: str, id: str, kind: str, value: str} # Successful response\n\n@endgroup\n\n@end\n"}