Skip to main content

Gcp/calendar

@swamp/gcp/calendarv2026.07.02.1· 5d agoMODELS
01README

Google Cloud calendar infrastructure models

02Release Notes
  • Updated: calendars
03Models6
acl.tsv2026.06.08.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
id?stringIdentifier of the Access Control List (ACL) rule. See Sharing calendars.
rolestringThe 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?objectThe 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.
calendarIdstringCalendar 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?stringWhether to send notifications about the calendar sharing change. Optional. The default is True.
fn create()
Create a acl
fn get(identifier: string)
Get a acl
ArgumentTypeDescription
identifierstringThe name of the acl
fn update()
Update acl attributes
fn delete(identifier: string)
Delete the acl
ArgumentTypeDescription
identifierstringThe name of the acl
fn sync()
Sync acl state from GCP
fn list(maxResults?: number, showDeleted?: boolean, syncToken?: string, maxPages?: number)
List acl resources
ArgumentTypeDescription
maxResults?numberMaximum 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.
showDeleted?booleanWhether 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?stringToken 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
calendarlist.tsv2026.06.08.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
accessRole?stringThe 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?booleanWhether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only.
backgroundColor?stringThe 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?stringThe 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?objectThe types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional.
dataOwner?stringThe email of the owner of the calendar. Set only for secondary calendars. Read-only.
defaultReminders?arrayThe 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?booleanWhether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
description?stringDescription of the calendar. Optional. Read-only.
foregroundColor?stringThe 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?booleanWhether 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.
idstringIdentifier of the calendar.
location?stringGeographic location of the calendar as free-form text. Optional. Read-only.
notificationSettings?objectThe method used to deliver the notification. The possible value is: - "email" - Notifications are sent via email. Required when adding a notification.
primary?booleanWhether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
selected?booleanWhether the calendar content shows up in the calendar UI. Optional. The default is False.
summary?stringTitle of the calendar. Read-only.
summaryOverride?stringThe summary that the authenticated user has set for this calendar. Optional.
timeZone?stringThe time zone of the calendar. Optional. Read-only.
colorRgbFormat?stringWhether 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.
fn create()
Create a calendarList
fn get(identifier: string)
Get a calendarList
ArgumentTypeDescription
identifierstringThe name of the calendarList
fn update()
Update calendarList attributes
fn delete(identifier: string)
Delete the calendarList
ArgumentTypeDescription
identifierstringThe name of the calendarList
fn sync()
Sync calendarList state from GCP
fn list(maxResults?: number, minAccessRole?: string, showDeleted?: boolean, showHidden?: boolean, syncToken?: string, maxPages?: number)
List calendarList resources
ArgumentTypeDescription
maxResults?numberMaximum 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?stringThe minimum access role for the user in the returned entries. Optional. The default is no restriction.
showDeleted?booleanWhether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden?booleanWhether to show hidden entries. Optional. The default is False.
syncToken?stringToken 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
calendars.tsv2026.07.02.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
autoAcceptInvitations?booleanWhether this calendar automatically accepts invitations. Only valid for resource calendars.
conferenceProperties?objectThe types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional.
dataOwner?stringThe email of the owner of the calendar. Set only for secondary calendars. Read-only.
description?stringDescription of the calendar. Optional.
id?stringIdentifier of the calendar. To retrieve IDs call the calendarList.list() method.
location?stringGeographic location of the calendar as free-form text. Optional.
summarystringTitle of the calendar.
timeZone?stringThe time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
fn create()
Create a calendars
fn get(identifier: string)
Get a calendars
ArgumentTypeDescription
identifierstringThe name of the calendars
fn update()
Update calendars attributes
fn delete(identifier: string)
Delete the calendars
ArgumentTypeDescription
identifierstringThe name of the calendars
fn sync()
Sync calendars state from GCP
fn clear()
clear
fn transfer_ownership()
transfer ownership
colors.tsv2026.06.08.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
fn get(identifier: string)
Get a colors
ArgumentTypeDescription
identifierstringThe name of the colors
fn sync()
Sync colors state from GCP
events.tsv2026.06.08.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
anyoneCanAddSelf?booleanWhether anyone can invite themselves to the event (deprecated). Optional. The default is False.
attachments?arrayID 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?arrayNumber of additional guests. Optional. The default is 0.
attendeesOmitted?booleanWhether 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?objectResource 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?stringThe 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?objectThe 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?stringCreation time of the event (as a RFC3339 timestamp). Read-only.
creator?objectThe creator's name, if available.
description?stringDescription of the event. Can contain HTML. Optional.
end?objectThe date, in the format "yyyy-mm-dd", if this is an all-day event.
endTimeUnspecified?booleanWhether 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?stringSpecific 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?objectProperties that are private to the copy of the event that appears on this calendar.
focusTimeProperties?objectWhether 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?objectThe 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?booleanWhether attendees other than the organizer can invite others to the event. Optional. The default is True.
guestsCanModify?booleanWhether attendees other than the organizer can modify the event. Optional. The default is False.
guestsCanSeeOtherGuests?booleanWhether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
hangoutLink?stringAn absolute link to the Google Hangout associated with this event. Read-only.
htmlLink?stringAn absolute link to this event in the Google Calendar Web UI. Read-only.
iCalUID?stringEvent 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?stringOpaque 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?stringGeographic location of the event as free-form text. Optional.
locked?booleanWhether 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?objectThe organizer's name, if available.
originalStartTime?objectThe date, in the format "yyyy-mm-dd", if this is an all-day event.
outOfOfficeProperties?objectWhether 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?booleanIf 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?arrayList 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?stringFor an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders?objectThe 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?numberSequence number as per iCalendar.
source?objectTitle of the source; for example a title of a web page or an email subject.
start?objectThe date, in the format "yyyy-mm-dd", if this is an all-day event.
status?stringStatus 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?stringTitle of the event.
transparency?stringWhether 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?stringLast modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.
visibility?stringVisibility 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?objectAn optional extra label for additional information.
calendarIdstringCalendar 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?stringVersion 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?stringThe 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?stringDeprecated. 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?stringWhether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
supportsAttachments?stringWhether API client performing operation supports event attachments. Optional. The default is False.
fn create()
Create a events
fn get(identifier: string)
Get a events
ArgumentTypeDescription
identifierstringThe name of the events
fn update()
Update events attributes
fn delete(identifier: string)
Delete the events
ArgumentTypeDescription
identifierstringThe name of the events
fn sync()
Sync events state from GCP
fn list(alwaysIncludeEmail?: boolean, eventTypes?: string, iCalUID?: string, maxAttendees?: number, maxResults?: number, orderBy?: string, privateExtendedProperty?: string, q?: string, sharedExtendedProperty?: string, showDeleted?: boolean, showHiddenInvitations?: boolean, singleEvents?: boolean, syncToken?: string, timeMax?: string, timeMin?: string, timeZone?: string, updatedMin?: string, maxPages?: number)
List events resources
ArgumentTypeDescription
alwaysIncludeEmail?booleanDeprecated and ignored.
eventTypes?stringEvent types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.
iCalUID?stringSpecifies 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?numberThe 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?numberMaximum 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?stringThe order of the events returned in the result. Optional. The default is an unspecified, stable order.
privateExtendedProperty?stringExtended 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?stringFree text search terms to find events that match these terms in the following fields:
sharedExtendedProperty?stringExtended 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?booleanWhether 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?booleanWhether to include hidden invitations in the result. Optional. The default is False.
singleEvents?booleanWhether 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?stringToken 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.
timeMax?stringUpper 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?stringLower 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?stringTime zone used in the response. Optional. The default is the time zone of the calendar.
updatedMin?stringLower 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn import(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)
import
ArgumentTypeDescription
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
fn instances()
instances
fn move()
move
fn quick_add()
quick add
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
settings.tsv2026.06.08.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
fn get(identifier: string)
Get a settings
ArgumentTypeDescription
identifierstringThe name of the settings
fn sync()
Sync settings state from GCP
fn list(maxResults?: number, syncToken?: string, maxPages?: number)
List settings resources
ArgumentTypeDescription
maxResults?numberMaximum 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.
syncToken?stringToken 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
04Previous Versions14
2026.06.08.2Jun 8, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.06.07.1Jun 7, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.05.26.1May 26, 2026
  • Updated: events
2026.05.25.2May 25, 2026
  • Updated: calendarlist, settings

Modified 1 models

2026.05.24.1May 24, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.05.21.2May 21, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026

Modified 1 models

2026.04.23.1Apr 23, 2026

Modified 1 models

2026.04.03.3Apr 3, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.04.03.1Apr 3, 2026
  • Updated: acl, calendarlist, calendars, colors, events, settings
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
  • Added: acl, calendarlist, calendars, colors, events, settings
05Stats
A
100 / 100
Downloads
2
Archive size
114.7 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels