diff --git a/google_calendar.yml b/google_calendar.yml index 4f8f3bf..be3ddfa 100644 --- a/google_calendar.yml +++ b/google_calendar.yml @@ -1,6 +1,6 @@ openapi: 3.0.0 servers: -- url: https://www.googleapis.com/calendar/v3 + - url: https://www.googleapis.com/calendar/v3 info: contact: name: Google @@ -16,37 +16,37 @@ info: x-apiClientRegistration: url: https://console.developers.google.com x-apisguru-categories: - - analytics - - media + - analytics + - media x-logo: url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png x-origin: - - format: google - url: https://calendar-json.googleapis.com/$discovery/rest?version=v3 - version: v1 + - format: google + url: https://calendar-json.googleapis.com/$discovery/rest?version=v3 + version: v1 x-providerName: googleapis.com x-serviceName: calendar externalDocs: url: https://developers.google.com/google-apps/calendar/firstapp tags: -- name: acl -- name: calendarList -- name: calendars -- name: channels -- name: colors -- name: events -- name: freebusy -- name: settings + - name: acl + - name: calendarList + - name: calendars + - name: channels + - name: colors + - name: events + - name: freebusy + - name: settings paths: /calendars: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendar x-originalOperationId: calendar.calendars.insert @@ -55,149 +55,154 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}: delete: operationId: delete_calendar x-originalOperationId: calendar.calendars.delete - description: Deletes a secondary calendar. Use calendars.clear for clearing + description: + Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars get: operationId: get_calendar x-originalOperationId: calendar.calendars.get description: Returns metadata for a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendars + - calendars parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendar x-originalOperationId: calendar.calendars.patch description: Updates metadata for a calendar. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars put: operationId: update_calendar_entire x-originalOperationId: calendar.calendars.update description: Updates metadata for a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}/acl: get: operationId: get_acl_rules @@ -211,387 +216,405 @@ paths: maxLimit: 250 description: Returns the rules in the access control list for the calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: '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. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Acl' + $ref: "#/components/schemas/Acl" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_acl_rule x-originalOperationId: calendar.acl.insert description: Creates an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Whether to send notifications about the calendar sharing change. - Optional. The default is True. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + Whether to send notifications about the calendar sharing change. + Optional. The default is True. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/acl/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_acl x-originalOperationId: calendar.acl.watch description: Watch for changes to ACL resources. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: '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. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/acl/{ruleId}: delete: operationId: delete_acl_rule x-originalOperationId: calendar.acl.delete description: Deletes an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl get: operationId: get_acl_rule x-originalOperationId: calendar.acl.get description: Returns an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - acl + - acl parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_acl_rule x-originalOperationId: calendar.acl.patch description: Updates an access control rule. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - 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. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + 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. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl put: operationId: update_acl_rule_all x-originalOperationId: calendar.acl.update description: Updates an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - 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. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + 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. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/clear: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: clear_calendar x-originalOperationId: calendar.calendars.clear - description: Clears a primary calendar. This operation deletes all events associated + description: + Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}/events: get: operationId: get_calendar_events @@ -605,919 +628,982 @@ paths: maxLimit: 250 description: Returns events on the specified calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - description: Specifies event ID in the iCalendar format to be included in - the response. Optional. - in: query - name: iCalUID - schema: - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The order of the events returned in the result. Optional. The - default is an unspecified, stable order. - in: query - name: orderBy - schema: - enum: - - startTime - - updated - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - explode: true - in: query - name: privateExtendedProperty - schema: - items: + - description: + 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. + in: path + name: calendarId + required: true + schema: type: string - type: array - style: form - - description: Free text search terms to find events that match these terms - in any field, except for extended properties. Optional. - in: query - name: q - schema: - type: string - - description: 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. - explode: true - in: query - name: sharedExtendedProperty - schema: - items: + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - description: + Specifies event ID in the iCalendar format to be included in + the response. Optional. + in: query + name: iCalUID + schema: + 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The order of the events returned in the result. Optional. The + default is an unspecified, stable order. + in: query + name: orderBy + schema: + enum: + - startTime + - updated + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + explode: true + in: query + name: privateExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + Free text search terms to find events that match these terms + in any field, except for extended properties. Optional. + in: query + name: q + schema: + type: string + - description: + 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. + explode: true + in: query + name: sharedExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + Whether to include hidden invitations in the result. Optional. + The default is False. + in: query + name: showHiddenInvitations + schema: + type: boolean + - description: + 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. + in: query + name: singleEvents + schema: + type: boolean + - description: + "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.\nThere are\ + \ several query parameters that cannot be specified together with nextSyncToken\ + \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ + - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ + - timeMin \n- timeMax \n- 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.\n\ + Learn more about incremental synchronization.\nOptional. The default is\ + \ to return all entries." + in: query + name: syncToken + schema: + type: string + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string + - description: + 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. + in: query + name: updatedMin + schema: type: string - type: array - style: form - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to include hidden invitations in the result. Optional. - The default is False. - in: query - name: showHiddenInvitations - schema: - type: boolean - - description: 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. - in: query - name: singleEvents - schema: - type: boolean - - description: "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.\nThere are\ - \ several query parameters that cannot be specified together with nextSyncToken\ - \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ - - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ - - timeMin \n- timeMax \n- 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.\n\ - Learn more about incremental synchronization.\nOptional. The default is\ - \ to return all entries." - in: query - name: syncToken - schema: - type: string - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string - - description: 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. - in: query - name: updatedMin - schema: - type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Events' + $ref: "#/components/schemas/Events" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendar_event x-originalOperationId: calendar.events.insert description: Creates an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Whether to send notifications about the creation of the new event. - Note that some emails might still be sent. The default is false. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Whether to send notifications about the creation of the new event. + Note that some emails might still be sent. The default is false. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/import: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: import_calendar_event x-originalOperationId: calendar.events.import - description: Imports an event. This operation is used to add a private copy + description: + Imports an event. This operation is used to add a private copy of an existing event to a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/quickAdd: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: quickAdd_calendar_event x-originalOperationId: calendar.events.quickAdd description: Creates an event based on a simple text string. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: The text describing the event to be created. - in: query - name: text - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: The text describing the event to be created. + in: query + name: text + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the creation of - the new event. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the creation of + the new event. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_calendar_events x-originalOperationId: calendar.events.watch description: Watch for changes to Events resources. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - description: Specifies event ID in the iCalendar format to be included in - the response. Optional. - in: query - name: iCalUID - schema: - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The order of the events returned in the result. Optional. The - default is an unspecified, stable order. - in: query - name: orderBy - schema: - enum: - - startTime - - updated - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - explode: true - in: query - name: privateExtendedProperty - schema: - items: + - description: + 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. + in: path + name: calendarId + required: true + schema: type: string - type: array - style: form - - description: Free text search terms to find events that match these terms - in any field, except for extended properties. Optional. - in: query - name: q - schema: - type: string - - description: 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. - explode: true - in: query - name: sharedExtendedProperty - schema: - items: + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - description: + Specifies event ID in the iCalendar format to be included in + the response. Optional. + in: query + name: iCalUID + schema: + 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The order of the events returned in the result. Optional. The + default is an unspecified, stable order. + in: query + name: orderBy + schema: + enum: + - startTime + - updated + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + explode: true + in: query + name: privateExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + Free text search terms to find events that match these terms + in any field, except for extended properties. Optional. + in: query + name: q + schema: + type: string + - description: + 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. + explode: true + in: query + name: sharedExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + Whether to include hidden invitations in the result. Optional. + The default is False. + in: query + name: showHiddenInvitations + schema: + type: boolean + - description: + 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. + in: query + name: singleEvents + schema: + type: boolean + - description: + "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.\nThere are\ + \ several query parameters that cannot be specified together with nextSyncToken\ + \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ + - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ + - timeMin \n- timeMax \n- 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.\n\ + Learn more about incremental synchronization.\nOptional. The default is\ + \ to return all entries." + in: query + name: syncToken + schema: + type: string + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string + - description: + 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. + in: query + name: updatedMin + schema: type: string - type: array - style: form - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to include hidden invitations in the result. Optional. - The default is False. - in: query - name: showHiddenInvitations - schema: - type: boolean - - description: 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. - in: query - name: singleEvents - schema: - type: boolean - - description: "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.\nThere are\ - \ several query parameters that cannot be specified together with nextSyncToken\ - \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ - - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ - - timeMin \n- timeMax \n- 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.\n\ - Learn more about incremental synchronization.\nOptional. The default is\ - \ to return all entries." - in: query - name: syncToken - schema: - type: string - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string - - description: 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. - in: query - name: updatedMin - schema: - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events /calendars/{calendarId}/events/{eventId}: delete: operationId: delete_calendar_event x-originalOperationId: calendar.events.delete description: Deletes an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the deletion of - the event. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the deletion of + the event. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events get: operationId: get_calendar_event x-originalOperationId: calendar.events.get description: Returns an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendar_event x-originalOperationId: calendar.events.patch description: Updates an event. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the event update - (for example, title changes, etc.). - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the event update + (for example, title changes, etc.). + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events put: operationId: update_calendar_event_entire x-originalOperationId: calendar.events.update description: Updates an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the event update - (for example, title changes, etc.). - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the event update + (for example, title changes, etc.). + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/{eventId}/instances: get: operationId: get_calendar_event_instances @@ -1531,195 +1617,206 @@ paths: maxLimit: 250 description: Returns instances of the specified recurring event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Recurring event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The original start time of the instance in the result. Optional. - in: query - name: originalStart - schema: - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Recurring event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: The original start time of the instance in the result. Optional. + in: query + name: originalStart + schema: + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Events' + $ref: "#/components/schemas/Events" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /calendars/{calendarId}/events/{eventId}/move: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: move_calendar_event x-originalOperationId: calendar.events.move description: Moves an event to another calendar, i.e. changes an event's organizer. parameters: - - description: Calendar identifier of the source calendar where the event currently - is on. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: Calendar identifier of the target calendar where the event is - to be moved to. - in: query - name: destination - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + Calendar identifier of the source calendar where the event currently + is on. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + Calendar identifier of the target calendar where the event is + to be moved to. + in: query + name: destination + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the change of the - event's organizer. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the change of the + event's organizer. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /channels/stop: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: stop_channel x-originalOperationId: calendar.channels.stop @@ -1728,73 +1825,73 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - channels + - channels /colors: get: operationId: get_calendar_colors x-originalOperationId: calendar.colors.get description: Returns the color definitions for calendars and events. responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Colors' + $ref: "#/components/schemas/Colors" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - colors + - colors parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /freeBusy: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: get_calendars_freebusy x-originalOperationId: calendar.freebusy.query @@ -1803,25 +1900,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FreeBusyRequest' + $ref: "#/components/schemas/FreeBusyRequest" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FreeBusyResponse' + $ref: "#/components/schemas/FreeBusyResponse" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - freebusy + - freebusy /users/me/calendarList: get: operationId: get_calendarlist @@ -1835,359 +1932,375 @@ paths: maxLimit: 250 description: Returns the calendars on the user's calendar list. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The minimum access role for the user in the returned entries. - Optional. The default is no restriction. - in: query - name: minAccessRole - schema: - enum: - - freeBusyReader - - owner - - reader - - writer - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: Whether to include deleted calendar list entries in the result. - Optional. The default is False. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to show hidden entries. Optional. The default is False. - in: query - name: showHidden - schema: - type: boolean - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The minimum access role for the user in the returned entries. + Optional. The default is no restriction. + in: query + name: minAccessRole + schema: + enum: + - freeBusyReader + - owner + - reader + - writer + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + Whether to include deleted calendar list entries in the result. + Optional. The default is False. + in: query + name: showDeleted + schema: + type: boolean + - description: Whether to show hidden entries. Optional. The default is False. + in: query + name: showHidden + schema: + type: boolean + - description: + "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. + 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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarList' + $ref: "#/components/schemas/CalendarList" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendarlist_entry x-originalOperationId: calendar.calendarList.insert description: Inserts an existing calendar into the user's calendar list. parameters: - - 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 - schema: - type: boolean + - 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList /users/me/calendarList/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_calendarlist x-originalOperationId: calendar.calendarList.watch description: Watch for changes to CalendarList resources. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The minimum access role for the user in the returned entries. - Optional. The default is no restriction. - in: query - name: minAccessRole - schema: - enum: - - freeBusyReader - - owner - - reader - - writer - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: Whether to include deleted calendar list entries in the result. - Optional. The default is False. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to show hidden entries. Optional. The default is False. - in: query - name: showHidden - schema: - type: boolean - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The minimum access role for the user in the returned entries. + Optional. The default is no restriction. + in: query + name: minAccessRole + schema: + enum: + - freeBusyReader + - owner + - reader + - writer + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + Whether to include deleted calendar list entries in the result. + Optional. The default is False. + in: query + name: showDeleted + schema: + type: boolean + - description: Whether to show hidden entries. Optional. The default is False. + in: query + name: showHidden + schema: + type: boolean + - description: + "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. + 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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList /users/me/calendarList/{calendarId}: delete: operationId: delete_calendarlist_entry x-originalOperationId: calendar.calendarList.delete description: Removes a calendar from the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList get: operationId: get_calendarlist_entry x-originalOperationId: calendar.calendarList.get description: Returns a calendar from the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendarlist_entry x-originalOperationId: calendar.calendarList.patch - description: Updates an existing calendar on the user's calendar list. This + description: + Updates an existing calendar on the user's calendar list. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList put: operationId: update_calendarlist_entry_entire x-originalOperationId: calendar.calendarList.update description: Updates an existing calendar on the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList /users/me/settings: get: operationId: get_my_settings @@ -2201,175 +2314,179 @@ paths: maxLimit: 250 description: Returns all user settings for the authenticated user. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /users/me/settings/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_settings x-originalOperationId: calendar.settings.watch description: Watch for changes to Settings resources. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings /users/me/settings/{setting}: get: operationId: get_setting x-originalOperationId: calendar.settings.get description: Returns a single user setting. parameters: - - description: The id of the user setting. - in: path - name: setting - required: true - schema: - type: string + - description: The id of the user setting. + in: path + name: setting + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Setting' + $ref: "#/components/schemas/Setting" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" components: parameters: alt: @@ -2378,7 +2495,7 @@ components: name: alt schema: enum: - - json + - json type: string fields: description: Selector specifying which fields to include in a partial response. @@ -2387,7 +2504,8 @@ components: schema: type: string key: - description: API key. Your API key identifies your project and provides you + description: + API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query @@ -2407,7 +2525,8 @@ components: schema: type: boolean quotaUser: - description: An opaque string that represents a user for quota purposes. Must + description: + An opaque string that represents a user for quota purposes. Must not exceed 40 characters. in: query name: quotaUser @@ -2428,18 +2547,20 @@ components: items: description: List of rules on the access control list. items: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" type: array kind: default: calendar#acl description: Type of the collection ("calendar#acl"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -2450,7 +2571,8 @@ components: description: ETag of the resource. type: string id: - description: Identifier of the Access Control List (ACL) rule. See Sharing + description: + Identifier of the Access Control List (ACL) rule. See Sharing calendars. type: string kind: @@ -2458,7 +2580,8 @@ components: description: Type of the resource ("calendar#aclRule"). type: string role: - description: "The role assigned to the scope. Possible values are: \n-\ + description: + "The role assigned to the scope. Possible values are: \n-\ \ \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read\ \ access to free/busy information. \n- \"reader\" - Provides read access\ \ to the calendar. Private events will appear to users with reader access,\ @@ -2469,11 +2592,13 @@ components: \ writer role with the additional ability to see and manipulate ACLs." type: string scope: - description: The extent to which calendar access is granted by this ACL + description: + The extent to which calendar access is granted by this ACL rule. properties: type: - description: "The type of the scope. Possible values are: \n- \"default\"\ + description: + "The type of the scope. Possible values are: \n- \"default\"\ \ - The public scope. This is the default value. \n- \"user\" - Limits\ \ the scope to a single user. \n- \"group\" - Limits the scope to\ \ a group. \n- \"domain\" - Limits the scope to a domain. Note: The\ @@ -2481,7 +2606,8 @@ components: \ any user, authenticated or not." type: string value: - description: The email address of a user or group, or the name of a + description: + The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default". type: string type: object @@ -2489,8 +2615,9 @@ components: Calendar: properties: conferenceProperties: - $ref: '#/components/schemas/ConferenceProperties' - description: Conferencing properties for this calendar, for example what + $ref: "#/components/schemas/ConferenceProperties" + description: + Conferencing properties for this calendar, for example what types of conferences are allowed. description: description: Description of the calendar. Optional. @@ -2499,7 +2626,8 @@ components: description: ETag of the resource. type: string id: - description: Identifier of the calendar. To retrieve IDs call the calendarList.list() + description: + Identifier of the calendar. To retrieve IDs call the calendarList.list() method. type: string kind: @@ -2513,7 +2641,8 @@ components: description: Title of the calendar. type: string timeZone: - description: The time zone of the calendar. (Formatted as an IANA Time Zone + description: + The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. type: string type: object @@ -2525,18 +2654,20 @@ components: items: description: Calendars that are present on the user's calendar list. items: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" type: array kind: default: calendar#calendarList description: Type of the collection ("calendar#calendarList"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -2544,7 +2675,8 @@ components: CalendarListEntry: properties: accessRole: - description: "The effective access role that the authenticated user has\ + description: + "The effective access role that the authenticated user has\ \ on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\"\ \ - Provides read access to free/busy information. \n- \"reader\" - Provides\ \ read access to the calendar. Private events will appear to users with\ @@ -2556,30 +2688,35 @@ components: \ manipulate ACLs." type: string backgroundColor: - description: The main color of the calendar in the hexadecimal format "#0088aa". + description: + 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. type: string colorId: - description: The color of the calendar. This is an ID referring to an entry + description: + 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. type: string conferenceProperties: - $ref: '#/components/schemas/ConferenceProperties' - description: Conferencing properties for this calendar, for example what + $ref: "#/components/schemas/ConferenceProperties" + description: + Conferencing properties for this calendar, for example what types of conferences are allowed. defaultReminders: - description: The default reminders that the authenticated user has for this + description: + The default reminders that the authenticated user has for this calendar. items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array deleted: default: false - description: Whether this calendar list entry has been deleted from the + description: + Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. type: boolean description: @@ -2589,14 +2726,16 @@ components: description: ETag of the resource. type: string foregroundColor: - description: The foreground color of the calendar in the hexadecimal format + description: + 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. type: string hidden: default: false - description: Whether the calendar has been hidden from the list. Optional. + description: + 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. type: boolean @@ -2608,34 +2747,39 @@ components: description: Type of the resource ("calendar#calendarListEntry"). type: string location: - description: Geographic location of the calendar as free-form text. Optional. + description: + Geographic location of the calendar as free-form text. Optional. Read-only. type: string notificationSettings: - description: The notifications that the authenticated user is receiving + description: + The notifications that the authenticated user is receiving for this calendar. properties: notifications: description: The list of notifications set for this calendar. items: - $ref: '#/components/schemas/CalendarNotification' + $ref: "#/components/schemas/CalendarNotification" type: array type: object primary: default: false - description: Whether the calendar is the primary calendar of the authenticated + description: + Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. type: boolean selected: default: false - description: Whether the calendar content shows up in the calendar UI. Optional. + description: + Whether the calendar content shows up in the calendar UI. Optional. The default is False. type: boolean summary: description: Title of the calendar. Read-only. type: string summaryOverride: - description: The summary that the authenticated user has set for this calendar. + description: + The summary that the authenticated user has set for this calendar. Optional. type: string timeZone: @@ -2645,12 +2789,14 @@ components: CalendarNotification: properties: method: - description: "The method used to deliver the notification. The possible\ + description: + "The method used to deliver the notification. The possible\ \ value is: \n- \"email\" - Notifications are sent via email. \nRequired\ \ when adding a notification." type: string type: - description: "The type of notification. Possible values are: \n- \"eventCreation\"\ + description: + "The type of notification. Possible values are: \n- \"eventCreation\"\ \ - Notification sent when a new event is put on the calendar. \n- \"\ eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\"\ \ - Notification sent when an event is cancelled. \n- \"eventResponse\"\ @@ -2665,7 +2811,8 @@ components: description: The address where notifications are delivered for this channel. type: string expiration: - description: Date and time of notification channel expiration, expressed + description: + Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. format: int64 type: string @@ -2674,32 +2821,37 @@ components: type: string kind: default: api#channel - description: Identifies this as a notification channel used to watch for + description: + Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". type: string params: additionalProperties: description: Declares a new parameter by name. type: string - description: Additional parameters controlling delivery channel behavior. + description: + Additional parameters controlling delivery channel behavior. Optional. type: object payload: description: A Boolean value to indicate whether payload is wanted. Optional. type: boolean resourceId: - description: An opaque ID that identifies the resource being watched on + description: + An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. type: string resourceUri: description: A version-specific identifier for the watched resource. type: string token: - description: An arbitrary string delivered to the target address with each + description: + An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. type: string type: - description: The type of delivery mechanism used for this channel. Valid + description: + 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. type: string @@ -2710,7 +2862,8 @@ components: description: The background color associated with this color definition. type: string foreground: - description: The foreground color that can be used to write on top of a + description: + The foreground color that can be used to write on top of a background with 'background' color. type: string type: object @@ -2718,17 +2871,19 @@ components: properties: calendar: additionalProperties: - $ref: '#/components/schemas/ColorDefinition' + $ref: "#/components/schemas/ColorDefinition" description: A calendar color definition. - description: A global palette of calendar colors, mapping from the color + description: + A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only. type: object event: additionalProperties: - $ref: '#/components/schemas/ColorDefinition' + $ref: "#/components/schemas/ColorDefinition" description: An event color definition. - description: A global palette of event colors, mapping from the color ID + description: + A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only. type: object @@ -2737,7 +2892,8 @@ components: description: Type of the resource ("calendar#colors"). type: string updated: - description: Last modification time of the color palette (as a RFC3339 timestamp). + description: + Last modification time of the color palette (as a RFC3339 timestamp). Read-only. format: date-time type: string @@ -2745,7 +2901,8 @@ components: ConferenceData: properties: conferenceId: - description: "The ID of the conference.\nCan be used by developers to keep\ + description: + "The ID of the conference.\nCan be used by developers to keep\ \ track of conferences, should not be displayed to users.\nThe ID value\ \ is formed differently for each conference solution type: \n- eventHangout:\ \ ID is not set. (This conference type is deprecated.)\n- eventNamedHangout:\ @@ -2754,55 +2911,59 @@ components: - addOn: ID is defined by the third-party provider. Optional." type: string conferenceSolution: - $ref: '#/components/schemas/ConferenceSolution' - description: 'The conference solution, such as Google Meet. + $ref: "#/components/schemas/ConferenceSolution" + description: "The conference solution, such as Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." createRequest: - $ref: '#/components/schemas/CreateConferenceRequest' - description: 'A request to generate a new conference and attach it to the + $ref: "#/components/schemas/CreateConferenceRequest" + description: + "A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." entryPoints: - description: 'Information about individual conference entry points, such + description: + "Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." items: - $ref: '#/components/schemas/EntryPoint' + $ref: "#/components/schemas/EntryPoint" type: array notes: - description: Additional notes (such as instructions from the domain administrator, + description: + Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. type: string parameters: - $ref: '#/components/schemas/ConferenceParameters' - description: Additional properties related to a conference. An example would + $ref: "#/components/schemas/ConferenceParameters" + description: + Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. signature: - description: 'The signature of the conference data. + description: "The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. - Optional for a conference with a pending create request.' + Optional for a conference with a pending create request." type: string type: object ConferenceParameters: properties: addOnParameters: - $ref: '#/components/schemas/ConferenceParametersAddOnParameters' + $ref: "#/components/schemas/ConferenceParametersAddOnParameters" description: Additional add-on specific data. type: object ConferenceParametersAddOnParameters: @@ -2815,7 +2976,8 @@ components: ConferenceProperties: properties: allowedConferenceSolutionTypes: - description: "The types of conference solutions that are supported for this\ + description: + "The types of conference solutions that are supported for this\ \ calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\"\ \ \n- \"hangoutsMeet\" Optional." items: @@ -2825,7 +2987,8 @@ components: ConferenceRequestStatus: properties: statusCode: - description: "The current status of the conference create request. Read-only.\n\ + description: + "The current status of the conference create request. Read-only.\n\ The possible values are: \n- \"pending\": the conference create request\ \ is still being processed.\n- \"success\": the conference create request\ \ succeeded, the entry points are populated.\n- \"failure\": the conference\ @@ -2838,8 +3001,9 @@ components: description: The user-visible icon for this solution. type: string key: - $ref: '#/components/schemas/ConferenceSolutionKey' - description: The key which can uniquely identify the conference solution + $ref: "#/components/schemas/ConferenceSolutionKey" + description: + The key which can uniquely identify the conference solution for this event. name: description: The user-visible name of this solution. Not localized. @@ -2848,7 +3012,8 @@ components: ConferenceSolutionKey: properties: type: - description: "The conference solution type.\nIf a client encounters an unfamiliar\ + description: + "The conference solution type.\nIf a client encounters an unfamiliar\ \ or empty type, it should still be able to display the entry points.\ \ However, it should disallow modifications.\nThe possible values are:\ \ \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing\ @@ -2863,22 +3028,23 @@ components: CreateConferenceRequest: properties: conferenceSolutionKey: - $ref: '#/components/schemas/ConferenceSolutionKey' + $ref: "#/components/schemas/ConferenceSolutionKey" description: The conference solution, such as Hangouts or Google Meet. requestId: - description: 'The client-generated unique ID for this request. + description: "The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided - is the same as for the previous request, the request is ignored.' + is the same as for the previous request, the request is ignored." type: string status: - $ref: '#/components/schemas/ConferenceRequestStatus' + $ref: "#/components/schemas/ConferenceRequestStatus" description: The status of the conference create request. type: object EntryPoint: properties: accessCode: - description: 'The access code to access the conference. The maximum length + description: + "The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2886,17 +3052,19 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string entryPointFeatures: - description: Features of the entry point, such as being toll or toll-free. + 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.\nPossible values are:\ + description: + "The type of the conference entry point.\nPossible values are:\ \ \n- \"video\" - joining a conference over HTTP. A conference can have\ \ zero or one video entry point.\n- \"phone\" - joining a conference by\ \ dialing a phone number. A conference can have zero or more phone entry\ @@ -2907,13 +3075,15 @@ components: \ point is not a valid conference." type: string label: - description: "The label for the URI. Visible to end users. Not localized.\ + description: + "The label for the URI. Visible to end users. Not localized.\ \ The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n\ - for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for\ \ more: should not be filled \nOptional." type: string meetingCode: - description: 'The meeting code to access the conference. The maximum length + description: + "The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2921,19 +3091,21 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string passcode: - description: 'The passcode to access the conference. The maximum length + description: + "The passcode to access the conference. The maximum length is 128 characters. 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.' + displayed." type: string password: - description: 'The password to access the conference. The maximum length + description: + "The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2941,10 +3113,11 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string pin: - description: 'The PIN to access the conference. The maximum length is 128 + description: + "The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2952,16 +3125,18 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string regionCode: - description: 'The CLDR/ISO 3166 region code for the country associated with + 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.\n\ + description: + "The URI of the entry point. The maximum length is 1300 characters.\n\ Format: \n- for video, http: or https: schema is required.\n- for phone,\ \ tel: schema is required. The URI should include the entire dial sequence\ \ (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is\ @@ -2975,7 +3150,8 @@ components: description: Domain, or broad category, of the error. type: string reason: - description: "Specific reason for the error. Some of the possible values\ + description: + "Specific reason for the error. Some of the possible values\ \ are: \n- \"groupTooBig\" - The group of users requested is too large\ \ for a single query. \n- \"tooManyCalendarsRequested\" - The number of\ \ calendars requested is too large for a single query. \n- \"notFound\"\ @@ -2989,43 +3165,49 @@ components: properties: anyoneCanAddSelf: default: false - description: Whether anyone can invite themselves to the event (deprecated). + description: + Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. type: boolean attachments: - description: 'File attachments for the event. Currently only Google Drive + description: + "File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. - There can be at most 25 attachments per event,' + There can be at most 25 attachments per event," items: - $ref: '#/components/schemas/EventAttachment' + $ref: "#/components/schemas/EventAttachment" type: array attendees: - description: The attendees of the event. See the Events with attendees guide + description: + 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. items: - $ref: '#/components/schemas/EventAttendee' + $ref: "#/components/schemas/EventAttendee" type: array attendeesOmitted: default: false - description: Whether attendees may have been omitted from the event's representation. + description: + 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. type: boolean colorId: - description: The color of the event. This is an ID referring to an entry + description: + 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. type: string conferenceData: - $ref: '#/components/schemas/ConferenceData' - description: The conference-related information, such as details of a Google + $ref: "#/components/schemas/ConferenceData" + description: + The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. @@ -3047,7 +3229,8 @@ components: type: string self: default: false - description: Whether the creator corresponds to the calendar on which + description: + Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object @@ -3055,12 +3238,14 @@ components: description: Description of the event. Can contain HTML. Optional. type: string end: - $ref: '#/components/schemas/EventDateTime' - description: The (exclusive) end time of the event. For a recurring event, + $ref: "#/components/schemas/EventDateTime" + description: + The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. endTimeUnspecified: default: false - description: Whether the end time is actually unspecified. An end time is + description: + 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. type: boolean @@ -3069,7 +3254,8 @@ components: type: string eventType: default: default - description: "Specific type of the event. Read-only. Possible values are:\ + description: + "Specific type of the event. Read-only. Possible values are:\ \ \n- \"default\" - A regular event or not further specified. \n- \"\ outOfOffice\" - An out-of-office event. \n- \"focusTime\" - A focus-time\ \ event." @@ -3079,33 +3265,40 @@ components: properties: private: additionalProperties: - description: The name of the private property and the corresponding + description: + The name of the private property and the corresponding value. type: string - description: Properties that are private to the copy of the event that + description: + Properties that are private to the copy of the event that appears on this calendar. type: object shared: additionalProperties: - description: The name of the shared property and the corresponding + description: + The name of the shared property and the corresponding value. type: string - description: Properties that are shared between copies of the event + description: + Properties that are shared between copies of the event on other attendees' calendars. type: object type: object gadget: - description: A gadget that extends this event. Gadgets are deprecated; this + description: + A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. properties: display: - description: "The gadget's display mode. Deprecated. Possible values\ + description: + "The gadget's display mode. Deprecated. Possible values\ \ are: \n- \"icon\" - The gadget displays next to the event's title\ \ in the calendar view. \n- \"chip\" - The gadget displays when the\ \ event is clicked." type: string height: - description: The gadget's height in pixels. The height must be an integer + description: + The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. format: int32 type: integer @@ -3128,46 +3321,54 @@ components: description: The gadget's type. Deprecated. type: string width: - description: The gadget's width in pixels. The width must be an integer + description: + The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. format: int32 type: integer type: object guestsCanInviteOthers: default: true - description: Whether attendees other than the organizer can invite others + description: + Whether attendees other than the organizer can invite others to the event. Optional. The default is True. type: boolean guestsCanModify: default: false - description: Whether attendees other than the organizer can modify the event. + description: + Whether attendees other than the organizer can modify the event. Optional. The default is False. type: boolean guestsCanSeeOtherGuests: default: true - description: Whether attendees other than the organizer can see who the + description: + Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. type: boolean hangoutLink: - description: An absolute link to the Google Hangout associated with this + description: + An absolute link to the Google Hangout associated with this event. Read-only. type: string htmlLink: - description: An absolute link to this event in the Google Calendar Web UI. + description: + An absolute link to this event in the Google Calendar Web UI. Read-only. type: string iCalUID: - description: 'Event unique identifier as defined in RFC5545. It is used + description: + "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.' + ids while they all share the same icalUIDs." type: string id: - description: "Opaque identifier of the event. When creating new single or\ + description: + "Opaque identifier of the event. When creating new single or\ \ recurring events, you can specify their IDs. Provided IDs must follow\ \ these rules: \n- 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\ @@ -3191,12 +3392,14 @@ components: type: string locked: default: false - description: Whether this is a locked event copy where no changes can be + description: + 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. type: boolean organizer: - description: The organizer of the event. If the organizer is also an attendee, + description: + 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. @@ -3205,7 +3408,8 @@ components: description: The organizer's name, if available. type: string email: - description: The organizer's email address, if available. It must be + description: + The organizer's email address, if available. It must be a valid email address as per RFC5322. type: string id: @@ -3213,25 +3417,29 @@ components: type: string self: default: false - description: Whether the organizer corresponds to the calendar on which + description: + Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object originalStartTime: - $ref: '#/components/schemas/EventDateTime' - description: For an instance of a recurring event, this is the time at which + $ref: "#/components/schemas/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. 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: If set to True, Event propagation is disabled. Note that it + description: + 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. type: boolean recurrence: - description: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring + description: + 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 @@ -3240,23 +3448,27 @@ components: type: string type: array recurringEventId: - description: For an instance of a recurring event, this is the id of the + description: + For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. type: string reminders: - description: Information about the event's reminders for the authenticated + description: + Information about the event's reminders for the authenticated user. properties: overrides: - description: If the event doesn't use the default reminders, this lists + description: + If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array useDefault: - description: Whether the default reminders of the calendar apply to + description: + Whether the default reminders of the calendar apply to the event. type: boolean type: object @@ -3265,25 +3477,30 @@ components: format: int32 type: integer source: - description: Source from which the event was created. For example, a web + description: + 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. properties: title: - description: Title of the source; for example a title of a web page + description: + Title of the source; for example a title of a web page or an email subject. type: string url: - description: URL of the source pointing to a resource. The URL scheme + description: + URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. type: string type: object start: - $ref: '#/components/schemas/EventDateTime' - description: The (inclusive) start time of the event. For a recurring event, + $ref: "#/components/schemas/EventDateTime" + description: + The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. status: - description: "Status of the event. Optional. Possible values are: \n- \"\ + description: + "Status of the event. Optional. Possible values are: \n- \"\ confirmed\" - The event is confirmed. This is the default status. \n-\ \ \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\"\ \ - The event is cancelled (deleted). The list method returns cancelled\ @@ -3314,7 +3531,8 @@ components: type: string transparency: default: opaque - description: "Whether the event blocks time on the calendar. Optional. Possible\ + description: + "Whether the event blocks time on the calendar. Optional. Possible\ \ values are: \n- \"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. \n- \"transparent\" - The event does not block time\ @@ -3322,13 +3540,15 @@ components: \ in the Calendar UI." type: string updated: - description: Last modification time of the event (as a RFC3339 timestamp). + description: + Last modification time of the event (as a RFC3339 timestamp). Read-only. format: date-time type: string visibility: default: default - description: "Visibility of the event. Optional. Possible values are: \n\ + description: + "Visibility of the event. Optional. Possible values are: \n\ - \"default\" - Uses the default visibility for events on the calendar.\ \ This is the default value. \n- \"public\" - The event is public and\ \ event details are visible to all readers of the calendar. \n- \"private\"\ @@ -3340,18 +3560,18 @@ components: EventAttachment: properties: fileId: - description: 'ID of the attached file. Read-only. + description: "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.' + entry in the Drive API." type: string fileUrl: - description: 'URL link to the attachment. + 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. - Required when adding an attachment.' + Required when adding an attachment." type: string iconLink: description: URL link to the attachment's icon. Read-only. @@ -3377,32 +3597,37 @@ components: description: The attendee's name, if available. Optional. type: string email: - description: 'The attendee''s email address, if available. This field must + 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. - Required when adding an attendee.' + Required when adding an attendee." type: string id: description: The attendee's Profile ID, if available. type: string optional: default: false - description: Whether this is an optional attendee. Optional. The default + description: + Whether this is an optional attendee. Optional. The default is False. type: boolean organizer: - description: Whether the attendee is the organizer of the event. Read-only. + description: + Whether the attendee is the organizer of the event. Read-only. The default is False. type: boolean resource: default: false - description: Whether the attendee is a resource. Can only be set when the + description: + Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. type: boolean responseStatus: - description: "The attendee's response status. Possible values are: \n-\ + description: + "The attendee's response status. Possible values are: \n-\ \ \"needsAction\" - The attendee has not responded to the invitation.\ \ \n- \"declined\" - The attendee has declined the invitation. \n- \"\ tentative\" - The attendee has tentatively accepted the invitation. \n\ @@ -3410,25 +3635,29 @@ components: type: string self: default: false - description: Whether this entry represents the calendar on which this copy + description: + Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object EventDateTime: properties: date: - description: The date, in the format "yyyy-mm-dd", if this is an all-day + description: + The date, in the format "yyyy-mm-dd", if this is an all-day event. format: date type: string dateTime: - description: The time, as a combined date-time value (formatted according + description: + The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. format: date-time type: string timeZone: - description: The time zone in which the time is specified. (Formatted as + description: + The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates @@ -3438,22 +3667,25 @@ components: EventReminder: properties: method: - description: "The method used by this reminder. Possible values are: \n\ + description: + "The method used by this reminder. Possible values are: \n\ - \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders\ \ are sent via a UI popup. \nRequired when adding a reminder." type: string minutes: - description: 'Number of minutes before the start of the event when the reminder + description: + "Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). - Required when adding a reminder.' + Required when adding a reminder." format: int32 type: integer type: object Events: properties: accessRole: - description: "The user's access role for this calendar. Read-only. Possible\ + description: + "The user's access role for this calendar. Read-only. Possible\ \ values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\"\ \ - The user has read access to free/busy information. \n- \"reader\"\ \ - The user has read access to the calendar. Private events will appear\ @@ -3465,12 +3697,13 @@ components: \ ability to see and manipulate ACLs." type: string defaultReminders: - description: The default reminders on the calendar for the authenticated + description: + The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array description: description: Description of the calendar. Read-only. @@ -3481,18 +3714,20 @@ components: items: description: List of events on the calendar. items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" type: array kind: default: calendar#events description: Type of the collection ("calendar#events"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -3503,7 +3738,8 @@ components: description: The time zone of the calendar. Read-only. type: string updated: - description: Last modification time of the calendar (as a RFC3339 timestamp). + description: + Last modification time of the calendar (as a RFC3339 timestamp). Read-only. format: date-time type: string @@ -3511,15 +3747,16 @@ components: FreeBusyCalendar: properties: busy: - description: List of time ranges during which this calendar should be regarded + description: + List of time ranges during which this calendar should be regarded as busy. items: - $ref: '#/components/schemas/TimePeriod' + $ref: "#/components/schemas/TimePeriod" type: array errors: description: Optional error(s) (if computation for the calendar failed). items: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" type: array type: object FreeBusyGroup: @@ -3532,18 +3769,20 @@ components: errors: description: Optional error(s) (if computation for the group failed). items: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" type: array type: object FreeBusyRequest: properties: calendarExpansionMax: - description: Maximal number of calendars for which FreeBusy information + 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 + description: + 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. format: int32 @@ -3551,7 +3790,7 @@ components: items: description: List of calendars and/or groups to query. items: - $ref: '#/components/schemas/FreeBusyRequestItem' + $ref: "#/components/schemas/FreeBusyRequestItem" type: array timeMax: description: The end of the interval for the query formatted as per RFC3339. @@ -3576,13 +3815,13 @@ components: properties: calendars: additionalProperties: - $ref: '#/components/schemas/FreeBusyCalendar' + $ref: "#/components/schemas/FreeBusyCalendar" description: Free/busy expansions for a single calendar. description: List of free/busy information for calendars. type: object groups: additionalProperties: - $ref: '#/components/schemas/FreeBusyGroup' + $ref: "#/components/schemas/FreeBusyGroup" description: List of calendars that are members of this group. description: Expansion of groups. type: object @@ -3612,7 +3851,8 @@ components: description: Type of the resource ("calendar#setting"). type: string value: - description: Value of the user setting. The format of the value depends + description: + Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. type: string @@ -3625,18 +3865,20 @@ components: items: description: List of user settings. items: - $ref: '#/components/schemas/Setting' + $ref: "#/components/schemas/Setting" type: array kind: default: calendar#settings description: Type of the collection ("calendar#settings"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -3659,15 +3901,20 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: - https://www.googleapis.com/auth/calendar: See, edit, share, and permanently + https://www.googleapis.com/auth/calendar: + See, edit, share, and permanently delete all the calendars you can access using Google Calendar - https://www.googleapis.com/auth/calendar.events: View and edit events + https://www.googleapis.com/auth/calendar.events: + View and edit events on all your calendars - https://www.googleapis.com/auth/calendar.events.readonly: View events + https://www.googleapis.com/auth/calendar.events.readonly: + View events on all your calendars - https://www.googleapis.com/auth/calendar.readonly: See and download any + https://www.googleapis.com/auth/calendar.readonly: + See and download any calendar you can access using your Google Calendar - https://www.googleapis.com/auth/calendar.settings.readonly: View your + https://www.googleapis.com/auth/calendar.settings.readonly: + View your Calendar settings type: oauth2 Oauth2c: @@ -3676,15 +3923,20 @@ components: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: - https://www.googleapis.com/auth/calendar: See, edit, share, and permanently + https://www.googleapis.com/auth/calendar: + See, edit, share, and permanently delete all the calendars you can access using Google Calendar - https://www.googleapis.com/auth/calendar.events: View and edit events + https://www.googleapis.com/auth/calendar.events: + View and edit events on all your calendars - https://www.googleapis.com/auth/calendar.events.readonly: View events + https://www.googleapis.com/auth/calendar.events.readonly: + View events on all your calendars - https://www.googleapis.com/auth/calendar.readonly: See and download any + https://www.googleapis.com/auth/calendar.readonly: + See and download any calendar you can access using your Google Calendar - https://www.googleapis.com/auth/calendar.settings.readonly: View your + https://www.googleapis.com/auth/calendar.settings.readonly: + View your Calendar settings tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2 diff --git a/new.yml b/new.yml index 4f8f3bf..be3ddfa 100644 --- a/new.yml +++ b/new.yml @@ -1,6 +1,6 @@ openapi: 3.0.0 servers: -- url: https://www.googleapis.com/calendar/v3 + - url: https://www.googleapis.com/calendar/v3 info: contact: name: Google @@ -16,37 +16,37 @@ info: x-apiClientRegistration: url: https://console.developers.google.com x-apisguru-categories: - - analytics - - media + - analytics + - media x-logo: url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png x-origin: - - format: google - url: https://calendar-json.googleapis.com/$discovery/rest?version=v3 - version: v1 + - format: google + url: https://calendar-json.googleapis.com/$discovery/rest?version=v3 + version: v1 x-providerName: googleapis.com x-serviceName: calendar externalDocs: url: https://developers.google.com/google-apps/calendar/firstapp tags: -- name: acl -- name: calendarList -- name: calendars -- name: channels -- name: colors -- name: events -- name: freebusy -- name: settings + - name: acl + - name: calendarList + - name: calendars + - name: channels + - name: colors + - name: events + - name: freebusy + - name: settings paths: /calendars: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendar x-originalOperationId: calendar.calendars.insert @@ -55,149 +55,154 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}: delete: operationId: delete_calendar x-originalOperationId: calendar.calendars.delete - description: Deletes a secondary calendar. Use calendars.clear for clearing + description: + Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars get: operationId: get_calendar x-originalOperationId: calendar.calendars.get description: Returns metadata for a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendars + - calendars parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendar x-originalOperationId: calendar.calendars.patch description: Updates metadata for a calendar. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars put: operationId: update_calendar_entire x-originalOperationId: calendar.calendars.update description: Updates metadata for a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Calendar' + $ref: "#/components/schemas/Calendar" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}/acl: get: operationId: get_acl_rules @@ -211,387 +216,405 @@ paths: maxLimit: 250 description: Returns the rules in the access control list for the calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: '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. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Acl' + $ref: "#/components/schemas/Acl" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_acl_rule x-originalOperationId: calendar.acl.insert description: Creates an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Whether to send notifications about the calendar sharing change. - Optional. The default is True. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + Whether to send notifications about the calendar sharing change. + Optional. The default is True. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/acl/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_acl x-originalOperationId: calendar.acl.watch description: Watch for changes to ACL resources. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: '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. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/acl/{ruleId}: delete: operationId: delete_acl_rule x-originalOperationId: calendar.acl.delete description: Deletes an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl get: operationId: get_acl_rule x-originalOperationId: calendar.acl.get description: Returns an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - acl + - acl parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_acl_rule x-originalOperationId: calendar.acl.patch description: Updates an access control rule. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - 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. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + 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. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl put: operationId: update_acl_rule_all x-originalOperationId: calendar.acl.update description: Updates an access control rule. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: ACL rule identifier. - in: path - name: ruleId - required: true - schema: - 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. - in: query - name: sendNotifications - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: ACL rule identifier. + in: path + name: ruleId + required: true + schema: + 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. + in: query + name: sendNotifications + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - acl + - acl /calendars/{calendarId}/clear: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: clear_calendar x-originalOperationId: calendar.calendars.clear - description: Clears a primary calendar. This operation deletes all events associated + description: + Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendars + - calendars /calendars/{calendarId}/events: get: operationId: get_calendar_events @@ -605,919 +628,982 @@ paths: maxLimit: 250 description: Returns events on the specified calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - description: Specifies event ID in the iCalendar format to be included in - the response. Optional. - in: query - name: iCalUID - schema: - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The order of the events returned in the result. Optional. The - default is an unspecified, stable order. - in: query - name: orderBy - schema: - enum: - - startTime - - updated - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - explode: true - in: query - name: privateExtendedProperty - schema: - items: + - description: + 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. + in: path + name: calendarId + required: true + schema: type: string - type: array - style: form - - description: Free text search terms to find events that match these terms - in any field, except for extended properties. Optional. - in: query - name: q - schema: - type: string - - description: 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. - explode: true - in: query - name: sharedExtendedProperty - schema: - items: + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - description: + Specifies event ID in the iCalendar format to be included in + the response. Optional. + in: query + name: iCalUID + schema: + 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The order of the events returned in the result. Optional. The + default is an unspecified, stable order. + in: query + name: orderBy + schema: + enum: + - startTime + - updated + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + explode: true + in: query + name: privateExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + Free text search terms to find events that match these terms + in any field, except for extended properties. Optional. + in: query + name: q + schema: + type: string + - description: + 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. + explode: true + in: query + name: sharedExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + Whether to include hidden invitations in the result. Optional. + The default is False. + in: query + name: showHiddenInvitations + schema: + type: boolean + - description: + 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. + in: query + name: singleEvents + schema: + type: boolean + - description: + "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.\nThere are\ + \ several query parameters that cannot be specified together with nextSyncToken\ + \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ + - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ + - timeMin \n- timeMax \n- 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.\n\ + Learn more about incremental synchronization.\nOptional. The default is\ + \ to return all entries." + in: query + name: syncToken + schema: + type: string + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string + - description: + 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. + in: query + name: updatedMin + schema: type: string - type: array - style: form - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to include hidden invitations in the result. Optional. - The default is False. - in: query - name: showHiddenInvitations - schema: - type: boolean - - description: 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. - in: query - name: singleEvents - schema: - type: boolean - - description: "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.\nThere are\ - \ several query parameters that cannot be specified together with nextSyncToken\ - \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ - - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ - - timeMin \n- timeMax \n- 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.\n\ - Learn more about incremental synchronization.\nOptional. The default is\ - \ to return all entries." - in: query - name: syncToken - schema: - type: string - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string - - description: 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. - in: query - name: updatedMin - schema: - type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Events' + $ref: "#/components/schemas/Events" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendar_event x-originalOperationId: calendar.events.insert description: Creates an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Whether to send notifications about the creation of the new event. - Note that some emails might still be sent. The default is false. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Whether to send notifications about the creation of the new event. + Note that some emails might still be sent. The default is false. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/import: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: import_calendar_event x-originalOperationId: calendar.events.import - description: Imports an event. This operation is used to add a private copy + description: + Imports an event. This operation is used to add a private copy of an existing event to a calendar. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/quickAdd: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: quickAdd_calendar_event x-originalOperationId: calendar.events.quickAdd description: Creates an event based on a simple text string. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: The text describing the event to be created. - in: query - name: text - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: The text describing the event to be created. + in: query + name: text + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the creation of - the new event. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the creation of + the new event. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_calendar_events x-originalOperationId: calendar.events.watch description: Watch for changes to Events resources. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - description: Specifies event ID in the iCalendar format to be included in - the response. Optional. - in: query - name: iCalUID - schema: - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The order of the events returned in the result. Optional. The - default is an unspecified, stable order. - in: query - name: orderBy - schema: - enum: - - startTime - - updated - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - explode: true - in: query - name: privateExtendedProperty - schema: - items: + - description: + 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. + in: path + name: calendarId + required: true + schema: type: string - type: array - style: form - - description: Free text search terms to find events that match these terms - in any field, except for extended properties. Optional. - in: query - name: q - schema: - type: string - - description: 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. - explode: true - in: query - name: sharedExtendedProperty - schema: - items: + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - description: + Specifies event ID in the iCalendar format to be included in + the response. Optional. + in: query + name: iCalUID + schema: + 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The order of the events returned in the result. Optional. The + default is an unspecified, stable order. + in: query + name: orderBy + schema: + enum: + - startTime + - updated + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + explode: true + in: query + name: privateExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + Free text search terms to find events that match these terms + in any field, except for extended properties. Optional. + in: query + name: q + schema: + type: string + - description: + 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. + explode: true + in: query + name: sharedExtendedProperty + schema: + items: + type: string + type: array + style: form + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + Whether to include hidden invitations in the result. Optional. + The default is False. + in: query + name: showHiddenInvitations + schema: + type: boolean + - description: + 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. + in: query + name: singleEvents + schema: + type: boolean + - description: + "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.\nThere are\ + \ several query parameters that cannot be specified together with nextSyncToken\ + \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ + - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ + - timeMin \n- timeMax \n- 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.\n\ + Learn more about incremental synchronization.\nOptional. The default is\ + \ to return all entries." + in: query + name: syncToken + schema: + type: string + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string + - description: + 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. + in: query + name: updatedMin + schema: type: string - type: array - style: form - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to include hidden invitations in the result. Optional. - The default is False. - in: query - name: showHiddenInvitations - schema: - type: boolean - - description: 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. - in: query - name: singleEvents - schema: - type: boolean - - description: "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.\nThere are\ - \ several query parameters that cannot be specified together with nextSyncToken\ - \ to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n\ - - orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n\ - - timeMin \n- timeMax \n- 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.\n\ - Learn more about incremental synchronization.\nOptional. The default is\ - \ to return all entries." - in: query - name: syncToken - schema: - type: string - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string - - description: 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. - in: query - name: updatedMin - schema: - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events /calendars/{calendarId}/events/{eventId}: delete: operationId: delete_calendar_event x-originalOperationId: calendar.events.delete description: Deletes an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the deletion of - the event. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the deletion of + the event. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events get: operationId: get_calendar_event x-originalOperationId: calendar.events.get description: Returns an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendar_event x-originalOperationId: calendar.events.patch description: Updates an event. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the event update - (for example, title changes, etc.). - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the event update + (for example, title changes, etc.). + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events put: operationId: update_calendar_event_entire x-originalOperationId: calendar.events.update description: Updates an event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: conferenceDataVersion - schema: - maximum: 1 - minimum: 0 - type: integer - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 'Deprecated. Please use sendUpdates instead. + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: conferenceDataVersion + schema: + maximum: 1 + minimum: 0 + type: integer + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the event update - (for example, title changes, etc.). - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string - - description: Whether API client performing operation supports event attachments. - Optional. The default is False. - in: query - name: supportsAttachments - schema: - type: boolean + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the event update + (for example, title changes, etc.). + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string + - description: + Whether API client performing operation supports event attachments. + Optional. The default is False. + in: query + name: supportsAttachments + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /calendars/{calendarId}/events/{eventId}/instances: get: operationId: get_calendar_event_instances @@ -1531,195 +1617,206 @@ paths: maxLimit: 250 description: Returns instances of the specified recurring event. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string - - description: Recurring event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: 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). - in: query - name: alwaysIncludeEmail - schema: - type: boolean - - 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 - name: maxAttendees - schema: - minimum: 1 - type: integer - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The original start time of the instance in the result. Optional. - in: query - name: originalStart - schema: - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: 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. - in: query - name: showDeleted - schema: - type: boolean - - description: 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. - in: query - name: timeMax - schema: - type: string - - description: 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. - in: query - name: timeMin - schema: - type: string - - description: Time zone used in the response. Optional. The default is the - time zone of the calendar. - in: query - name: timeZone - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string + - description: Recurring event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + 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). + in: query + name: alwaysIncludeEmail + schema: + type: boolean + - 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 + name: maxAttendees + schema: + minimum: 1 + type: integer + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: The original start time of the instance in the result. Optional. + in: query + name: originalStart + schema: + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + 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. + in: query + name: showDeleted + schema: + type: boolean + - description: + 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. + in: query + name: timeMax + schema: + type: string + - description: + 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. + in: query + name: timeMin + schema: + type: string + - description: + Time zone used in the response. Optional. The default is the + time zone of the calendar. + in: query + name: timeZone + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Events' + $ref: "#/components/schemas/Events" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - events + - events parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /calendars/{calendarId}/events/{eventId}/move: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: move_calendar_event x-originalOperationId: calendar.events.move description: Moves an event to another calendar, i.e. changes an event's organizer. parameters: - - description: Calendar identifier of the source calendar where the event currently - is on. - in: path - name: calendarId - required: true - schema: - type: string - - description: Event identifier. - in: path - name: eventId - required: true - schema: - type: string - - description: Calendar identifier of the target calendar where the event is - to be moved to. - in: query - name: destination - required: true - schema: - type: string - - description: 'Deprecated. Please use sendUpdates instead. + - description: + Calendar identifier of the source calendar where the event currently + is on. + in: path + name: calendarId + required: true + schema: + type: string + - description: Event identifier. + in: path + name: eventId + required: true + schema: + type: string + - description: + Calendar identifier of the target calendar where the event is + to be moved to. + in: query + name: destination + required: true + schema: + type: string + - description: "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.' - in: query - name: sendNotifications - schema: - type: boolean - - description: Guests who should receive notifications about the change of the - event's organizer. - in: query - name: sendUpdates - schema: - enum: - - all - - externalOnly - - none - type: string + 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." + in: query + name: sendNotifications + schema: + type: boolean + - description: + Guests who should receive notifications about the change of the + event's organizer. + in: query + name: sendUpdates + schema: + enum: + - all + - externalOnly + - none + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events tags: - - events + - events /channels/stop: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: stop_channel x-originalOperationId: calendar.channels.stop @@ -1728,73 +1825,73 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.events - Oauth2c: - - https://www.googleapis.com/auth/calendar.events - - Oauth2: - - https://www.googleapis.com/auth/calendar.events.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.events.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.events + Oauth2c: + - https://www.googleapis.com/auth/calendar.events + - Oauth2: + - https://www.googleapis.com/auth/calendar.events.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.events.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - channels + - channels /colors: get: operationId: get_calendar_colors x-originalOperationId: calendar.colors.get description: Returns the color definitions for calendars and events. responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Colors' + $ref: "#/components/schemas/Colors" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - colors + - colors parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /freeBusy: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: get_calendars_freebusy x-originalOperationId: calendar.freebusy.query @@ -1803,25 +1900,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FreeBusyRequest' + $ref: "#/components/schemas/FreeBusyRequest" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FreeBusyResponse' + $ref: "#/components/schemas/FreeBusyResponse" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - freebusy + - freebusy /users/me/calendarList: get: operationId: get_calendarlist @@ -1835,359 +1932,375 @@ paths: maxLimit: 250 description: Returns the calendars on the user's calendar list. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The minimum access role for the user in the returned entries. - Optional. The default is no restriction. - in: query - name: minAccessRole - schema: - enum: - - freeBusyReader - - owner - - reader - - writer - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: Whether to include deleted calendar list entries in the result. - Optional. The default is False. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to show hidden entries. Optional. The default is False. - in: query - name: showHidden - schema: - type: boolean - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The minimum access role for the user in the returned entries. + Optional. The default is no restriction. + in: query + name: minAccessRole + schema: + enum: + - freeBusyReader + - owner + - reader + - writer + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + Whether to include deleted calendar list entries in the result. + Optional. The default is False. + in: query + name: showDeleted + schema: + type: boolean + - description: Whether to show hidden entries. Optional. The default is False. + in: query + name: showHidden + schema: + type: boolean + - description: + "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. + 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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarList' + $ref: "#/components/schemas/CalendarList" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: create_calendarlist_entry x-originalOperationId: calendar.calendarList.insert description: Inserts an existing calendar into the user's calendar list. parameters: - - 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 - schema: - type: boolean + - 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList /users/me/calendarList/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_calendarlist x-originalOperationId: calendar.calendarList.watch description: Watch for changes to CalendarList resources. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: The minimum access role for the user in the returned entries. - Optional. The default is no restriction. - in: query - name: minAccessRole - schema: - enum: - - freeBusyReader - - owner - - reader - - writer - type: string - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: Whether to include deleted calendar list entries in the result. - Optional. The default is False. - in: query - name: showDeleted - schema: - type: boolean - - description: Whether to show hidden entries. Optional. The default is False. - in: query - name: showHidden - schema: - type: boolean - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: + The minimum access role for the user in the returned entries. + Optional. The default is no restriction. + in: query + name: minAccessRole + schema: + enum: + - freeBusyReader + - owner + - reader + - writer + type: string + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + Whether to include deleted calendar list entries in the result. + Optional. The default is False. + in: query + name: showDeleted + schema: + type: boolean + - description: Whether to show hidden entries. Optional. The default is False. + in: query + name: showHidden + schema: + type: boolean + - description: + "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. + 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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList /users/me/calendarList/{calendarId}: delete: operationId: delete_calendarlist_entry x-originalOperationId: calendar.calendarList.delete description: Removes a calendar from the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList get: operationId: get_calendarlist_entry x-originalOperationId: calendar.calendarList.get description: Returns a calendar from the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - type: string + - description: + 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. + in: path + name: calendarId + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly tags: - - calendarList + - calendarList parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" patch: operationId: update_calendarlist_entry x-originalOperationId: calendar.calendarList.patch - description: Updates an existing calendar on the user's calendar list. This + description: + Updates an existing calendar on the user's calendar list. This method supports patch semantics. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList put: operationId: update_calendarlist_entry_entire x-originalOperationId: calendar.calendarList.update description: Updates an existing calendar on the user's calendar list. parameters: - - description: 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. - in: path - name: calendarId - required: true - schema: - 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 - schema: - type: boolean + - description: + 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. + in: path + name: calendarId + required: true + schema: + 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 + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar tags: - - calendarList + - calendarList /users/me/settings: get: operationId: get_my_settings @@ -2201,175 +2314,179 @@ paths: maxLimit: 250 description: Returns all user settings for the authenticated user. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" /users/me/settings/watch: parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" post: operationId: watch_settings x-originalOperationId: calendar.settings.watch description: Watch for changes to Settings resources. parameters: - - description: 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. - in: query - name: maxResults - schema: - minimum: 1 - type: integer - - description: Token specifying which result page to return. Optional. - in: query - name: pageToken - schema: - type: string - - description: '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. + - description: + 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. + in: query + name: maxResults + schema: + minimum: 1 + type: integer + - description: Token specifying which result page to return. Optional. + in: query + name: pageToken + schema: + type: string + - description: + "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. + 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. + Learn more about incremental synchronization. - Optional. The default is to return all entries.' - in: query - name: syncToken - schema: - type: string + Optional. The default is to return all entries." + in: query + name: syncToken + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Channel' + $ref: "#/components/schemas/Channel" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings /users/me/settings/{setting}: get: operationId: get_setting x-originalOperationId: calendar.settings.get description: Returns a single user setting. parameters: - - description: The id of the user setting. - in: path - name: setting - required: true - schema: - type: string + - description: The id of the user setting. + in: path + name: setting + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Setting' + $ref: "#/components/schemas/Setting" description: Successful response security: - - Oauth2: - - https://www.googleapis.com/auth/calendar - Oauth2c: - - https://www.googleapis.com/auth/calendar - - Oauth2: - - https://www.googleapis.com/auth/calendar.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.readonly - - Oauth2: - - https://www.googleapis.com/auth/calendar.settings.readonly - Oauth2c: - - https://www.googleapis.com/auth/calendar.settings.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar + Oauth2c: + - https://www.googleapis.com/auth/calendar + - Oauth2: + - https://www.googleapis.com/auth/calendar.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.readonly + - Oauth2: + - https://www.googleapis.com/auth/calendar.settings.readonly + Oauth2c: + - https://www.googleapis.com/auth/calendar.settings.readonly tags: - - settings + - settings parameters: - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/userIp' + - $ref: "#/components/parameters/alt" + - $ref: "#/components/parameters/fields" + - $ref: "#/components/parameters/key" + - $ref: "#/components/parameters/oauth_token" + - $ref: "#/components/parameters/prettyPrint" + - $ref: "#/components/parameters/quotaUser" + - $ref: "#/components/parameters/userIp" components: parameters: alt: @@ -2378,7 +2495,7 @@ components: name: alt schema: enum: - - json + - json type: string fields: description: Selector specifying which fields to include in a partial response. @@ -2387,7 +2504,8 @@ components: schema: type: string key: - description: API key. Your API key identifies your project and provides you + description: + API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query @@ -2407,7 +2525,8 @@ components: schema: type: boolean quotaUser: - description: An opaque string that represents a user for quota purposes. Must + description: + An opaque string that represents a user for quota purposes. Must not exceed 40 characters. in: query name: quotaUser @@ -2428,18 +2547,20 @@ components: items: description: List of rules on the access control list. items: - $ref: '#/components/schemas/AclRule' + $ref: "#/components/schemas/AclRule" type: array kind: default: calendar#acl description: Type of the collection ("calendar#acl"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -2450,7 +2571,8 @@ components: description: ETag of the resource. type: string id: - description: Identifier of the Access Control List (ACL) rule. See Sharing + description: + Identifier of the Access Control List (ACL) rule. See Sharing calendars. type: string kind: @@ -2458,7 +2580,8 @@ components: description: Type of the resource ("calendar#aclRule"). type: string role: - description: "The role assigned to the scope. Possible values are: \n-\ + description: + "The role assigned to the scope. Possible values are: \n-\ \ \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read\ \ access to free/busy information. \n- \"reader\" - Provides read access\ \ to the calendar. Private events will appear to users with reader access,\ @@ -2469,11 +2592,13 @@ components: \ writer role with the additional ability to see and manipulate ACLs." type: string scope: - description: The extent to which calendar access is granted by this ACL + description: + The extent to which calendar access is granted by this ACL rule. properties: type: - description: "The type of the scope. Possible values are: \n- \"default\"\ + description: + "The type of the scope. Possible values are: \n- \"default\"\ \ - The public scope. This is the default value. \n- \"user\" - Limits\ \ the scope to a single user. \n- \"group\" - Limits the scope to\ \ a group. \n- \"domain\" - Limits the scope to a domain. Note: The\ @@ -2481,7 +2606,8 @@ components: \ any user, authenticated or not." type: string value: - description: The email address of a user or group, or the name of a + description: + The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default". type: string type: object @@ -2489,8 +2615,9 @@ components: Calendar: properties: conferenceProperties: - $ref: '#/components/schemas/ConferenceProperties' - description: Conferencing properties for this calendar, for example what + $ref: "#/components/schemas/ConferenceProperties" + description: + Conferencing properties for this calendar, for example what types of conferences are allowed. description: description: Description of the calendar. Optional. @@ -2499,7 +2626,8 @@ components: description: ETag of the resource. type: string id: - description: Identifier of the calendar. To retrieve IDs call the calendarList.list() + description: + Identifier of the calendar. To retrieve IDs call the calendarList.list() method. type: string kind: @@ -2513,7 +2641,8 @@ components: description: Title of the calendar. type: string timeZone: - description: The time zone of the calendar. (Formatted as an IANA Time Zone + description: + The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. type: string type: object @@ -2525,18 +2654,20 @@ components: items: description: Calendars that are present on the user's calendar list. items: - $ref: '#/components/schemas/CalendarListEntry' + $ref: "#/components/schemas/CalendarListEntry" type: array kind: default: calendar#calendarList description: Type of the collection ("calendar#calendarList"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -2544,7 +2675,8 @@ components: CalendarListEntry: properties: accessRole: - description: "The effective access role that the authenticated user has\ + description: + "The effective access role that the authenticated user has\ \ on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\"\ \ - Provides read access to free/busy information. \n- \"reader\" - Provides\ \ read access to the calendar. Private events will appear to users with\ @@ -2556,30 +2688,35 @@ components: \ manipulate ACLs." type: string backgroundColor: - description: The main color of the calendar in the hexadecimal format "#0088aa". + description: + 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. type: string colorId: - description: The color of the calendar. This is an ID referring to an entry + description: + 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. type: string conferenceProperties: - $ref: '#/components/schemas/ConferenceProperties' - description: Conferencing properties for this calendar, for example what + $ref: "#/components/schemas/ConferenceProperties" + description: + Conferencing properties for this calendar, for example what types of conferences are allowed. defaultReminders: - description: The default reminders that the authenticated user has for this + description: + The default reminders that the authenticated user has for this calendar. items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array deleted: default: false - description: Whether this calendar list entry has been deleted from the + description: + Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. type: boolean description: @@ -2589,14 +2726,16 @@ components: description: ETag of the resource. type: string foregroundColor: - description: The foreground color of the calendar in the hexadecimal format + description: + 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. type: string hidden: default: false - description: Whether the calendar has been hidden from the list. Optional. + description: + 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. type: boolean @@ -2608,34 +2747,39 @@ components: description: Type of the resource ("calendar#calendarListEntry"). type: string location: - description: Geographic location of the calendar as free-form text. Optional. + description: + Geographic location of the calendar as free-form text. Optional. Read-only. type: string notificationSettings: - description: The notifications that the authenticated user is receiving + description: + The notifications that the authenticated user is receiving for this calendar. properties: notifications: description: The list of notifications set for this calendar. items: - $ref: '#/components/schemas/CalendarNotification' + $ref: "#/components/schemas/CalendarNotification" type: array type: object primary: default: false - description: Whether the calendar is the primary calendar of the authenticated + description: + Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. type: boolean selected: default: false - description: Whether the calendar content shows up in the calendar UI. Optional. + description: + Whether the calendar content shows up in the calendar UI. Optional. The default is False. type: boolean summary: description: Title of the calendar. Read-only. type: string summaryOverride: - description: The summary that the authenticated user has set for this calendar. + description: + The summary that the authenticated user has set for this calendar. Optional. type: string timeZone: @@ -2645,12 +2789,14 @@ components: CalendarNotification: properties: method: - description: "The method used to deliver the notification. The possible\ + description: + "The method used to deliver the notification. The possible\ \ value is: \n- \"email\" - Notifications are sent via email. \nRequired\ \ when adding a notification." type: string type: - description: "The type of notification. Possible values are: \n- \"eventCreation\"\ + description: + "The type of notification. Possible values are: \n- \"eventCreation\"\ \ - Notification sent when a new event is put on the calendar. \n- \"\ eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\"\ \ - Notification sent when an event is cancelled. \n- \"eventResponse\"\ @@ -2665,7 +2811,8 @@ components: description: The address where notifications are delivered for this channel. type: string expiration: - description: Date and time of notification channel expiration, expressed + description: + Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. format: int64 type: string @@ -2674,32 +2821,37 @@ components: type: string kind: default: api#channel - description: Identifies this as a notification channel used to watch for + description: + Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". type: string params: additionalProperties: description: Declares a new parameter by name. type: string - description: Additional parameters controlling delivery channel behavior. + description: + Additional parameters controlling delivery channel behavior. Optional. type: object payload: description: A Boolean value to indicate whether payload is wanted. Optional. type: boolean resourceId: - description: An opaque ID that identifies the resource being watched on + description: + An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. type: string resourceUri: description: A version-specific identifier for the watched resource. type: string token: - description: An arbitrary string delivered to the target address with each + description: + An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. type: string type: - description: The type of delivery mechanism used for this channel. Valid + description: + 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. type: string @@ -2710,7 +2862,8 @@ components: description: The background color associated with this color definition. type: string foreground: - description: The foreground color that can be used to write on top of a + description: + The foreground color that can be used to write on top of a background with 'background' color. type: string type: object @@ -2718,17 +2871,19 @@ components: properties: calendar: additionalProperties: - $ref: '#/components/schemas/ColorDefinition' + $ref: "#/components/schemas/ColorDefinition" description: A calendar color definition. - description: A global palette of calendar colors, mapping from the color + description: + A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only. type: object event: additionalProperties: - $ref: '#/components/schemas/ColorDefinition' + $ref: "#/components/schemas/ColorDefinition" description: An event color definition. - description: A global palette of event colors, mapping from the color ID + description: + A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only. type: object @@ -2737,7 +2892,8 @@ components: description: Type of the resource ("calendar#colors"). type: string updated: - description: Last modification time of the color palette (as a RFC3339 timestamp). + description: + Last modification time of the color palette (as a RFC3339 timestamp). Read-only. format: date-time type: string @@ -2745,7 +2901,8 @@ components: ConferenceData: properties: conferenceId: - description: "The ID of the conference.\nCan be used by developers to keep\ + description: + "The ID of the conference.\nCan be used by developers to keep\ \ track of conferences, should not be displayed to users.\nThe ID value\ \ is formed differently for each conference solution type: \n- eventHangout:\ \ ID is not set. (This conference type is deprecated.)\n- eventNamedHangout:\ @@ -2754,55 +2911,59 @@ components: - addOn: ID is defined by the third-party provider. Optional." type: string conferenceSolution: - $ref: '#/components/schemas/ConferenceSolution' - description: 'The conference solution, such as Google Meet. + $ref: "#/components/schemas/ConferenceSolution" + description: "The conference solution, such as Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." createRequest: - $ref: '#/components/schemas/CreateConferenceRequest' - description: 'A request to generate a new conference and attach it to the + $ref: "#/components/schemas/CreateConferenceRequest" + description: + "A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." entryPoints: - description: 'Information about individual conference entry points, such + description: + "Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest - is required.' + is required." items: - $ref: '#/components/schemas/EntryPoint' + $ref: "#/components/schemas/EntryPoint" type: array notes: - description: Additional notes (such as instructions from the domain administrator, + description: + Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. type: string parameters: - $ref: '#/components/schemas/ConferenceParameters' - description: Additional properties related to a conference. An example would + $ref: "#/components/schemas/ConferenceParameters" + description: + Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. signature: - description: 'The signature of the conference data. + description: "The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. - Optional for a conference with a pending create request.' + Optional for a conference with a pending create request." type: string type: object ConferenceParameters: properties: addOnParameters: - $ref: '#/components/schemas/ConferenceParametersAddOnParameters' + $ref: "#/components/schemas/ConferenceParametersAddOnParameters" description: Additional add-on specific data. type: object ConferenceParametersAddOnParameters: @@ -2815,7 +2976,8 @@ components: ConferenceProperties: properties: allowedConferenceSolutionTypes: - description: "The types of conference solutions that are supported for this\ + description: + "The types of conference solutions that are supported for this\ \ calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\"\ \ \n- \"hangoutsMeet\" Optional." items: @@ -2825,7 +2987,8 @@ components: ConferenceRequestStatus: properties: statusCode: - description: "The current status of the conference create request. Read-only.\n\ + description: + "The current status of the conference create request. Read-only.\n\ The possible values are: \n- \"pending\": the conference create request\ \ is still being processed.\n- \"success\": the conference create request\ \ succeeded, the entry points are populated.\n- \"failure\": the conference\ @@ -2838,8 +3001,9 @@ components: description: The user-visible icon for this solution. type: string key: - $ref: '#/components/schemas/ConferenceSolutionKey' - description: The key which can uniquely identify the conference solution + $ref: "#/components/schemas/ConferenceSolutionKey" + description: + The key which can uniquely identify the conference solution for this event. name: description: The user-visible name of this solution. Not localized. @@ -2848,7 +3012,8 @@ components: ConferenceSolutionKey: properties: type: - description: "The conference solution type.\nIf a client encounters an unfamiliar\ + description: + "The conference solution type.\nIf a client encounters an unfamiliar\ \ or empty type, it should still be able to display the entry points.\ \ However, it should disallow modifications.\nThe possible values are:\ \ \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing\ @@ -2863,22 +3028,23 @@ components: CreateConferenceRequest: properties: conferenceSolutionKey: - $ref: '#/components/schemas/ConferenceSolutionKey' + $ref: "#/components/schemas/ConferenceSolutionKey" description: The conference solution, such as Hangouts or Google Meet. requestId: - description: 'The client-generated unique ID for this request. + description: "The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided - is the same as for the previous request, the request is ignored.' + is the same as for the previous request, the request is ignored." type: string status: - $ref: '#/components/schemas/ConferenceRequestStatus' + $ref: "#/components/schemas/ConferenceRequestStatus" description: The status of the conference create request. type: object EntryPoint: properties: accessCode: - description: 'The access code to access the conference. The maximum length + description: + "The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2886,17 +3052,19 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string entryPointFeatures: - description: Features of the entry point, such as being toll or toll-free. + 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.\nPossible values are:\ + description: + "The type of the conference entry point.\nPossible values are:\ \ \n- \"video\" - joining a conference over HTTP. A conference can have\ \ zero or one video entry point.\n- \"phone\" - joining a conference by\ \ dialing a phone number. A conference can have zero or more phone entry\ @@ -2907,13 +3075,15 @@ components: \ point is not a valid conference." type: string label: - description: "The label for the URI. Visible to end users. Not localized.\ + description: + "The label for the URI. Visible to end users. Not localized.\ \ The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n\ - for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for\ \ more: should not be filled \nOptional." type: string meetingCode: - description: 'The meeting code to access the conference. The maximum length + description: + "The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2921,19 +3091,21 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string passcode: - description: 'The passcode to access the conference. The maximum length + description: + "The passcode to access the conference. The maximum length is 128 characters. 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.' + displayed." type: string password: - description: 'The password to access the conference. The maximum length + description: + "The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2941,10 +3113,11 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string pin: - description: 'The PIN to access the conference. The maximum length is 128 + description: + "The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, @@ -2952,16 +3125,18 @@ components: that the conference provider uses. Only the populated fields should be displayed. - Optional.' + Optional." type: string regionCode: - description: 'The CLDR/ISO 3166 region code for the country associated with + 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.\n\ + description: + "The URI of the entry point. The maximum length is 1300 characters.\n\ Format: \n- for video, http: or https: schema is required.\n- for phone,\ \ tel: schema is required. The URI should include the entire dial sequence\ \ (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is\ @@ -2975,7 +3150,8 @@ components: description: Domain, or broad category, of the error. type: string reason: - description: "Specific reason for the error. Some of the possible values\ + description: + "Specific reason for the error. Some of the possible values\ \ are: \n- \"groupTooBig\" - The group of users requested is too large\ \ for a single query. \n- \"tooManyCalendarsRequested\" - The number of\ \ calendars requested is too large for a single query. \n- \"notFound\"\ @@ -2989,43 +3165,49 @@ components: properties: anyoneCanAddSelf: default: false - description: Whether anyone can invite themselves to the event (deprecated). + description: + Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. type: boolean attachments: - description: 'File attachments for the event. Currently only Google Drive + description: + "File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. - There can be at most 25 attachments per event,' + There can be at most 25 attachments per event," items: - $ref: '#/components/schemas/EventAttachment' + $ref: "#/components/schemas/EventAttachment" type: array attendees: - description: The attendees of the event. See the Events with attendees guide + description: + 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. items: - $ref: '#/components/schemas/EventAttendee' + $ref: "#/components/schemas/EventAttendee" type: array attendeesOmitted: default: false - description: Whether attendees may have been omitted from the event's representation. + description: + 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. type: boolean colorId: - description: The color of the event. This is an ID referring to an entry + description: + 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. type: string conferenceData: - $ref: '#/components/schemas/ConferenceData' - description: The conference-related information, such as details of a Google + $ref: "#/components/schemas/ConferenceData" + description: + The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. @@ -3047,7 +3229,8 @@ components: type: string self: default: false - description: Whether the creator corresponds to the calendar on which + description: + Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object @@ -3055,12 +3238,14 @@ components: description: Description of the event. Can contain HTML. Optional. type: string end: - $ref: '#/components/schemas/EventDateTime' - description: The (exclusive) end time of the event. For a recurring event, + $ref: "#/components/schemas/EventDateTime" + description: + The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. endTimeUnspecified: default: false - description: Whether the end time is actually unspecified. An end time is + description: + 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. type: boolean @@ -3069,7 +3254,8 @@ components: type: string eventType: default: default - description: "Specific type of the event. Read-only. Possible values are:\ + description: + "Specific type of the event. Read-only. Possible values are:\ \ \n- \"default\" - A regular event or not further specified. \n- \"\ outOfOffice\" - An out-of-office event. \n- \"focusTime\" - A focus-time\ \ event." @@ -3079,33 +3265,40 @@ components: properties: private: additionalProperties: - description: The name of the private property and the corresponding + description: + The name of the private property and the corresponding value. type: string - description: Properties that are private to the copy of the event that + description: + Properties that are private to the copy of the event that appears on this calendar. type: object shared: additionalProperties: - description: The name of the shared property and the corresponding + description: + The name of the shared property and the corresponding value. type: string - description: Properties that are shared between copies of the event + description: + Properties that are shared between copies of the event on other attendees' calendars. type: object type: object gadget: - description: A gadget that extends this event. Gadgets are deprecated; this + description: + A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. properties: display: - description: "The gadget's display mode. Deprecated. Possible values\ + description: + "The gadget's display mode. Deprecated. Possible values\ \ are: \n- \"icon\" - The gadget displays next to the event's title\ \ in the calendar view. \n- \"chip\" - The gadget displays when the\ \ event is clicked." type: string height: - description: The gadget's height in pixels. The height must be an integer + description: + The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. format: int32 type: integer @@ -3128,46 +3321,54 @@ components: description: The gadget's type. Deprecated. type: string width: - description: The gadget's width in pixels. The width must be an integer + description: + The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. format: int32 type: integer type: object guestsCanInviteOthers: default: true - description: Whether attendees other than the organizer can invite others + description: + Whether attendees other than the organizer can invite others to the event. Optional. The default is True. type: boolean guestsCanModify: default: false - description: Whether attendees other than the organizer can modify the event. + description: + Whether attendees other than the organizer can modify the event. Optional. The default is False. type: boolean guestsCanSeeOtherGuests: default: true - description: Whether attendees other than the organizer can see who the + description: + Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. type: boolean hangoutLink: - description: An absolute link to the Google Hangout associated with this + description: + An absolute link to the Google Hangout associated with this event. Read-only. type: string htmlLink: - description: An absolute link to this event in the Google Calendar Web UI. + description: + An absolute link to this event in the Google Calendar Web UI. Read-only. type: string iCalUID: - description: 'Event unique identifier as defined in RFC5545. It is used + description: + "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.' + ids while they all share the same icalUIDs." type: string id: - description: "Opaque identifier of the event. When creating new single or\ + description: + "Opaque identifier of the event. When creating new single or\ \ recurring events, you can specify their IDs. Provided IDs must follow\ \ these rules: \n- 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\ @@ -3191,12 +3392,14 @@ components: type: string locked: default: false - description: Whether this is a locked event copy where no changes can be + description: + 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. type: boolean organizer: - description: The organizer of the event. If the organizer is also an attendee, + description: + 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. @@ -3205,7 +3408,8 @@ components: description: The organizer's name, if available. type: string email: - description: The organizer's email address, if available. It must be + description: + The organizer's email address, if available. It must be a valid email address as per RFC5322. type: string id: @@ -3213,25 +3417,29 @@ components: type: string self: default: false - description: Whether the organizer corresponds to the calendar on which + description: + Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object originalStartTime: - $ref: '#/components/schemas/EventDateTime' - description: For an instance of a recurring event, this is the time at which + $ref: "#/components/schemas/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. 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: If set to True, Event propagation is disabled. Note that it + description: + 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. type: boolean recurrence: - description: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring + description: + 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 @@ -3240,23 +3448,27 @@ components: type: string type: array recurringEventId: - description: For an instance of a recurring event, this is the id of the + description: + For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. type: string reminders: - description: Information about the event's reminders for the authenticated + description: + Information about the event's reminders for the authenticated user. properties: overrides: - description: If the event doesn't use the default reminders, this lists + description: + If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array useDefault: - description: Whether the default reminders of the calendar apply to + description: + Whether the default reminders of the calendar apply to the event. type: boolean type: object @@ -3265,25 +3477,30 @@ components: format: int32 type: integer source: - description: Source from which the event was created. For example, a web + description: + 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. properties: title: - description: Title of the source; for example a title of a web page + description: + Title of the source; for example a title of a web page or an email subject. type: string url: - description: URL of the source pointing to a resource. The URL scheme + description: + URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. type: string type: object start: - $ref: '#/components/schemas/EventDateTime' - description: The (inclusive) start time of the event. For a recurring event, + $ref: "#/components/schemas/EventDateTime" + description: + The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. status: - description: "Status of the event. Optional. Possible values are: \n- \"\ + description: + "Status of the event. Optional. Possible values are: \n- \"\ confirmed\" - The event is confirmed. This is the default status. \n-\ \ \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\"\ \ - The event is cancelled (deleted). The list method returns cancelled\ @@ -3314,7 +3531,8 @@ components: type: string transparency: default: opaque - description: "Whether the event blocks time on the calendar. Optional. Possible\ + description: + "Whether the event blocks time on the calendar. Optional. Possible\ \ values are: \n- \"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. \n- \"transparent\" - The event does not block time\ @@ -3322,13 +3540,15 @@ components: \ in the Calendar UI." type: string updated: - description: Last modification time of the event (as a RFC3339 timestamp). + description: + Last modification time of the event (as a RFC3339 timestamp). Read-only. format: date-time type: string visibility: default: default - description: "Visibility of the event. Optional. Possible values are: \n\ + description: + "Visibility of the event. Optional. Possible values are: \n\ - \"default\" - Uses the default visibility for events on the calendar.\ \ This is the default value. \n- \"public\" - The event is public and\ \ event details are visible to all readers of the calendar. \n- \"private\"\ @@ -3340,18 +3560,18 @@ components: EventAttachment: properties: fileId: - description: 'ID of the attached file. Read-only. + description: "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.' + entry in the Drive API." type: string fileUrl: - description: 'URL link to the attachment. + 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. - Required when adding an attachment.' + Required when adding an attachment." type: string iconLink: description: URL link to the attachment's icon. Read-only. @@ -3377,32 +3597,37 @@ components: description: The attendee's name, if available. Optional. type: string email: - description: 'The attendee''s email address, if available. This field must + 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. - Required when adding an attendee.' + Required when adding an attendee." type: string id: description: The attendee's Profile ID, if available. type: string optional: default: false - description: Whether this is an optional attendee. Optional. The default + description: + Whether this is an optional attendee. Optional. The default is False. type: boolean organizer: - description: Whether the attendee is the organizer of the event. Read-only. + description: + Whether the attendee is the organizer of the event. Read-only. The default is False. type: boolean resource: default: false - description: Whether the attendee is a resource. Can only be set when the + description: + Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. type: boolean responseStatus: - description: "The attendee's response status. Possible values are: \n-\ + description: + "The attendee's response status. Possible values are: \n-\ \ \"needsAction\" - The attendee has not responded to the invitation.\ \ \n- \"declined\" - The attendee has declined the invitation. \n- \"\ tentative\" - The attendee has tentatively accepted the invitation. \n\ @@ -3410,25 +3635,29 @@ components: type: string self: default: false - description: Whether this entry represents the calendar on which this copy + description: + Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. type: boolean type: object EventDateTime: properties: date: - description: The date, in the format "yyyy-mm-dd", if this is an all-day + description: + The date, in the format "yyyy-mm-dd", if this is an all-day event. format: date type: string dateTime: - description: The time, as a combined date-time value (formatted according + description: + The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. format: date-time type: string timeZone: - description: The time zone in which the time is specified. (Formatted as + description: + The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates @@ -3438,22 +3667,25 @@ components: EventReminder: properties: method: - description: "The method used by this reminder. Possible values are: \n\ + description: + "The method used by this reminder. Possible values are: \n\ - \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders\ \ are sent via a UI popup. \nRequired when adding a reminder." type: string minutes: - description: 'Number of minutes before the start of the event when the reminder + description: + "Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). - Required when adding a reminder.' + Required when adding a reminder." format: int32 type: integer type: object Events: properties: accessRole: - description: "The user's access role for this calendar. Read-only. Possible\ + description: + "The user's access role for this calendar. Read-only. Possible\ \ values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\"\ \ - The user has read access to free/busy information. \n- \"reader\"\ \ - The user has read access to the calendar. Private events will appear\ @@ -3465,12 +3697,13 @@ components: \ ability to see and manipulate ACLs." type: string defaultReminders: - description: The default reminders on the calendar for the authenticated + description: + The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). items: - $ref: '#/components/schemas/EventReminder' + $ref: "#/components/schemas/EventReminder" type: array description: description: Description of the calendar. Read-only. @@ -3481,18 +3714,20 @@ components: items: description: List of events on the calendar. items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" type: array kind: default: calendar#events description: Type of the collection ("calendar#events"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -3503,7 +3738,8 @@ components: description: The time zone of the calendar. Read-only. type: string updated: - description: Last modification time of the calendar (as a RFC3339 timestamp). + description: + Last modification time of the calendar (as a RFC3339 timestamp). Read-only. format: date-time type: string @@ -3511,15 +3747,16 @@ components: FreeBusyCalendar: properties: busy: - description: List of time ranges during which this calendar should be regarded + description: + List of time ranges during which this calendar should be regarded as busy. items: - $ref: '#/components/schemas/TimePeriod' + $ref: "#/components/schemas/TimePeriod" type: array errors: description: Optional error(s) (if computation for the calendar failed). items: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" type: array type: object FreeBusyGroup: @@ -3532,18 +3769,20 @@ components: errors: description: Optional error(s) (if computation for the group failed). items: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" type: array type: object FreeBusyRequest: properties: calendarExpansionMax: - description: Maximal number of calendars for which FreeBusy information + 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 + description: + 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. format: int32 @@ -3551,7 +3790,7 @@ components: items: description: List of calendars and/or groups to query. items: - $ref: '#/components/schemas/FreeBusyRequestItem' + $ref: "#/components/schemas/FreeBusyRequestItem" type: array timeMax: description: The end of the interval for the query formatted as per RFC3339. @@ -3576,13 +3815,13 @@ components: properties: calendars: additionalProperties: - $ref: '#/components/schemas/FreeBusyCalendar' + $ref: "#/components/schemas/FreeBusyCalendar" description: Free/busy expansions for a single calendar. description: List of free/busy information for calendars. type: object groups: additionalProperties: - $ref: '#/components/schemas/FreeBusyGroup' + $ref: "#/components/schemas/FreeBusyGroup" description: List of calendars that are members of this group. description: Expansion of groups. type: object @@ -3612,7 +3851,8 @@ components: description: Type of the resource ("calendar#setting"). type: string value: - description: Value of the user setting. The format of the value depends + description: + Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. type: string @@ -3625,18 +3865,20 @@ components: items: description: List of user settings. items: - $ref: '#/components/schemas/Setting' + $ref: "#/components/schemas/Setting" type: array kind: default: calendar#settings description: Type of the collection ("calendar#settings"). type: string nextPageToken: - description: Token used to access the next page of this result. Omitted + description: + Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. type: string nextSyncToken: - description: Token used at a later point in time to retrieve only the entries + description: + Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. type: string @@ -3659,15 +3901,20 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: - https://www.googleapis.com/auth/calendar: See, edit, share, and permanently + https://www.googleapis.com/auth/calendar: + See, edit, share, and permanently delete all the calendars you can access using Google Calendar - https://www.googleapis.com/auth/calendar.events: View and edit events + https://www.googleapis.com/auth/calendar.events: + View and edit events on all your calendars - https://www.googleapis.com/auth/calendar.events.readonly: View events + https://www.googleapis.com/auth/calendar.events.readonly: + View events on all your calendars - https://www.googleapis.com/auth/calendar.readonly: See and download any + https://www.googleapis.com/auth/calendar.readonly: + See and download any calendar you can access using your Google Calendar - https://www.googleapis.com/auth/calendar.settings.readonly: View your + https://www.googleapis.com/auth/calendar.settings.readonly: + View your Calendar settings type: oauth2 Oauth2c: @@ -3676,15 +3923,20 @@ components: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: - https://www.googleapis.com/auth/calendar: See, edit, share, and permanently + https://www.googleapis.com/auth/calendar: + See, edit, share, and permanently delete all the calendars you can access using Google Calendar - https://www.googleapis.com/auth/calendar.events: View and edit events + https://www.googleapis.com/auth/calendar.events: + View and edit events on all your calendars - https://www.googleapis.com/auth/calendar.events.readonly: View events + https://www.googleapis.com/auth/calendar.events.readonly: + View events on all your calendars - https://www.googleapis.com/auth/calendar.readonly: See and download any + https://www.googleapis.com/auth/calendar.readonly: + See and download any calendar you can access using your Google Calendar - https://www.googleapis.com/auth/calendar.settings.readonly: View your + https://www.googleapis.com/auth/calendar.settings.readonly: + View your Calendar settings tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2