@swamp/gcp/calendar
v2026.04.23.1
Google Cloud calendar infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudcalendarcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/calendarevents.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| anyoneCanAddSelf? | boolean | Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. |
| attachments? | array | ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| attendees? | array | Number of additional guests. Optional. The default is 0. |
| attendeesOmitted? | boolean | 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. |
| birthdayProperties? | object | Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: "people/c12345". Read-only. |
| colorId? | string | 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? | object | The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type: - eventHangout: ID is not set. (This conference type is deprecated.) - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.) - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. - addOn: ID is defined by the third-party provider. Optional. |
| created? | string | Creation time of the event (as a RFC3339 timestamp). Read-only. |
| creator? | object | The creator's name, if available. |
| description? | string | Description of the event. Can contain HTML. Optional. |
| end? | object | The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| endTimeUnspecified? | boolean | 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. |
| eventType? | string | Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. |
| extendedProperties? | object | Properties that are private to the copy of the event that appears on this calendar. |
| focusTimeProperties? | object | Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined. |
| gadget? | object | The gadget\'s display mode. Deprecated. Possible values are: - "icon" - The gadget displays next to the event\'s title in the calendar view. - "chip" - The gadget displays when the event is clicked. |
| guestsCanInviteOthers? | boolean | Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| guestsCanModify? | boolean | Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| guestsCanSeeOtherGuests? | boolean | Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| hangoutLink? | string | An absolute link to the Google Hangout associated with this event. Read-only. |
| htmlLink? | string | An absolute link to this event in the Google Calendar Web UI. Read-only. |
| iCalUID? | string | 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? | string | 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. |
| location? | string | Geographic location of the event as free-form text. Optional. |
| locked? | boolean | 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? | object | The organizer's name, if available. |
| originalStartTime? | object | The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| outOfOfficeProperties? | object | Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined. |
| privateCopy? | boolean | 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? | array | 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? | string | For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| reminders? | object | The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder. |
| sequence? | number | Sequence number as per iCalendar. |
| source? | object | Title of the source; for example a title of a web page or an email subject. |
| start? | object | The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| status? | string | 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? | string | Title of the event. |
| transparency? | string | 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? | string | Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. |
| visibility? | string | 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? | object | An optional extra label for additional information. |
| calendarId | string | 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. |
| conferenceDataVersion? | string | 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? | string | 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? | string | 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? | string | Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. |
| supportsAttachments? | string | Whether API client performing operation supports event attachments. Optional. The default is False. |
createCreate a events
getGet a events
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the events |
updateUpdate events attributes
deleteDelete the events
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the events |
syncSync events state from GCP
importimport
| Argument | Type | Description |
|---|---|---|
| anyoneCanAddSelf? | any | |
| attachments? | any | |
| attendees? | any | |
| attendeesOmitted? | any | |
| birthdayProperties? | any | |
| colorId? | any | |
| conferenceData? | any | |
| created? | any | |
| creator? | any | |
| description? | any | |
| end? | any | |
| endTimeUnspecified? | any | |
| etag? | any | |
| eventType? | any | |
| extendedProperties? | any | |
| focusTimeProperties? | any | |
| gadget? | any | |
| guestsCanInviteOthers? | any | |
| guestsCanModify? | any | |
| guestsCanSeeOtherGuests? | any | |
| hangoutLink? | any | |
| htmlLink? | any | |
| iCalUID? | any | |
| id? | any | |
| kind? | any | |
| location? | any | |
| locked? | any | |
| organizer? | any | |
| originalStartTime? | any | |
| outOfOfficeProperties? | any | |
| privateCopy? | any | |
| recurrence? | any | |
| recurringEventId? | any | |
| reminders? | any | |
| sequence? | any | |
| source? | any | |
| start? | any | |
| status? | any | |
| summary? | any | |
| transparency? | any | |
| updated? | any | |
| visibility? | any | |
| workingLocationProperties? | any |
instancesinstances
movemove
quick_addquick add
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
colors.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a colors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the colors |
syncSync colors state from GCP
calendars.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| autoAcceptInvitations? | boolean | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
| conferenceProperties? | object | The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. |
| dataOwner? | string | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
| description? | string | Description of the calendar. Optional. |
| id? | string | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| location? | string | Geographic location of the calendar as free-form text. Optional. |
| summary | string | Title of the calendar. |
| timeZone? | string | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
createCreate a calendars
getGet a calendars
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendars |
updateUpdate calendars attributes
deleteDelete the calendars
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendars |
syncSync calendars state from GCP
clearclear
settings.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a settings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the settings |
syncSync settings state from GCP
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
calendarlist.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessRole? | string | 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 manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. Important: the owner role is different from the calendar\'s data owner. A calendar has a single data owner, but can have multiple users with owner role. |
| autoAcceptInvitations? | boolean | Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only. |
| backgroundColor? | string | 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? | string | 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? | object | The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. |
| dataOwner? | string | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
| defaultReminders? | array | The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder. |
| deleted? | boolean | Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
| description? | string | Description of the calendar. Optional. Read-only. |
| foregroundColor? | string | 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? | boolean | 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 | string | Identifier of the calendar. |
| location? | string | Geographic location of the calendar as free-form text. Optional. Read-only. |
| notificationSettings? | object | The method used to deliver the notification. The possible value is: - "email" - Notifications are sent via email. Required when adding a notification. |
| primary? | boolean | Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
| selected? | boolean | Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
| summary? | string | Title of the calendar. Read-only. |
| summaryOverride? | string | The summary that the authenticated user has set for this calendar. Optional. |
| timeZone? | string | The time zone of the calendar. Optional. Read-only. |
| colorRgbFormat? | string | 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. |
createCreate a calendarList
getGet a calendarList
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendarList |
updateUpdate calendarList attributes
deleteDelete the calendarList
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendarList |
syncSync calendarList state from GCP
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
acl.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| id? | string | Identifier of the Access Control List (ACL) rule. See Sharing calendars. |
| role | string | 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. Provides read access to the calendar\'s ACLs. - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. Important: the owner role is different from the calendar\'s data owner. A calendar has a single data owner, but can have multiple users with owner role. |
| scope? | object | The type of the scope. Possible values are: - "default" - The public scope. This is the default value. - "user" - Limits the scope to a single user. - "group" - Limits the scope to a group. - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not. |
| calendarId | string | 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. |
| sendNotifications? | string | Whether to send notifications about the calendar sharing change. Optional. The default is True. |
createCreate a acl
getGet a acl
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the acl |
updateUpdate acl attributes
deleteDelete the acl
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the acl |
syncSync acl state from GCP
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
2026.04.03.364.6 KBApr 3, 2026
Google Cloud calendar infrastructure models
Release Notes
- Updated: acl, calendarlist, calendars, colors, events, settings
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcalendarcloudinfrastructure
2026.04.03.164.1 KBApr 3, 2026
Google Cloud calendar infrastructure models
Release Notes
- Updated: acl, calendarlist, calendars, colors, events, settings
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcalendarcloudinfrastructure
2026.04.02.264.1 KBApr 2, 2026
Google Cloud calendar infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcalendarcloudinfrastructure
2026.03.27.163.5 KBMar 27, 2026
Google Cloud calendar infrastructure models
Release Notes
- Added: acl, calendarlist, calendars, colors, events, settings
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcalendarcloudinfrastructure