diff --git a/google_calendar.yml b/google_calendar.yml index dd80b28..1a6cd77 100644 --- a/google_calendar.yml +++ b/google_calendar.yml @@ -165,8 +165,8 @@ paths: - $ref: '#/parameters/prettyPrint' - $ref: '#/parameters/quotaUser' - $ref: '#/parameters/userIp' - put: - description: Updates metadata for a calendar. + patch: + description: Updates some metadata for a calendar, using patch semantics. operationId: update_calendar parameters: - in: body @@ -188,6 +188,29 @@ paths: - 'https://www.googleapis.com/auth/calendar' tags: - calendars + put: + description: Updates all metadata for a a calendar. Any fields that are not included will be cleared. + operationId: update_calendar_entire + parameters: + - in: body + name: body + schema: + $ref: '#/definitions/Calendar' + - description: 'Calendar identifier. To retrieve calendar IDs call the get_calendarlist method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.' + in: path + name: calendarId + required: true + type: string + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/Calendar' + security: + - Oauth2: + - 'https://www.googleapis.com/auth/calendar' + tags: + - calendars '/calendars/{calendarId}/acl': get: description: Returns the rules in the access control list for the calendar. @@ -250,10 +273,18 @@ paths: name: calendarId required: true type: string - - description: Whether to send notifications about the calendar sharing change. Optional. The default is True. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none responses: '200': description: Successful response @@ -374,9 +405,49 @@ paths: - $ref: '#/parameters/prettyPrint' - $ref: '#/parameters/quotaUser' - $ref: '#/parameters/userIp' + patch: + description: Updates an access control rule with patch semantics. + operationId: update_acl_rule + parameters: + - in: body + name: body + schema: + $ref: '#/definitions/AclRule' + - description: 'Calendar identifier. To retrieve calendar IDs call the get_calendarlist method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.' + in: path + name: calendarId + required: true + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + type: string + - description: Deprecated. Use sendUpdates instead + in: query + name: sendNotifications + type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/AclRule' + security: + - Oauth2: + - 'https://www.googleapis.com/auth/calendar' + tags: + - acl put: description: Updates an access control rule. - operationId: update_acl_rule + operationId: update_acl_rule_all parameters: - in: body name: body @@ -392,10 +463,18 @@ paths: name: ruleId required: true type: string - - description: Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none responses: '200': description: Successful response @@ -580,10 +659,18 @@ paths: minimum: 1 name: maxAttendees type: integer - - description: Whether to send notifications about the creation of the new event. Optional. The default is False. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none - description: Whether API client performing operation supports event attachments. Optional. The default is False. in: query name: supportsAttachments @@ -658,10 +745,18 @@ paths: name: calendarId required: true type: string - - description: Whether to send notifications about the creation of the event. Optional. The default is False. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none - description: The text describing the event to be created. in: query name: text @@ -820,10 +915,18 @@ paths: name: eventId required: true type: string - - description: Whether to send notifications about the deletion of the event. Optional. The default is False. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none responses: '200': description: Successful response @@ -879,9 +982,68 @@ paths: - $ref: '#/parameters/prettyPrint' - $ref: '#/parameters/quotaUser' - $ref: '#/parameters/userIp' + patch: + description: Updates an event with patch semantics. + operationId: update_calendar_event + parameters: + - description: 'Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.' + in: query + name: alwaysIncludeEmail + type: boolean + - in: body + name: body + schema: + $ref: '#/definitions/Event' + - description: 'Calendar identifier. To retrieve calendar IDs call the get_calendarlist method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.' + in: path + name: calendarId + required: true + type: string + - description: 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. + in: query + maximum: 1 + minimum: 0 + name: conferenceDataVersion + type: integer + - description: Event identifier. + in: path + name: eventId + required: true + type: string + - description: '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.' + in: query + minimum: 1 + name: maxAttendees + type: integer + - description: Deprecated. Use sendUpdates instead + in: query + name: sendNotifications + type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none + - description: Whether API client performing operation supports event attachments. Optional. The default is False. + in: query + name: supportsAttachments + type: boolean + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/Event' + security: + - Oauth2: + - 'https://www.googleapis.com/auth/calendar' + tags: + - events put: description: Updates an event. - operationId: update_calendar_event + operationId: update_calendar_event_entire parameters: - description: 'Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.' in: query @@ -912,10 +1074,18 @@ paths: minimum: 1 name: maxAttendees type: integer - - description: 'Whether to send notifications about the event update (e.g. attendee''s responses, title changes, etc.). Optional. The default is False.' + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none - description: Whether API client performing operation supports event attachments. Optional. The default is False. in: query name: supportsAttachments @@ -1031,10 +1201,18 @@ paths: name: eventId required: true type: string - - description: Whether to send notifications about the change of the event's organizer. Optional. The default is False. + - description: Deprecated. Use sendUpdates instead in: query name: sendNotifications type: boolean + - description: Guests who should receive notifications about the creation of the new event. + in: query + name: sendUpdates + type: boolean + enum: + - all + - externalOnly + - none responses: '200': description: Successful response @@ -1318,9 +1496,36 @@ paths: - $ref: '#/parameters/prettyPrint' - $ref: '#/parameters/quotaUser' - $ref: '#/parameters/userIp' + patch: + description: Updates an entry on the user's calendar list, with patch semantics. + operationId: update_calendarlist_entry + parameters: + - in: body + name: body + schema: + $ref: '#/definitions/CalendarListEntry' + - description: 'Calendar identifier. To retrieve calendar IDs call the get_calendarlist method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.' + in: path + name: calendarId + required: true + type: string + - description: '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.' + in: query + name: colorRgbFormat + type: boolean + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/CalendarListEntry' + security: + - Oauth2: + - 'https://www.googleapis.com/auth/calendar' + tags: + - calendarList put: description: Updates an entry on the user's calendar list. - operationId: update_calendarlist_entry + operationId: update_calendarlist_entry_entire parameters: - in: body name: body @@ -1655,7 +1860,7 @@ definitions: description: |- The method used to deliver the notification. Possible values are: - "email" - Reminders are sent via email. - - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for G Suite customers. + - "sms" - Deprecated. Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for G Suite customers. type: string type: description: |- @@ -1663,8 +1868,8 @@ definitions: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - - "eventResponse" - Notification sent when an event is changed. - - "agenda" - An agenda with the events of the day (sent out in the morning). + - "eventResponse" - Notification sent when an attendee responds to the event invitation. + - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notifcaiton. type: string type: object Channel: @@ -1864,6 +2069,11 @@ definitions: When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. type: string + entryPointFeatures: + description: 'Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.' + items: + type: string + type: array entryPointType: description: |- The type of the conference entry point. @@ -1906,6 +2116,11 @@ definitions: When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. type: string + regionCode: + description: |- + The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. + Calendar backend will populate this field only for EntryPointType.PHONE. + type: string uri: description: |- The URI of the entry point. The maximum length is 1300 characters. @@ -1973,7 +2188,7 @@ definitions: description: 'The creator''s email address, if available.' type: string id: - description: 'The creator''s Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API' + description: 'The creator''s Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API' type: string self: default: false @@ -2098,7 +2313,7 @@ definitions: description: 'The organizer''s email address, if available. It must be a valid email address as per RFC5322.' type: string id: - description: 'The organizer''s Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API' + description: 'The organizer''s Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API' type: string self: default: false @@ -2107,7 +2322,7 @@ definitions: type: object originalStartTime: $ref: '#/definitions/EventDateTime' - description: 'For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.' + description: 'For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.' privateCopy: default: false description: Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. @@ -2154,7 +2369,13 @@ definitions: 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. + - "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. type: string summary: description: Title of the event. @@ -2190,7 +2411,7 @@ definitions: fileUrl: description: |- URL link to the attachment. - For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. + For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment. type: string iconLink: description: URL link to the attachment's icon. Read-only. @@ -2219,7 +2440,7 @@ definitions: description: 'The attendee''s email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.' type: string id: - description: 'The attendee''s Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API' + description: 'The attendee''s Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API' type: string optional: default: false @@ -2265,7 +2486,7 @@ definitions: description: |- The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. + - "sms" - Deprecated. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup. type: string minutes: @@ -2350,11 +2571,11 @@ definitions: FreeBusyRequest: properties: calendarExpansionMax: - description: Maximal number of calendars for which FreeBusy information is to be provided. Optional. + description: Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. format: int32 type: integer groupExpansionMax: - description: Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value. + description: Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value. Maximum value if 100. format: int32 type: integer items: @@ -2363,11 +2584,11 @@ definitions: $ref: '#/definitions/FreeBusyRequestItem' type: array timeMax: - description: The end of the interval for the query. + description: The end of the interval for the query formatted as per RFC3339. format: date-time type: string timeMin: - description: The start of the interval for the query. + description: The start of the interval for the query formatted as per RFC3339. format: date-time type: string timeZone: