$npx -y skills add googleworkspace/cli --skill gws-calendarGoogle Calendar: Manage calendars and events.
| 1 | # calendar (v3) |
| 2 | |
| 3 | > **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it. |
| 4 | |
| 5 | ```bash |
| 6 | gws calendar <resource> <method> [flags] |
| 7 | ``` |
| 8 | |
| 9 | ## Helper Commands |
| 10 | |
| 11 | | Command | Description | |
| 12 | |---------|-------------| |
| 13 | | [`+insert`](../gws-calendar-insert/SKILL.md) | create a new event | |
| 14 | | [`+agenda`](../gws-calendar-agenda/SKILL.md) | Show upcoming events across all calendars | |
| 15 | |
| 16 | ## API Resources |
| 17 | |
| 18 | ### acl |
| 19 | |
| 20 | - `delete` — Deletes an access control rule. |
| 21 | - `get` — Returns an access control rule. |
| 22 | - `insert` — Creates an access control rule. |
| 23 | - `list` — Returns the rules in the access control list for the calendar. |
| 24 | - `patch` — Updates an access control rule. This method supports patch semantics. |
| 25 | - `update` — Updates an access control rule. |
| 26 | - `watch` — Watch for changes to ACL resources. |
| 27 | |
| 28 | ### calendarList |
| 29 | |
| 30 | - `delete` — Removes a calendar from the user's calendar list. |
| 31 | - `get` — Returns a calendar from the user's calendar list. |
| 32 | - `insert` — Inserts an existing calendar into the user's calendar list. |
| 33 | - `list` — Returns the calendars on the user's calendar list. |
| 34 | - `patch` — Updates an existing calendar on the user's calendar list. This method supports patch semantics. |
| 35 | - `update` — Updates an existing calendar on the user's calendar list. |
| 36 | - `watch` — Watch for changes to CalendarList resources. |
| 37 | |
| 38 | ### calendars |
| 39 | |
| 40 | - `clear` — Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. |
| 41 | - `delete` — Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. |
| 42 | - `get` — Returns metadata for a calendar. |
| 43 | - `insert` — Creates a secondary calendar. |
| 44 | The authenticated user for the request is made the data owner of the new calendar. |
| 45 | |
| 46 | Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. |
| 47 | - `patch` — Updates metadata for a calendar. This method supports patch semantics. |
| 48 | - `update` — Updates metadata for a calendar. |
| 49 | |
| 50 | ### channels |
| 51 | |
| 52 | - `stop` — Stop watching resources through this channel |
| 53 | |
| 54 | ### colors |
| 55 | |
| 56 | - `get` — Returns the color definitions for calendars and events. |
| 57 | |
| 58 | ### events |
| 59 | |
| 60 | - `delete` — Deletes an event. |
| 61 | - `get` — 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. |
| 62 | - `import` — Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported. |
| 63 | Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped. |
| 64 | - `insert` — Creates an event. |
| 65 | - `instances` — Returns instances of the specified recurring event. |
| 66 | - `list` — Returns events on the specified calendar. |
| 67 | - `move` — Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved. |
| 68 | - `patch` — Updates an event. This method supports patch semantics. |
| 69 | - `quickAdd` — Creates an event based on a simple text string. |
| 70 | - `update` — Updates an event. |
| 71 | - `watch` — Watch for changes to Events resources. |
| 72 | |
| 73 | ### freebusy |
| 74 | |
| 75 | - `query` — Returns free/busy information for a set of calendars. |
| 76 | |
| 77 | ### settings |
| 78 | |
| 79 | - `get` — Returns a single user setting. |
| 80 | - `list` — Returns all user settings for the authenticated user. |
| 81 | - `watch` — Watch for changes to Settings resources. |
| 82 | |
| 83 | ## Discovering Commands |
| 84 | |
| 85 | Before calling any API method, inspect it: |
| 86 | |
| 87 | ```bash |
| 88 | # Browse resources and methods |
| 89 | gws calendar --help |
| 90 | |
| 91 | # Inspect a method's required params, types, and defaults |
| 92 | gws schema calendar.<resource>.<method> |
| 93 | ``` |
| 94 | |
| 95 | Use `gws schema` output to build your `--params` and `--json` flags. |